IMSCSAuthManager::SetProperty
.gif "Ee823753.c++_off(en-US,CS.10).gif")
.gif "Ee823753.vb_on(en-US,CS.10).gif")
Use this method to place a custom property name/value pair into the current ticket for the user.
Definition
HRESULT IMSCSAuthManager::SetProperty(EnumMSCS_TicketTypeenumTicketType,BSTRpropName,BSTRpropVal);
Parameters
enumTicketType
[in] An EnumMSCS_TicketType that indicates the type of ticket.
propName
[in] A BSTR that contains the name of the property.
propVal
[in] A BSTR that contains the value corresponding to the named property.
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_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. |
| 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
Use the GetProperty method to retrieve the custom property values from the current ticket.
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. |
.gif "Ee823753.note(en-US,CS.10).gif")
Note
- A property with the name "Ticket" is used by the AuthManager object for storing Commerce Server 2000 related information. When creating a custom property, do not set the property name to "Ticket".
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.