EnumSessionsCallback2
Application-defined callback function for the IDirectPlay4::EnumSessions method.
Syntax
BOOL FAR PASCAL EnumSessionsCallback2(
LPCDPSESSIONDESC2 lpThisSD,
LPDWORD lpdwTimeOut,
DWORD dwFlags,
LPVOID lpContext
);
Parameters
- lpThisSD
- Pointer to a DPSESSIONDESC2 structure describing the enumerated session. This parameter will be set to NULL if the enumeration has timed out.
- lpdwTimeOut
- Pointer to a variable containing the current time-out value. This parameter can be reset when the DPESC_TIMEDOUT flag is returned if you want to wait longer for sessions to reply.
- dwFlags
- Typically, this flag is set to zero.
- DPESC_TIMEDOUT
- The enumeration has timed out. Reset lpdwTimeOut and return TRUE to continue, or FALSE to stop the enumeration.
- lpContext
- Pointer to an application-defined context.
Return Value
Returns TRUE to continue the enumeration or FALSE to stop it.
Remarks
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.
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.
Top of Page
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.