_SiteConfig::GetAppsInSite Method [C++]

  • Article

Use this method to get a list of Commerce Server 2002 applications for the specified site.

Definition

[C++]

HRESULT _SiteConfig::GetAppsInSite(BSTR*strSiteName,
  VARIANT*vtAppNames);

[Visual Basic]

Function GetAppsInSite(strSiteName As String) As Variant

Parameters

  • strSiteName[C++]
    [in] A pointer to the BSTR that contains the name of the site for which you want the list of Commerce Server 2002 applications that are currently running.
  • strSiteName[Visual Basic]
    A String that contains the name of the site for which you want the list of running Commerce Server 2002 applications.
  • vtAppNames[C++]
    [out, retval] A pointer to a Variant used to return the list of Commerce Server 2002 applications.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns a Variant that contains the list of Commerce Server 2002 applications.

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

All ADO, SQL, and ODBC errors will also be returned by this method.

Remarks

The Initialize method must be called before this method can be used.

[C++] The vtAppNames parameter points to valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' sMySiteName is a string
' vVariant is a Variant
' oSiteConfig is a Commerce SiteConfig object
vVariant = oSiteConfig.GetAppsInSite(sMySiteName)

See Also

[C++]SiteConfig Object

[Visual Basic]SiteConfig Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.