IRTCBuddy2::Refresh (Windows Embedded CE 6.0)

1/6/2010

This method refreshes the presence subscription for this buddy.

Syntax

HRESULT Refresh();

Parameters

None.

Return Value

This method can return an RTC_E_ constant. The following table shows additional possible return values.

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::StatusText method to retrieve the presence status.

The RTC API caches the presence state of a polled buddy for two minutes. As a result, if the application calls Refresh twice within two minutes, the same presence state is returned to the application.

Requirements

See Also

Reference

IRTCBuddy2
IRTCBuddyEvent2::StatusText
RTC_BUDDY_EVENT_TYPE
RTC_BUDDY_SUBSCRIPTION_TYPE