IRTCProfile2::put_Realm
The put_Realm method sets the realm value for the profile.
HRESULT put_Realm(BSTRbstrRealm);
Parameters
- bstrRealm
[in] String containing the realm value. The caller is responsible for freeing this memory with SysFreeString.
Return Values
RTC methods may return an RTC_E_ constant.
| Value | Meaning |
|---|---|
| RTC_E_INVALID_PROFILE | The profile is not valid. |
| 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. |
| E_OUTOFMEMORY | Insufficient memory to perform this operation. |
Remarks
If put_Realm is called 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 put_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 put_Realm, IRTCProfile2::get_Realm returns an RTC_E_NOT_EXIST error.
Requirements
Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCProfile2 is defined as 4B81F84E-BDC7-4184-9154-3CB2DD7917FB.