Microsoft DirectX 9.0

IDirectPlay8Server::GetGroupContext Method

Retrieves the group context value for a group.


HRESULT GetGroupContext(      

    const DPNID dpnid,     PVOID *const ppvGroupContext,     const DWORD dwFlags );


[in] Variable of type DPNID that specifies the identifier of the group to get context data for.
[out] Pointer to the context value of the group.
[in] Reserved. Must be 0.

Return Value

Returns S_OK if successful, or one of the following error values.

DPNERR_INVALIDGROUPThe group ID is not recognized as a valid group ID for this game session.
DPNERR_INVALIDPARAMOne or more of the parameters passed to the method are invalid.
DPNERR_NOTREADYThe object is not ready for use.


Group context values are set by pointing the pvGroupContext member of the DPN_MSGID_CREATE_GROUP system message to the context value data.

This method returns DPNERR_NOTREADY when it is called before a DPN_MSGID_CREATE_GROUP message is received by Microsoft?DirectPlay?for the group specified in dpnid. Call IDirectPlay8Server::GetGroupContext again allowing task switching so that the thread carrying the message can return.

© 2002 Microsoft Corporation. All rights reserved.