IRTCBuddyGroup::AddBuddy
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
Note
This method is unsupported in Windows Embedded CE 6.0.
This method adds an RTC buddy to the buddy group.
Syntax
HRESULT AddBuddy(
IRTCBuddy* pBuddy
);
Parameters
- pBuddy
[in] Pointer to the IRTCBuddy interface of the buddy to add.
Return Value
This method can return an RTC_E_ constant. The following table shows an additional possible return value.
| Value | Meaning |
|---|---|
E_POINTER |
The pBuddy parameter is not a valid pointer. |
Remarks
This method triggers the RTCE_GROUP event (defined in the RTC_EVENT enumeration), which returns an IRTCBuddyGroupEvent interface.
If contact roaming is enabled, the AddBuddy method becomes an asynchronous function. If the return value fails, the operation fails. If the return is successful, the application must wait for the RTCE_GROUP event of type RTCGET_GROUP_BUDDY_ADD (defined in the RTC_GROUP_EVENT_TYPE enumeration). The result code can be obtained from the IRTCBuddyGroupEvent::StatusCode method.
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |
See Also
Reference
IRTCBuddyGroup
IRTCBuddy
IRTCBuddyGroup::RemoveBuddy
IRTCBuddyGroupEvent
IRTCBuddyGroupEvent::StatusCode
RTC_EVENT
RTC_GROUP_EVENT_TYPE