IMSCSAuthManager2::SetUserID Method [C++]

Article
11/12/2009

Use this method to change the user ID property on a ticket.

Definition

[C++]

HRESULT IMSCSAuthManager::SetUserID(EnumMSCS_TicketTypeenumTicketType,
  BSTRnewUserID);

[Visual Basic]

Sub SetUserID(enumTicketType As EnumMSCS_TicketType,
  newUserID As String)

Parameters

enumTicketType[C++]
[in] An EnumMSCS_TicketType that indicates the type of ticket that will contain the user ID.
enumTicketType[Visual Basic]
An EnumMSCS_TicketType that indicates the type of ticket that will contain the user ID.
newUserID[C++]
[in] A BSTR that contains the unique ID for the current user.
newUserID[Visual Basic]
A String that contains the unique ID for the current user.

[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.
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

The value for the user ID may be the logon name for a registered user, a globally unique identifier (GUID) for an anonymous user, or any unique value.

If the ticket does not exist, a ticket is created with default values for the rest of the data. If the appropriate ticket already exists, the value in the user ID is updated.

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.

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