IRTCBuddy2::Refresh
The Refresh method refreshes the presence subscription for this buddy.
HRESULT Refresh();
Parameters
This method has no parameters.
Return Values
RTC methods may return an RTC_E_ constant.
| Value | Meaning |
|---|---|
| E_FAIL | The session is in the disconnected state. |
| E_OUTOFMEMORY | Insufficient memory to perform this operation. |
Remarks
This method is called to update the presence subscription of the buddy. When the buddy is of type RTCBT_POLL, this method must be called to obtain the current presence status of the buddy. The application receives an RTCBET_BUDDY_STATE_CHANGE notification whenever this method is called. The presence status can be obtained by calling the IRTCBuddyEvent2::get_StatusText property to retrieve the presence status.
The RTC API caches the presence state of a polled buddy for 2 minutes. As a result, if the application calls Refresh twice within 2 minutes, the same presence state will be returned to the application.
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_IRTCBuddy2 is defined as 102F9588-23E7-40e3-954D-CD7A1D5C0361.