IRTCProfile2::Realm
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method sets or gets the realm value for the profile.
Syntax
HRESULT put_Realm(
BSTR bstrRealm
);
HRESULT get_Realm(
BSTR* pbstrRealm
);
Parameters
- bstrRealm, pbstrRealm
[in, out] Realm set on this profile. On output, this parameter is a pointer to a BSTR that will be filled with the realm, or an empty string if there is no entry. The method is responsible for allocating the buffer. The caller is responsible for releasing this memory with SysFreeString.
Return Value
This method can return an RTC_E_ constant. The following table shows additional return values and additional information about a specific return value.
| Value | Meaning |
|---|---|
E_OUTOFMEMORY |
Insufficient memory to perform this operation. |
E_POINTER |
The pbstrRealm parameter is not a valid pointer. |
RTC_E_INVALID_REGISTRATION_STATE |
The profile is in the RTCRS_REGISTERED, RTCRS_UNREGISTERING, or RTCRS_REGISTERING state. In these states, the value previously set for the realm is being used and it cannot be changed. |
RTC_E_NOT_EXIST |
The realm is not present in the profile. |
Remarks
If Realm is set with a different realm than the user is logged onto or searching under, the user receives an RTCE_REGISTRATION_STATE_CHANGE_EVENT or RTCE_USERSEARCH event with the status code RTC_E_SIP_AUTH_TYPE_NOT_SUPPORTED.
If no realm has been previously set with the Realm method, the profile object uses the realm provided in the first authentication challenge.
If the challenge does not contain a realm value and the user has not set a realm on the profile using this method, Realm returns an RTC_E_NOT_EXIST error.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |