Share via


AuthManager.GetUserID

Ee825031.c++_on(en-US,CS.10).gifEe825031.vb_off(en-US,CS.10).gif

Use this method to retrieve a user ID stored in a ticket.

Definition

Function GetUserID(enumTicketType As EnumMSCS_TicketType) As Variant

Parameters

enumTicketType

An EnumMSCS_TicketType that indicates the type of ticket that contains the user ID.

Return Values

If this method completes successfully, it returns a Variant that contains the user ID. If the appropriate ticket type is not found or there is no user ID, the method returns NULL.

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_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

The following table defines the possible values for the EnumMSCS_TicketType.

Name Value Description
enumMSCS_ProfileTicketType 1 A MSCSProfile ticket used for an anonymous user.
enumMSCS_AuthTicketType 2 A MSCSAuth ticket used for a registered user.

If the ticket type is a MSCSAuth ticket and the ticket has expired, the ticket will be deleted and the return value will be as if there was no ticket.

If the ticket type is a MSCSAuth ticket and the ticket is within five minutes of expiring, the last login time is refreshed to the current time, allowing an additional period for the ticket to be valid.

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

Example

' vUserID is a Variant
' oAuthManager is a Commerce AuthManager object

vUserID = oAuthManager.GetUserID(enumMSCS_ProfileTicketType)

See Also

AuthManager Object


All rights reserved.