IDirectPlay4::GetSessionDesc

The IDirectPlay4::GetSessionDesc method retrieves the properties of the current open session.

HRESULT GetSessionDesc(
  LPVOID lpData,
  LPDWORD lpdwDataSize
);

Parameters

lpData

Pointer to a buffer where the session description data is to be written. Set this parameter to NULL to request only the size of data. The lpdwDataSize parameter will be set to the size required to hold the data.

lpdwDataSize

Pointer to a variable that is initialized to the size of the buffer before calling this method. After the method returns, this parameter will be set to the size, in bytes, of the session data. If the buffer was too small (DPERR_BUFFERTOOSMALL), then this parameter will be set to the buffer size required. If this parameter is NULL, the method returns DPERR_INVALIDPARAM.

Return Values

Returns DP_OK if successful, or one of the following error values otherwise:

Remarks

After this method returns, the pointer lpData should be cast to the DPSESSIONDESC2 structure to read the session description data.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dplay.h.
  Import Library: Use dplayx.lib.

See Also

DPSESSIONDESC2, IDirectPlay4::EnumSessions, IDirectPlay4::Open