IMSCSStandardSManager_3_0::GetShopperId Method [C++]

Article
11/12/2009

Use this method to retrieve the shopper ID for the current user. The shopper ID is returned from a URL query string or a cookie, depending on the initialization mode of the StandardSManager object for the site.

Definition

[C++]

HRESULT IMSCSStandardSManager_3_0::GetShopperId(IDispatch*pdispContext,
 VARIANT*pvtRet);

[Visual Basic]

Function GetShopperId(pdispContext As Object) As Variant

Parameters

pdispContext[C++]
[in] A pointer to the IDispatch interface that contains the ASP scripting context.
pdispContext[Visual Basic]
An object reference that holds the ASP scripting context.
pvtRet[C++]
[out, retval] A pointer to a VARIANT used to return the shopper ID.

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 Variant that specifies the shopper ID.

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 pvtRet parameter points to valid data only if the method completes successfully.

If no shopper ID is found, the GetShopperID method returns an empty string.

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

Share via