Share via


CatalogSets.GetCatalogSetInfo

Ee824280.c++_on(en-US,CS.10).gifEe824280.vb_off(en-US,CS.10).gif

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

Definition

Function GetCatalogSetInfo(CatalogSetID As String) As Recordset

Parameters

CatalogSetID

A String that contains the catalog set ID, a GUID.

Return Values

If this method completes successfully, it returns a Recordset object.

Error Values

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

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.

Example

'
set rsMyCatalogSetInfo = myCatalogSets.GetCatalogSetInfo(strCatalogSetID)

See Also

CatalogSets Object


All rights reserved.