Share via


CatalogSets.GetCatalogsForUser

Ee824248.c++_on(en-US,CS.10).gifEe824248.vb_off(en-US,CS.10).gif

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

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

Parameters

objProfileService

A profile service object.

user_id

A String that contains the user ID.

defaultCatalogSetID

A String that contains the default catalog set ID.

Return Values

If this method completes successfully, it returns a Recordset object that contains the list of catalogs.

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

Example

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

See Also

CatalogSets Object


All rights reserved.