_GlobalConfig2::GetRefSites Method [C++]

Article
11/12/2009

Use this method to retrieve a list of all the site names that reference the given resource from the Administration database.

Definition

[C++]

HRESULT _GlobalConfig2::GetRefSites(BSTRstrDisplayName,
_Recordset** retVal);

[Visual Basic]

Function GetRefSites(strDisplayName As String,
) As Object

Parameters

strDisplayName[C++]
[in] A BSTR that contains the display name of the global resource.
strDisplayName[Visual Basic]
A String that contains the display name of the global resource.
retVal[C++]
[out, retval] The address of a pointer to a _Recordset object. Each Field object in the recordset includes the name of one of the sites that references the given resource.

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 Recordset object. Each Field object in the recordset includes the name of one of the sites that references the given resource.

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 normal SQL errors are returned by this method via the Err object. If no sites reference the given resource, S_OK is returned, but the returned list will be empty.

Remarks

[C++] The retVal parameter contains 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.