AuthManager.SetProfileTicket

Ee825181.c++_on(en-US,CS.10).gifEe825181.vb_off(en-US,CS.10).gif

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

Definition

Sub SetProfileTicket(UserID As String,fCookieSupport As Boolean)

Parameters

UserID

[in] A String that contains the unique ID for the current user.

fCookieSupport

[in] A Boolean that indicates whether persistent cookies are supported.

Error Values

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 &HC1004C23 Invalid character (';' or '%' or '=') present in the UserID or the property name/value pair.
E_UPM_AUTHMANAGER_API_ASP_ONLY &HC1004C24 This method should only be called within an ASP page.
MSG_UPM_AUTH_SITE_NEEDED_ERROR &HC1004C10 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. In particular, the Description property may contain a text description of the error.

Remarks

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

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

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

Example

' oAuthManager is a Commerce AuthManager object

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

See Also

AuthManager Object

AuthManager.IsAuthenticated


All rights reserved.