_SiteConfig::AddRefToGroupComponent Method [C++]

Article
11/12/2009

Use this method to add a reference to a global resource so that a site can access that resource. If you use this method to create a global resource, in order to read the correct property values, use the SiteConfigReadOnly object methods. To set the correct property values, use the GlobalConfig object on the global resource that is referenced by this site level resource.

Definition

[C++]

HRESULT _SiteConfig::AddRefToGroupComponent(BSTRbstrSiteResourceName,
  BSTRbstrGroupResourceName);

[Visual Basic]

Sub AddRefToGroupComponent(
  bstrSiteResourceName As String,
  bstrGroupResourceName As String)

Parameters

bstrSiteResourceName[C++]
[in] A BSTR that contains the name of the resource configuration object to be added to the site.
bstrSiteResourceName[Visual Basic]
A String that contains the name of the resource configuration object to be added to the site.
bstrGroupResourceName[C++]
[in] A BSTR that contains the name of the global resource configuration object to which a reference is being added.
bstrGroupResourceName[Visual Basic]
A String that contains the name of the global resource configuration object to which a reference is being added.

Return Values

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

[Visual Basic] None.

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.

If you use this method to create a global resource, use the SiteConfigReadOnly object methods to read the correct property values. Use the GlobalConfig object on the global resource that is referenced by this site level resource to set the correct property values.

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

[Visual Basic]

Example

' sSiteResName and sGlob are strings
' oSiteConfig is a Commerce SiteConfig object
oSiteConfig.AddRefToGroupComponent(sSiteResName,sGlob)

Share via