| Microsoft DirectX 9.0 SDK Update (Summer 2003) |
Sets a block of data associated with a group, including the name of the group.
Calling this method generates a DPN_MSGID_GROUP_INFO message, which is sent to all the peers connected to the application.
Syntax
HRESULT SetGroupInfo(
const DPNID dpnid, DPN_GROUP_INFO *const pdpnGroupInfo, PVOID const pvAsyncContext, DPNHANDLE *const phAsyncHandle, const DWORD dwFlags );
Parameters
- dpnid
- [in] Variable of type DPNID that specifies the identifier of the group whose data block will be modified.
- pdpnGroupInfo
- [in] Pointer to a DPN_GROUP_INFO structure that describes the group data to set. To change the values of the pwszName or pvData members, you must set the corresponding DPNINFO_NAME or DPNINFO_DATA flags in the dwInfoFlags member.
- pvAsyncContext
- [in] Pointer to the user-supplied context, which is returned in the pvUserContext member of the DPN_MSGID_ASYNC_OP_COMPLETE system message.
- phAsyncHandle
- [out] A DPNHANDLE. A value will be returned. However, Microsoft® DirectPlay® does not permit cancellation of this operation, so the value cannot be used.
- dwFlags
- [in] Flag that controls how this method is processed. The following flag can be set for this method:
- DPNSETGROUPINFO_SYNC
- Causes the method to process synchronously.
Return Value
Returns S_OK if this method is processed synchronously and is successful. By default, this method is run asynchronously and normally returns DPNSUCCESS_PENDING. It can also return one of the following error values.
DPNERR_INVALIDFLAGS The flags passed to this method are invalid. DPNERR_INVALIDGROUP The group ID is not recognized as a valid group ID for this game session.
Remarks
Transmission of nonstatic information should be handled with the IDirectPlay8Peer::SendTo method because of the high cost of using the IDirectPlay8Peer::SetGroupInfo method.