IDirectPlay8Peer::GetPlayerContext

Retrieves the player context value for the specified peer.

HRESULT GetPlayerContext(
const DPNID dpnid,
PVOID *const ppvPlayerContext,
const DWORD dwFlags
);

Parameters

dpnid

[in] Variable of type DPNID that specifies the identifier of the player to get context data for.

ppvPlayerContext

[out] Pointer to the context data of the peer.

dwFlags

[in] Reserved. Must be 0.

Return Values

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

Remarks

Player context values are set by pointing the pvPlayerContext member of the DPN_MSGID_CREATE_PLAYER system message to the context value data.

Requirements

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