IRTCClientPresence2::get_Group

The get_Group property gets an IRTCBuddyGroup interface for a group whose name matches the name given as a parameter. The group must be present for the function to succeed.

HRESULT get_Group(BSTRbstrGroupName,
IRTCBuddyGroup**ppGroup);

Parameters

  • bstrGroupName
    [in] String containing the name of the group.
  • ppGroup
    [out] Returns a pointer to the IRTCBuddyGroup interface. This call also adds a reference to the interface, which the caller is responsible for releasing.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_NOT_EXIST The group 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 ppGroup 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::get_Groups