_CatalogSets::GetCatalogSetInfo
.gif "Ee785543.c++_off(en-US,CS.10).gif")
.gif "Ee785543.vb_on(en-US,CS.10).gif")
Use this method to return the basic properties for a catalog set.
Definition
HRESULT _CatalogSets::GetCatalogSetInfo(BSTRCatalogSetID,_Recordset**unnamed parameter);
Parameters
CatalogSetID
[in] A BSTR that contains the catalog set ID, a GUID.
unnamed parameter
[out, retval] A pointer to hold the reference to the returned _Recordset object, which will contain the unnamed parameter.
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
Error Values
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.
Remarks
The unnamedparameter 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.