IMSCSAuthManager::SetAuthTicket
.gif "Ee810469.c++_off(en-US,CS.10).gif")
.gif "Ee810469.vb_on(en-US,CS.10).gif")
Use this method to set an encrypted MSCSAuth ticket for a registered user.
Definition
HRESULT IMSCSAuthManager::SetAuthTicket(BSTRUserID,VARIANT_BOOLfCookieSupport,longTimeWindow);
Parameters
UserID
[in] A BSTR that contains the unique ID for the current user.
fCookieSupport
[in] A VARIANT_BOOL that indicates whether session cookies are supported.
TimeWindow
[in] A long that defines the time window in minutes that the MSCSAuth ticket is valid.
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_AUTHID_INVALID_CHARACTER_PRESENT | 0xC1004C23 | Invalid character (';' or '%' or '=') present in the UserID or the property name/value pair. |
| 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 time the user last logged in is stored in the ticket, along with the length of time from the last login that the ticket is valid.
If an MSCSAuth ticket for the user already exists and an empty string is passed in as the ID, UserID, for the user, the existing ticket is deleted.
If the current user is anonymous, use the SetProfileTicket method to generate an MSCSProfile ticket.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.