Microsoft DirectX 8.0 (C++)

IDirectPlay8Server::SetGroupInfo

Sets a block of data associated with a group, including the name of the group.

HRESULT SetGroupInfo(
const DPNID dpnid,
DPN_GROUP_INFO *const pdpnGroupInfo,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);

Parameters

dpnid
Variable of type DPNID that specifies the identifier of the group whose data block will be modified.
pdpnGroupInfo
Pointer to a DPN_GROUP_INFO structure that describes the group data to set. To change the values of the pwszName or pvData members of this structure, you must set the corresponding DPNINFO_NAME OR DPNINFO_DATA flag in the dwInfoFlags member.
pvAsyncContext
Pointer to the user-supplied context, which is returned in the pvUserContext member of the DPN_MSGID_ASYNC_OP_COMPLETE system message.
phAsyncHandle
A DPNHANDLE. A value will be returned. However, Microsoft® DirectPlay® 8.0 does not permit cancellation of this operation, so the value cannot be used.
dwFlags
Flag that controls how this method is processed. The following flag can be set for this method.
DPNSETGROUPINFO_SYNC
Causes this method to process synchronously.

Return Values

Returns S_OK if this method is processed synchronously and is successful. By default, this method is run asynchronously and generally returns DPNSUCCESS_PENDING or one of the following error values.

DPNERR_INVALIDFLAGS
DPNERR_INVALIDGROUP

Requirements

  Windows NT/2000: Available as a redistributable for Windows 2000 and later.
  Windows 95/98: Available as a redistributable for Windows 95 and later.
  Header: Declared in Dplay8.h.