_CatalogSets::GetCatalogsForUser Method [C++]

  • Article

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

[C++]

HRESULT _CatalogSets::GetCatalogsForUser(IDispatch*objProfileService,
  BSTRuser_id,
  BSTRdefaultCatalogSetID,
  _Recordset**retVal);

[Visual Basic]

Function GetCatalogsForUser(objProfileService As IDispatch,
  user_id As String,
  defaultCatalogSetID As String) As Recordset

Parameters

  • objProfileService[C++]
    [in] A pointer to the IDispatch interface to the profile service.
  • objProfileService[Visual Basic]
    A profile service object.
  • user_id[C++]
    [in] A BSTR that contains the user ID.
  • user_id[Visual Basic]
    A String that contains the user ID.
  • defaultCatalogSetID[C++]
    [in] A BSTR that contains the default catalog set ID.
  • defaultCatalogSetID[Visual Basic]
    A String that contains the default catalog set ID.
  • 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 that contains the list of catalogs.

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 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.

[Visual Basic]

Example

Set objProfileService = Server.CreateObject("Commerce.ProfileService")
Call objProfileService.Initialize(sProfileServiceConnectionString, _
   "Profile Definitions")
set rsCatalogSet = myCatalogSets.GetCatalogsForUser(objProfileService, _
   user_id, defaultCatalogSetID)

See Also

[C++]CatalogSets Object

[Visual Basic]CatalogSets Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.