IMSCSAuthManager::GetUserID
.gif "Ee798274.c++_off(en-US,CS.10).gif")
.gif "Ee798274.vb_on(en-US,CS.10).gif")
Use this method to retrieve a user ID stored in a ticket.
Definition
HRESULT IMSCSAuthManager::GetUserID(EnumMSCS_TicketTypeenumTicketType,VARIANT*pUserID);
Parameters
enumTicketType
[in] An EnumMSCS_TicketType that indicates the type of ticket that contains the user ID.
pUserID
[out, retval] A pointer to a VARIANT containing a BSTR used to return the unique ID for the current user. If the appropriate ticket type is not found or there is no user ID, the pointer is set to NULL.
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 errors that this method can return.
| Constant | Value | Description |
| E_UPM_AUTHMANAGER_API_ASP_ONLY | 0xC1004C24 | This method should only be called within an ASP page. |
| 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 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.
The pUserID parameter contains valid data only if the method completes successfully.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.