Platform SDK: DirectX |
EnumSessionsCallback2 is an application-defined callback function for the IDirectPlay4::EnumSessions method.
BOOL FAR PASCAL EnumSessionsCallback2( LPCDPSESSIONDESC2 lpThisSD, LPDWORD lpdwTimeOut, DWORD dwFlags, LPVOID lpContext );
Returns TRUE to continue the enumeration or FALSE to stop it.
The application must implement this function in order to use the IDirectPlay4::EnumSessions method. This callback function will be called once for each session that is enumerated. Once all the session are enumerated, the callback function will be called one additional time with the DPESC_TIMEDOUT flag.
Applications should look at the flags of the DPSESSIONDESC2 to determine the nature of the session.
For a secure session, the dwMaxPlayers and dwCurrentPlayers members of DPSESSIONDESC2 are set to 0.
Any pointers returned in a callback function are temporary and are valid only in the body of the callback function. If the application needs to save pointer information, it must allocate memory to hold the data, copy the data, and then store the pointer to this new data. In this function, lpThisSD is temporary. Also note that the pointers inside the structure specified in the lpThisSD parameter—lpszSessionName / lpszSessionNameA and lpszPassword / lpszPasswordA—are also temporary.
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.