_CatalogSets::GetCatalogsForUser
Use this method to return the list of catalogs that have been assigned to a particular user through the catalog set specified in their profile.
Definition
HRESULT _CatalogSets::GetCatalogsForUser(IDispatch*objProfileService,BSTRuser_id,BSTRdefaultCatalogSetID,_Recordset**unnamed parameter);
Parameters
objProfileService
[in] A pointer to the IDispatch interface to the profile service.
user_id
[in] A BSTR that contains the user ID.
defaultCatalogSetID
[in] A BSTR that contains the default catalog set ID.
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 unnamed parameter contains valid data only if the method completes successfully.
This method returns a Recordset object with a row for each catalog in the catalog set associated with the user profile in the user_id parameter and the following fields:
Field | Type | Description |
CatalogName From the CatalogSet_Catalogs table. |
String maximum of 255 characters |
None |
CatalogName From the CatalogGlobal table. |
String maximum of 128 characters |
None |
If the user profile object passed to this method has not been initialized, the object will return the default catalog set.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.