IDirectPlay8Peer::CreateGroup Method

Creates a group in the current session. A group is a logical collection of players.

Syntax

HRESULT CreateGroup(      
    const DPN_GROUP_INFO *const pdpnGroupInfo,
    VOID *const pvGroupContext,
    VOID *const pvAsyncContext,
    DPNHANDLE *const phAsyncHandle,
    const DWORD dwFlags
);

Parameters

pdpnGroupInfo

[in] Pointer to a DPN_GROUP_INFO structure that contains the group description.

pvGroupContext

[in] Pointer to the group's context value. This value is preset when the local application's message handler receives the associated DPN_MSGID_CREATE_GROUP message. This parameter is optional and may be set to NULL.

pvAsyncContext

[in] 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

[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.

DPNCREATEGROUP_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 the following error value.

DPNERR_INVALIDFLAGS

The flags passed to this method are invalid.

Remarks

DirectPlay does not maintain hierarchical groups because these can easily be implemented with flat groups and expeditious use of the group data.

All peers receive a DPN_MSGID_CREATE_GROUP message when this method is called.

Note  Multicasting is not supported for this release.