IMSCSAuthManager2::SetProfileTicket Method [C++]

Article
11/12/2009

Use this method to set a MSCSProfile ticket for an anonymous user. An anonymous user is not registered with a site.

Definition

[C++]

HRESULT IMSCSAuthManager::SetProfileTicket(BSTRUserID,
  VARIANT_BOOLfCookieSupport);

[Visual Basic]

Sub SetProfileTicket(UserID As String,
  fCookieSupport As Boolean)

Parameters

UserID[C++]
[in] A BSTR that contains the unique ID for the current user.
UserID[Visual Basic]
[in] A String that contains the unique ID for the current user.
fCookieSupport[C++]
[in] A VARIANT_BOOL that indicates whether persistent cookies are supported.
fCookieSupport[Visual Basic]
[in] A Boolean that indicates whether persistent cookies are supported.

[C++]

Return Values

This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

Error Values

[C++] 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.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

Constant	Value	Description
E_UPM_AUTHID_INVALID_CHARACTER_PRESENT	[C++] 0xC1004C23 [Visual Basic] &HC1004C23	Invalid character (';' or '%' or '=') present in the user ID or the property name/value pair.
E_UPM_AUTHMANAGER_API_ASP_ONLY	[C++] 0xC1004C24 [Visual Basic] &HC1004C24	This method should only be called within an ASP page.
MSG_UPM_AUTH_SITE_NEEDED_ERROR	[C++] 0xC1004C10 [Visual Basic] &HC1004C10	The Initialize method must be called with the installed site name before calling this method.
MSG_UPM_AUTHID_TICKET_MAX_REACHED	[C++] 0xC1004C40 [Visual Basic] &HC1004C40	The ticket has reached a maximum size of 4 Kilobytes of data.

[C++] 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] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

If the current user has registered, use the SetAuthTicket method to generate an MSCSAuth ticket.

Ee799064.caution(en-US,CS.20).gif Caution

If an MSCSProfile ticket for the user already exists and an empty string is passed in for the user ID, the existing ticket is deleted.

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

[Visual Basic]

Example

' oAuthManager is a Commerce AuthManager object

oAuthManager.SetProfileTicket "74A38551-D6D8-FFD0-12BF-0A20C90DC8D1", True

Share via