IMSCSAuthManager::GetProperty
.gif "Ee823637.c++_off(en-US,CS.10).gif")
.gif "Ee823637.vb_on(en-US,CS.10).gif")
Use this method to retrieve the value of the specified custom property from the current user ticket.
Definition
HRESULT IMSCSAuthManager::GetProperty(EnumMSCS_TicketTypeenumTicketType,BSTRpropName,VARIANT*pVarCustomPropVal);
Parameters
enumTicketType
[in] An EnumMSCS_TicketType that indicates the type of ticket that contains the property.
propName
[in] A BSTR that contains the name of the property to retrieve.
PVarCustomPropVal
[out, retval] A pointer to a VARIANT containing a BSTR with the value for the specified property in the current user ticket. If the property is not found, 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_AUTHID_INVALID_PROPERTY | 0xC1004C27 | Invalid custom property name or value. |
| E_UPM_AUTHMANAGER_API_ASP_ONLY | 0xC1004C24 | This method should only be called within an ASP page. |
| E_UPM_AUTHMANAGER_TICKET_NOT_SET | 0xC1004C25 | Requested ticket not set. |
| MSG_UPM_AUTH_PROPNOTFOUND_ERROR | 0xC1004C00 | Requested property does not exist on the ticket. |
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. |
Use the SetProperty method to place custom property values in the current user ticket.
The pVarCustomPropVal 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.