_CatalogSets::GetCatalogSetIDForUser

Ee796609.c++_off(en-US,CS.10).gifEe796609.vb_on(en-US,CS.10).gif

Use this method to return the CatalogSetID for a specific user.

Definition

HRESULT _CatalogSets::GetCatalogSetIDForUser(IDispatch*objProfileService,BSTRuser_id,BSTRdefaultCatalogSetID,VARIANT*unnamed parameter);

Parameters

objProfileService

[in] A pointer to the IDispatch interface to the ProfileService object.

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 a VARIANT used to return the catalog set ID.

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.

If the user defined in the objProfileService parameter has a catalog set associated with it, this method returns that ID; if not, it returns the catalog set associated with the user organization. If this catalog set does not exist, it returns the value supplied in the defaultCatalogSetID parameter.

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

See Also

CatalogSets Object

ProfileService Object


All rights reserved.