IDirectPlay4::GetSessionDesc
IDirectPlay4 Interface
Retrieves the properties of the current open session.
Syntax
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 Value
Returns DP_OK if successful, or one of the following error values otherwise:
DPERR_BUFFERTOOSMALL DPERR_INVALIDOBJECT DPERR_INVALIDPARAMS DPERR_NOCONNECTION
Remarks
After this method returns, the pointer lpData should be cast to the DPSESSIONDESC2 structure to read the session description data.
See Also
DPSESSIONDESC2, IDirectPlay4::EnumSessions, IDirectPlay4::Open
Top of Page
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.