IMSCSAuthManager::GetUserIDFromCookie
Use this method to retrieve a user ID stored in a cookie.
Definition
HRESULT IMSCSAuthManager::GetUserIDFromCookie(BSTRcookieData,BSTR*pbstrUserID);
Parameters
cookieData
[in] A BSTR that contains the cookie.
pbstrUserID
[out, retval] A pointer to a BSTR used to return the user 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 either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
The following table shows the custom COM error that this method can return.
Constant | Value | Description |
MSG_UPM_AUTH_SITE_NEEDED_ERROR | 0xC1004C10 | The Initialize method must be called with the installed site name before calling this method. |
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 cookie data is always URL decoded.
Commerce Server 2000 Analysis applications use this method to extract user IDs from cookies found in Internet Information Services (IIS) logs.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
The pbstrUserID parameter contains valid data only if the method completes successfully.