IRTCClientPresence2::get_WatcherEx

  • Article

The get_WatcherEx property returns a watcher attached to the RTC client object, based on a supplied SIP URI.

HRESULT get_WatcherEx(RTC_WATCHER_MATCH_MODEenMode,
BSTRbstrPresentityURI,
IRTCWatcher2**ppWatcher);

Parameters

  • enMode
    [in] RTC_WATCHER_MATCH_MODE enumeration value describing the URI match level to use when searching for the Watcher.
  • bstrPresentityURI
    [in] String value containing the SIP URI. The prefix "sip:" is not necessary for matching.
  • ppWatcher
    [out] Pointer to an IRTCWatcher2 interface on the retrieved Watcher object. This parameter may be NULL, indicating that a matching Watcher could not be found. This call adds a reference to the watcher object, which the caller is responsible for releasing.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_NOT_EXIST The watcher does not exist.
RTC_E_CLIENT_NOT_INITIALIZED The client object is not initialized.
RTC_E_PRESENCE_NOT_ENABLED Presence has not been enabled.
E_POINTER The ppWatcher parameter is not a valid pointer.

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_IRTCClientPresence2 is defined as AD1809E8-62F7-4783-909A-29C9D2CB1D34.

See Also

IRTCClientPresence2, IRTCClientPresence, IRTCClientPresence2::AddWatcherEx, IRTCClientPresence::get_Watcher, IRTCClientPresence::get_Watchers