_CatalogSets::GetCatalogSetInfo Method [C++]

Article
11/12/2009

Use this method to return the basic properties for a catalog set.

Definition

[C++]

HRESULT _CatalogSets::GetCatalogSetInfo(BSTRCatalogSetID,
  _Recordset**retVal);

[Visual Basic]

Function GetCatalogSetInfo(CatalogSetID As String) As Recordset

Parameters

CatalogSetID[C++]
[in] A BSTR that contains the catalog set ID, a GUID.
CatalogSetID[Visual Basic]
A String that contains the catalog set ID, a GUID.
retVal[C++]
[out, retval] A pointer to hold the reference to the returned _Recordset object, which will contain the retVal parameter.

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.

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.

Remarks

[C++] The retVal parameter contains valid data only if the method completes successfully.

[Visual Basic] The Recordset object returned by this method contains valid data only if the method completes successfully.

This method returns a forward-only Recordset object with a single row and the following fields:

Field	Type	Description
CatalogSetID	GUID	None
CatalogSetName	String, maximum of 255 characters	None
CatalogSetDescription	String, maximum of 255 characters	None
bWildCard	Integer	A Boolean that indicates whether this catalog set automatically includes all catalogs, including any new catalogs that might be created in the future. A value of True indicates that this catalog set includes all existing catalogs. A value of False indicates that this catalog set only includes a specific set of catalogs.

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