IMSCSStandardSManager_3_0::GetShopperId

Ee796774.c++_off(en-US,CS.10).gifEe796774.vb_on(en-US,CS.10).gif

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

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

Parameters

pdispContext

[in] A pointer to the IDispatch interface that contains the ASP scripting context.

pvtRet

[out, retval] A pointer to a VARIANT used to return the shopper 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 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.

See Also

StandardSManager Object

IMSCSStandardSManager_3_0::get_Mode, put_Mode

IMSCSStandardSManager_3_0::PutShopperId


All rights reserved.