Microsoft DirectX 8.0 (C++)

IDirectPlay8Server::RemovePlayerFromGroup

Removes a client from a group.

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

Parameters

idGroup
Variable of type DPNID that specifies the identifier of the group to remove the client from.
idClient
Variable of type DPNID that specifies the identifier of the client to remove from the group.
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.
DPNREMOVEPLAYERFROMGROUP_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

Remarks

When this method is called, the server's message handler receives a DPN_MSGID_REMOVE_PLAYER_FROM_GROUP message.

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.