IRTCBuddyGroup::Name

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

Note

This method is unsupported in Windows Embedded CE 6.0.

This method sets or gets the name of the group.

Syntax

HRESULT put_Name( 
  BSTR bstrGroupName 
);
HRESULT get_Name( 
  BSTR* pbstrGroupName 
);

Parameters

• bstrGroupName, pbstrGroupName
  [in, out] Name of the group. On output, this parameter is a pointer to a BSTR that will be filled with the group name, or an empty string if there is no entry. The method allocates the buffer. The caller is responsible for releasing this memory with SysFreeString.

Return Value

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

Value	Meaning
E_OUTOFMEMORY	Insufficient memory to perform this operation.
E_POINTER	The bstrGroupName parameter is not a valid pointer.

Remarks

If contact roaming is enabled, the put_Name 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 (defined in the RTC_EVENT enumeration) of type RTCGET_GROUP_UPDATE (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
IRTCBuddyGroupEvent::StatusCode
RTC_EVENT
RTC_GROUP_EVENT_TYPE

Other Resources

SysFreeString