Microsoft DirectX 8.0 (C++)

IDirectPlay8Peer::DestroyGroup

Deletes a group created by the IDirectPlay8Peer::CreateGroup method. This method can be called by any peer in the session.

HRESULT DestroyGroup(
const DPNID idGroup,
PVOID const pvAsyncContext,
DPNHANDLE *const phAsyncHandle,
const DWORD dwFlags
);

Parameters

idGroup
Variable of type DPNID that should be set to the identifier of the group to be deleted.
pvAsyncContext
Pointer to the user-supplied context, which is returned in the pvUserContext member of the DPN_MSGID_ASYNC_OP_COMPLETE system message. This parameter is optional and may be set to NULL.
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.
DPNDESTROYGROUP_SYNC
Causes the 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 normally returns DPNSUCCESS_PENDING. It can also return 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.