IMSCSPage_3_0::GetShopperId
.gif "Ee783733.c++_off(en-US,CS.10).gif")
.gif "Ee783733.vb_on(en-US,CS.10).gif")
This method returns the unique 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 for the site.)
If the current customer does not have a shopper ID, GetShopperID returns NULL.
.gif "Ee783733.important(en-US,CS.10).gif")
Important
- This method is included for backwards compatibility with Site Server 3.0 Commerce Edition. See the AuthManager object, which provides similar functionality to that found in the GetShopperID method. Using the AuthManager methods is the preferred way of adding this type of functionality to your site, and will ensure better compatibility with future versions of Microsoft Commerce Server.
Definition
HRESULT IMSCSPage_3_0::GetShopperId(VARIANT*pvarShopperID);
Parameters
pvarShopperID
[out, retval] A pointer to a VARIANT used to return the shopper ID.
Return Values
This method returns an HRESULT indicating whether or not 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 pvarShopperID parameter points to valid data only if the method completed successfully.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.