home *** CD-ROM | disk | FTP | other *** search
/ Microsoft DirectX SDK 6.1 / Dx6_1_Gold.iso / dxf / include / dplobby.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-06-10  |  27.2 KB  |  774 lines
  1. /*==========================================================================;
  2.  *
  3.  *  Copyright (C) 1996-1997 Microsoft Corporation.  All Rights Reserved.
  4.  *
  5.  *  File:       dplobby.h
  6.  *  Content:    DirectPlayLobby include file
  7.  ***************************************************************************/
  8. #ifndef __DPLOBBY_INCLUDED__
  9. #define __DPLOBBY_INCLUDED__
  10.  
  11. #include "dplay.h"
  12.  
  13. #ifdef __cplusplus
  14. extern "C" {
  15. #endif /* __cplusplus */
  16.  
  17. /*
  18.  * GUIDS used by DirectPlay objects
  19.  */
  20.  
  21. /* {AF465C71-9588-11cf-A020-00AA006157AC} */
  22. DEFINE_GUID(IID_IDirectPlayLobby, 0xaf465c71, 0x9588, 0x11cf, 0xa0, 0x20, 0x0, 0xaa, 0x0, 0x61, 0x57, 0xac);
  23. /* {26C66A70-B367-11cf-A024-00AA006157AC} */
  24. DEFINE_GUID(IID_IDirectPlayLobbyA, 0x26c66a70, 0xb367, 0x11cf, 0xa0, 0x24, 0x0, 0xaa, 0x0, 0x61, 0x57, 0xac);
  25. /* {0194C220-A303-11d0-9C4F-00A0C905425E} */
  26. DEFINE_GUID(IID_IDirectPlayLobby2, 0x194c220, 0xa303, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  27. /* {1BB4AF80-A303-11d0-9C4F-00A0C905425E} */
  28. DEFINE_GUID(IID_IDirectPlayLobby2A, 0x1bb4af80, 0xa303, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  29. /* {2DB72490-652C-11d1-A7A8-0000F803ABFC} */
  30. DEFINE_GUID(IID_IDirectPlayLobby3, 0x2db72490, 0x652c, 0x11d1, 0xa7, 0xa8, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
  31. /* {2DB72491-652C-11d1-A7A8-0000F803ABFC} */
  32. DEFINE_GUID(IID_IDirectPlayLobby3A, 0x2db72491, 0x652c, 0x11d1, 0xa7, 0xa8, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
  33. /* {2FE8F810-B2A5-11d0-A787-0000F803ABFC} */
  34. DEFINE_GUID(CLSID_DirectPlayLobby, 0x2fe8f810, 0xb2a5, 0x11d0, 0xa7, 0x87, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
  35.  
  36.  
  37. /****************************************************************************
  38.  *
  39.  * IDirectPlayLobby Structures
  40.  *
  41.  * Various structures used to invoke DirectPlayLobby.
  42.  *
  43.  ****************************************************************************/
  44.  
  45. typedef struct IDirectPlayLobby     FAR *LPDIRECTPLAYLOBBY;
  46. typedef struct IDirectPlayLobby     FAR *LPDIRECTPLAYLOBBYA;
  47. typedef struct IDirectPlayLobby     IDirectPlayLobbyA;
  48.  
  49. typedef struct IDirectPlayLobby2    FAR *LPDIRECTPLAYLOBBY2;
  50. typedef struct IDirectPlayLobby2    FAR *LPDIRECTPLAYLOBBY2A;
  51. typedef struct IDirectPlayLobby2    IDirectPlayLobby2A;
  52.  
  53. typedef struct IDirectPlayLobby3    FAR *LPDIRECTPLAYLOBBY3;
  54. typedef struct IDirectPlayLobby3    FAR *LPDIRECTPLAYLOBBY3A;
  55. typedef struct IDirectPlayLobby3    IDirectPlayLobby3A;
  56.  
  57.  
  58. /*
  59.  * DPLAPPINFO
  60.  * Used to hold information about a registered DirectPlay
  61.  * application
  62.  */
  63. typedef struct DPLAPPINFO
  64. {
  65.     DWORD       dwSize;             // Size of this structure
  66.     GUID        guidApplication;    // GUID of the Application
  67.     union
  68.     {
  69.         LPSTR   lpszAppNameA;       // Pointer to the Application Name
  70.         LPWSTR  lpszAppName;
  71.     };
  72.  
  73. } DPLAPPINFO, FAR *LPDPLAPPINFO;
  74.  
  75. /*
  76.  * LPCDPLAPPINFO
  77.  * A constant pointer to DPLAPPINFO
  78.  */
  79. typedef const DPLAPPINFO FAR *LPCDPLAPPINFO;
  80.  
  81. /*
  82.  * DPCOMPOUNDADDRESSELEMENT
  83.  *
  84.  * An array of these is passed to CreateCompoundAddresses()
  85.  */
  86. typedef struct DPCOMPOUNDADDRESSELEMENT
  87. {
  88.     GUID                guidDataType;
  89.     DWORD               dwDataSize;
  90.     LPVOID                lpData;
  91. } DPCOMPOUNDADDRESSELEMENT, FAR *LPDPCOMPOUNDADDRESSELEMENT;
  92.  
  93. /*
  94.  * LPCDPCOMPOUNDADDRESSELEMENT
  95.  * A constant pointer to DPCOMPOUNDADDRESSELEMENT
  96.  */
  97. typedef const DPCOMPOUNDADDRESSELEMENT FAR *LPCDPCOMPOUNDADDRESSELEMENT;
  98.  
  99. /*
  100.  * LPDPAPPLICATIONDESC
  101.  * Used to register a DirectPlay application
  102.  */
  103. typedef struct DPAPPLICATIONDESC
  104. {
  105.     DWORD       dwSize;
  106.     DWORD       dwFlags;
  107.     union
  108.     {
  109.         LPSTR       lpszApplicationNameA;
  110.         LPWSTR      lpszApplicationName;
  111.     };
  112.     GUID        guidApplication;
  113.     union
  114.     {
  115.         LPSTR       lpszFilenameA;
  116.         LPWSTR      lpszFilename;
  117.     };
  118.     union
  119.     {
  120.         LPSTR       lpszCommandLineA;
  121.         LPWSTR      lpszCommandLine;
  122.     };
  123.     union
  124.     {
  125.         LPSTR       lpszPathA;
  126.         LPWSTR      lpszPath;
  127.     };
  128.     union
  129.     {
  130.         LPSTR       lpszCurrentDirectoryA;
  131.         LPWSTR      lpszCurrentDirectory;
  132.     };
  133.     LPSTR       lpszDescriptionA;
  134.     LPWSTR      lpszDescriptionW;
  135. } DPAPPLICATIONDESC, *LPDPAPPLICATIONDESC;
  136.  
  137.  
  138. /****************************************************************************
  139.  *
  140.  * Enumeration Method Callback Prototypes
  141.  *
  142.  ****************************************************************************/
  143.  
  144. /*
  145.  * Callback for EnumAddress()
  146.  */
  147. typedef BOOL (FAR PASCAL *LPDPENUMADDRESSCALLBACK)(
  148.     REFGUID         guidDataType,
  149.     DWORD           dwDataSize,
  150.     LPCVOID         lpData,
  151.     LPVOID          lpContext);
  152.  
  153. /*
  154.  * Callback for EnumAddressTypes()
  155.  */
  156. typedef BOOL (FAR PASCAL *LPDPLENUMADDRESSTYPESCALLBACK)(
  157.     REFGUID         guidDataType,
  158.     LPVOID          lpContext,
  159.     DWORD           dwFlags);
  160.  
  161. /*
  162.  * Callback for EnumLocalApplications()
  163.  */
  164. typedef BOOL (FAR PASCAL * LPDPLENUMLOCALAPPLICATIONSCALLBACK)(
  165.     LPCDPLAPPINFO   lpAppInfo,
  166.     LPVOID          lpContext,
  167.     DWORD           dwFlags);
  168.  
  169.  
  170. /****************************************************************************
  171.  *
  172.  * DirectPlayLobby API Prototypes
  173.  *
  174.  ****************************************************************************/
  175. #ifdef UNICODE
  176. #define DirectPlayLobbyCreate   DirectPlayLobbyCreateW
  177. #else
  178. #define DirectPlayLobbyCreate   DirectPlayLobbyCreateA
  179. #endif /* UNICODE */
  180.  
  181. extern HRESULT WINAPI DirectPlayLobbyCreateW(LPGUID, LPDIRECTPLAYLOBBY *, IUnknown *, LPVOID, DWORD );
  182. extern HRESULT WINAPI DirectPlayLobbyCreateA(LPGUID, LPDIRECTPLAYLOBBYA *, IUnknown *, LPVOID, DWORD );
  183.  
  184.  
  185. /****************************************************************************
  186.  *
  187.  * IDirectPlayLobby (and IDirectPlayLobbyA) Interface
  188.  *
  189.  ****************************************************************************/
  190. #undef INTERFACE
  191. #define INTERFACE IDirectPlayLobby
  192. DECLARE_INTERFACE_( IDirectPlayLobby, IUnknown )
  193. {
  194.     /*  IUnknown Methods    */
  195.     STDMETHOD(QueryInterface)       (THIS_ REFIID riid, LPVOID * ppvObj) PURE;
  196.     STDMETHOD_(ULONG,AddRef)        (THIS) PURE;
  197.     STDMETHOD_(ULONG,Release)       (THIS) PURE;
  198.  
  199.     /*  IDirectPlayLobby Methods    */
  200.     STDMETHOD(Connect)              (THIS_ DWORD, LPDIRECTPLAY2 *, IUnknown FAR *) PURE;
  201.     STDMETHOD(CreateAddress)        (THIS_ REFGUID, REFGUID, LPCVOID, DWORD, LPVOID, LPDWORD) PURE;
  202.     STDMETHOD(EnumAddress)          (THIS_ LPDPENUMADDRESSCALLBACK, LPCVOID, DWORD, LPVOID) PURE;
  203.     STDMETHOD(EnumAddressTypes)     (THIS_ LPDPLENUMADDRESSTYPESCALLBACK, REFGUID, LPVOID, DWORD) PURE;
  204.     STDMETHOD(EnumLocalApplications)(THIS_ LPDPLENUMLOCALAPPLICATIONSCALLBACK, LPVOID, DWORD) PURE;
  205.     STDMETHOD(GetConnectionSettings)(THIS_ DWORD, LPVOID, LPDWORD) PURE;
  206.     STDMETHOD(ReceiveLobbyMessage)  (THIS_ DWORD, DWORD, LPDWORD, LPVOID, LPDWORD) PURE;
  207.     STDMETHOD(RunApplication)       (THIS_ DWORD, LPDWORD, LPDPLCONNECTION, HANDLE) PURE;
  208.     STDMETHOD(SendLobbyMessage)     (THIS_ DWORD, DWORD, LPVOID, DWORD) PURE;
  209.     STDMETHOD(SetConnectionSettings)(THIS_ DWORD, DWORD, LPDPLCONNECTION) PURE;
  210.     STDMETHOD(SetLobbyMessageEvent) (THIS_ DWORD, DWORD, HANDLE) PURE;
  211.  
  212. };
  213.  
  214. /****************************************************************************
  215.  *
  216.  * IDirectPlayLobby2 (and IDirectPlayLobby2A) Interface
  217.  *
  218.  ****************************************************************************/
  219. #undef INTERFACE
  220. #define INTERFACE IDirectPlayLobby2
  221. DECLARE_INTERFACE_( IDirectPlayLobby2, IDirectPlayLobby )
  222. {
  223.     /*  IUnknown Methods    */
  224.     STDMETHOD(QueryInterface)       (THIS_ REFIID riid, LPVOID * ppvObj) PURE;
  225.     STDMETHOD_(ULONG,AddRef)        (THIS) PURE;
  226.     STDMETHOD_(ULONG,Release)       (THIS) PURE;
  227.  
  228.     /*  IDirectPlayLobby Methods    */
  229.     STDMETHOD(Connect)              (THIS_ DWORD, LPDIRECTPLAY2 *, IUnknown FAR *) PURE;
  230.     STDMETHOD(CreateAddress)        (THIS_ REFGUID, REFGUID, LPCVOID, DWORD, LPVOID, LPDWORD) PURE;
  231.     STDMETHOD(EnumAddress)          (THIS_ LPDPENUMADDRESSCALLBACK, LPCVOID, DWORD, LPVOID) PURE;
  232.     STDMETHOD(EnumAddressTypes)     (THIS_ LPDPLENUMADDRESSTYPESCALLBACK, REFGUID, LPVOID, DWORD) PURE;
  233.     STDMETHOD(EnumLocalApplications)(THIS_ LPDPLENUMLOCALAPPLICATIONSCALLBACK, LPVOID, DWORD) PURE;
  234.     STDMETHOD(GetConnectionSettings)(THIS_ DWORD, LPVOID, LPDWORD) PURE;
  235.     STDMETHOD(ReceiveLobbyMessage)  (THIS_ DWORD, DWORD, LPDWORD, LPVOID, LPDWORD) PURE;
  236.     STDMETHOD(RunApplication)       (THIS_ DWORD, LPDWORD, LPDPLCONNECTION, HANDLE) PURE;
  237.     STDMETHOD(SendLobbyMessage)     (THIS_ DWORD, DWORD, LPVOID, DWORD) PURE;
  238.     STDMETHOD(SetConnectionSettings)(THIS_ DWORD, DWORD, LPDPLCONNECTION) PURE;
  239.     STDMETHOD(SetLobbyMessageEvent) (THIS_ DWORD, DWORD, HANDLE) PURE;
  240.  
  241.     /*  IDirectPlayLobby2 Methods    */
  242.     STDMETHOD(CreateCompoundAddress)(THIS_ LPCDPCOMPOUNDADDRESSELEMENT,DWORD,LPVOID,LPDWORD) PURE;
  243. };
  244.  
  245. /****************************************************************************
  246.  *
  247.  * IDirectPlayLobby3 (and IDirectPlayLobby3A) Interface
  248.  *
  249.  ****************************************************************************/
  250. #undef INTERFACE
  251. #define INTERFACE IDirectPlayLobby3
  252. DECLARE_INTERFACE_( IDirectPlayLobby3, IDirectPlayLobby )
  253. {
  254.     /*  IUnknown Methods    */
  255.     STDMETHOD(QueryInterface)       (THIS_ REFIID riid, LPVOID * ppvObj) PURE;
  256.     STDMETHOD_(ULONG,AddRef)        (THIS) PURE;
  257.     STDMETHOD_(ULONG,Release)       (THIS) PURE;
  258.  
  259.     /*  IDirectPlayLobby Methods    */
  260.     STDMETHOD(Connect)              (THIS_ DWORD, LPDIRECTPLAY2 *, IUnknown FAR *) PURE;
  261.     STDMETHOD(CreateAddress)        (THIS_ REFGUID, REFGUID, LPCVOID, DWORD, LPVOID, LPDWORD) PURE;
  262.     STDMETHOD(EnumAddress)          (THIS_ LPDPENUMADDRESSCALLBACK, LPCVOID, DWORD, LPVOID) PURE;
  263.     STDMETHOD(EnumAddressTypes)     (THIS_ LPDPLENUMADDRESSTYPESCALLBACK, REFGUID, LPVOID, DWORD) PURE;
  264.     STDMETHOD(EnumLocalApplications)(THIS_ LPDPLENUMLOCALAPPLICATIONSCALLBACK, LPVOID, DWORD) PURE;
  265.     STDMETHOD(GetConnectionSettings)(THIS_ DWORD, LPVOID, LPDWORD) PURE;
  266.     STDMETHOD(ReceiveLobbyMessage)  (THIS_ DWORD, DWORD, LPDWORD, LPVOID, LPDWORD) PURE;
  267.     STDMETHOD(RunApplication)       (THIS_ DWORD, LPDWORD, LPDPLCONNECTION, HANDLE) PURE;
  268.     STDMETHOD(SendLobbyMessage)     (THIS_ DWORD, DWORD, LPVOID, DWORD) PURE;
  269.     STDMETHOD(SetConnectionSettings)(THIS_ DWORD, DWORD, LPDPLCONNECTION) PURE;
  270.     STDMETHOD(SetLobbyMessageEvent) (THIS_ DWORD, DWORD, HANDLE) PURE;
  271.  
  272.     /*  IDirectPlayLobby2 Methods    */
  273.     STDMETHOD(CreateCompoundAddress)(THIS_ LPCDPCOMPOUNDADDRESSELEMENT,DWORD,LPVOID,LPDWORD) PURE;
  274.  
  275.     /*  IDirectPlayLobby3 Methods    */
  276.     STDMETHOD(ConnectEx)            (THIS_ DWORD, REFIID, LPVOID *, IUnknown FAR *) PURE;
  277.     STDMETHOD(RegisterApplication)  (THIS_ DWORD, LPDPAPPLICATIONDESC) PURE;
  278.     STDMETHOD(UnregisterApplication)(THIS_ DWORD, REFGUID) PURE;
  279.     STDMETHOD(WaitForConnectionSettings)(THIS_ DWORD) PURE;
  280. };
  281.  
  282. /****************************************************************************
  283.  *
  284.  * IDirectPlayLobby interface macros
  285.  *
  286.  ****************************************************************************/
  287.  
  288. #if !defined(__cplusplus) || defined(CINTERFACE)
  289.  
  290. #define IDirectPlayLobby_QueryInterface(p,a,b)              (p)->lpVtbl->QueryInterface(p,a,b)
  291. #define IDirectPlayLobby_AddRef(p)                          (p)->lpVtbl->AddRef(p)
  292. #define IDirectPlayLobby_Release(p)                         (p)->lpVtbl->Release(p)
  293. #define IDirectPlayLobby_Connect(p,a,b,c)                   (p)->lpVtbl->Connect(p,a,b,c)
  294. #define IDirectPlayLobby_ConnectEx(p,a,b,c,d)               (p)->lpVtbl->ConnectEx(p,a,b,c,d)
  295. #define IDirectPlayLobby_CreateAddress(p,a,b,c,d,e,f)       (p)->lpVtbl->CreateAddress(p,a,b,c,d,e,f)
  296. #define IDirectPlayLobby_CreateCompoundAddress(p,a,b,c,d)   (p)->lpVtbl->CreateCompoundAddress(p,a,b,c,d)
  297. #define IDirectPlayLobby_EnumAddress(p,a,b,c,d)             (p)->lpVtbl->EnumAddress(p,a,b,c,d)
  298. #define IDirectPlayLobby_EnumAddressTypes(p,a,b,c,d)        (p)->lpVtbl->EnumAddressTypes(p,a,b,c,d)
  299. #define IDirectPlayLobby_EnumLocalApplications(p,a,b,c)     (p)->lpVtbl->EnumLocalApplications(p,a,b,c)
  300. #define IDirectPlayLobby_GetConnectionSettings(p,a,b,c)     (p)->lpVtbl->GetConnectionSettings(p,a,b,c)
  301. #define IDirectPlayLobby_ReceiveLobbyMessage(p,a,b,c,d,e)   (p)->lpVtbl->ReceiveLobbyMessage(p,a,b,c,d,e)
  302. #define IDirectPlayLobby_RegisterApplication(p,a,b)         (p)->lpVtbl->RegisterApplication(p,a,b)
  303. #define IDirectPlayLobby_RunApplication(p,a,b,c,d)          (p)->lpVtbl->RunApplication(p,a,b,c,d)
  304. #define IDirectPlayLobby_SendLobbyMessage(p,a,b,c,d)        (p)->lpVtbl->SendLobbyMessage(p,a,b,c,d)
  305. #define IDirectPlayLobby_SetConnectionSettings(p,a,b,c)        (p)->lpVtbl->SetConnectionSettings(p,a,b,c)
  306. #define IDirectPlayLobby_SetLobbyMessageEvent(p,a,b,c)        (p)->lpVtbl->SetLobbyMessageEvent(p,a,b,c)
  307. #define IDirectPlayLobby_UnregisterApplication(p,a,b)       (p)->lpVtbl->UnregisterApplication(p,a,b)
  308. #define IDirectPlayLobby_WaitForConnectionSettings(p,a)     (p)->lpVtbl->WaitForConnectionSettings(p,a)
  309.  
  310. #else /* C++ */
  311.  
  312. #define IDirectPlayLobby_QueryInterface(p,a,b)              (p)->QueryInterface(a,b)
  313. #define IDirectPlayLobby_AddRef(p)                          (p)->AddRef()
  314. #define IDirectPlayLobby_Release(p)                         (p)->Release()
  315. #define IDirectPlayLobby_Connect(p,a,b,c)                   (p)->Connect(a,b,c)
  316. #define IDirectPlayLobby_ConnectEx(p,a,b,c,d)               (p)->ConnectEx(a,b,c,d)
  317. #define IDirectPlayLobby_CreateAddress(p,a,b,c,d,e,f)       (p)->CreateAddress(a,b,c,d,e,f)
  318. #define IDirectPlayLobby_CreateCompoundAddress(p,a,b,c,d)   (p)->CreateCompoundAddress(a,b,c,d)
  319. #define IDirectPlayLobby_EnumAddress(p,a,b,c,d)             (p)->EnumAddress(a,b,c,d)
  320. #define IDirectPlayLobby_EnumAddressTypes(p,a,b,c,d)        (p)->EnumAddressTypes(a,b,c,d)
  321. #define IDirectPlayLobby_EnumLocalApplications(p,a,b,c)     (p)->EnumLocalApplications(a,b,c)
  322. #define IDirectPlayLobby_GetConnectionSettings(p,a,b,c)     (p)->GetConnectionSettings(a,b,c)
  323. #define IDirectPlayLobby_ReceiveLobbyMessage(p,a,b,c,d,e)   (p)->ReceiveLobbyMessage(a,b,c,d,e)
  324. #define IDirectPlayLobby_RegisterApplication(p,a,b)         (p)->RegisterApplication(a,b)
  325. #define IDirectPlayLobby_RunApplication(p,a,b,c,d)          (p)->RunApplication(a,b,c,d)
  326. #define IDirectPlayLobby_SendLobbyMessage(p,a,b,c,d)        (p)->SendLobbyMessage(a,b,c,d)
  327. #define IDirectPlayLobby_SetConnectionSettings(p,a,b,c)        (p)->SetConnectionSettings(a,b,c)
  328. #define IDirectPlayLobby_SetLobbyMessageEvent(p,a,b,c)        (p)->SetLobbyMessageEvent(a,b,c)
  329. #define IDirectPlayLobby_UnregisterApplication(p,a,b)       (p)->UnregisterApplication(a,b)
  330. #define IDirectPlayLobby_WaitForConnectionSettings(p,a)     (p)->WaitForConnectionSettings(a)
  331.  
  332. #endif
  333.  
  334. /****************************************************************************
  335.  *
  336.  * DirectPlayLobby Flags
  337.  *
  338.  ****************************************************************************/
  339.  
  340. /*
  341.  *    This flag is used by IDirectPlayLobby->WaitForConnectionSettings to
  342.  *    cancel a current wait that is in progress.
  343.  */
  344. #define DPLWAIT_CANCEL                  0x00000001
  345.  
  346.  
  347. /*
  348.  *    This is a message flag used by ReceiveLobbyMessage.  It can be
  349.  *    returned in the dwMessageFlags parameter to indicate a message from
  350.  *    the system.
  351.  */
  352. #define DPLMSG_SYSTEM                    0x00000001
  353.  
  354. /*
  355.  *    This is a message flag used by ReceiveLobbyMessage and SendLobbyMessage.
  356.  *  It is used to indicate that the message is a standard lobby message.
  357.  *  DPLMSG_SETPROPERTY, DPLMSG_SETPROPERTYRESPONSE, DPLMSG_GETPROPERTY,
  358.  *    DPLMSG_GETPROPERTYRESPONSE
  359.  */
  360. #define DPLMSG_STANDARD                    0x00000002
  361.  
  362.  
  363. /****************************************************************************
  364.  *
  365.  * DirectPlayLobby messages and message data structures
  366.  *
  367.  * All system messages have a dwMessageFlags value of DPLMSG_SYSTEM returned
  368.  * from a call to ReceiveLobbyMessage.
  369.  *
  370.  * All standard messages have a dwMessageFlags value of DPLMSG_STANDARD returned
  371.  * from a call to ReceiveLobbyMessage.
  372.  *
  373.  ****************************************************************************/
  374.  
  375. /*
  376.  * DPLMSG_GENERIC
  377.  * Generic message structure used to identify the message type.
  378.  */
  379. typedef struct _DPLMSG_GENERIC
  380. {
  381.     DWORD       dwType;         // Message type
  382. } DPLMSG_GENERIC, FAR *LPDPLMSG_GENERIC;
  383.  
  384. /*
  385.  * DPLMSG_SYSTEMMESSAGE
  386.  * Generic message format for all system messages --
  387.  * DPLSYS_CONNECTIONSETTINGSREAD, DPLSYS_DPLYCONNECTSUCCEEDED,
  388.  * DPLSYS_DPLAYCONNECTFAILED, DPLSYS_APPTERMINATED, DPLSYS_NEWCONNECTIONSETTINGS
  389.  */
  390. typedef struct _DPLMSG_SYSTEMMESSAGE
  391. {
  392.     DWORD       dwType;         // Message type
  393.     GUID        guidInstance;   // Instance GUID of the dplay session the message corresponds to
  394. } DPLMSG_SYSTEMMESSAGE, FAR *LPDPLMSG_SYSTEMMESSAGE;
  395.  
  396. /*
  397.  *  DPLMSG_SETPROPERTY
  398.  *  Standard message sent by an application to a lobby to set a
  399.  *  property
  400.  */
  401. typedef struct _DPLMSG_SETPROPERTY
  402. {
  403.     DWORD    dwType;                // Message type
  404.     DWORD    dwRequestID;        // Request ID (DPL_NOCONFIRMATION if no confirmation desired)
  405.     GUID    guidPlayer;            // Player GUID
  406.     GUID    guidPropertyTag;    // Property GUID
  407.     DWORD    dwDataSize;            // Size of data
  408.     DWORD    dwPropertyData[1];    // Buffer containing data
  409. } DPLMSG_SETPROPERTY, FAR *LPDPLMSG_SETPROPERTY;
  410.  
  411. #define    DPL_NOCONFIRMATION            0
  412.  
  413. /*
  414.  *  DPLMSG_SETPROPERTYRESPONSE
  415.  *  Standard message returned by a lobby to confirm a 
  416.  *  DPLMSG_SETPROPERTY message.
  417.  */
  418. typedef struct _DPLMSG_SETPROPERTYRESPONSE
  419. {
  420.     DWORD    dwType;                // Message type
  421.     DWORD    dwRequestID;        // Request ID
  422.     GUID    guidPlayer;            // Player GUID
  423.     GUID    guidPropertyTag;    // Property GUID
  424.     HRESULT    hr;                    // Return Code
  425. } DPLMSG_SETPROPERTYRESPONSE, FAR *LPDPLMSG_SETPROPERTYRESPONSE;
  426.  
  427. /*
  428.  *  DPLMSG_GETPROPERTY
  429.  *  Standard message sent by an application to a lobby to request
  430.  *    the current value of a property
  431.  */
  432. typedef struct _DPLMSG_GETPROPERTY
  433. {
  434.     DWORD    dwType;                // Message type
  435.     DWORD    dwRequestID;        // Request ID
  436.     GUID    guidPlayer;            // Player GUID
  437.     GUID    guidPropertyTag;    // Property GUID
  438. } DPLMSG_GETPROPERTY, FAR *LPDPLMSG_GETPROPERTY;
  439.  
  440. /*
  441.  *  DPLMSG_GETPROPERTYRESPONSE
  442.  *  Standard message returned by a lobby in response to a
  443.  *    DPLMSG_GETPROPERTY message.
  444.  */
  445. typedef struct _DPLMSG_GETPROPERTYRESPONSE
  446. {
  447.     DWORD    dwType;                // Message type
  448.     DWORD    dwRequestID;        // Request ID
  449.     GUID    guidPlayer;            // Player GUID
  450.     GUID    guidPropertyTag;    // Property GUID
  451.     HRESULT    hr;                    // Return Code
  452.     DWORD    dwDataSize;            // Size of data
  453.     DWORD    dwPropertyData[1];    // Buffer containing data
  454. } DPLMSG_GETPROPERTYRESPONSE, FAR *LPDPLMSG_GETPROPERTYRESPONSE;
  455.  
  456. /*
  457.  *  DPLMSG_NEWSESSIONHOST
  458.  *  Standard message returned by a lobby in response to a
  459.  *    the session host migrating to a new client
  460.  */
  461. typedef struct _DPLMSG_NEWSESSIONHOST
  462. {
  463.     DWORD   dwType;             // Message type
  464.     GUID    guidInstance;       // GUID Instance of the session
  465. } DPLMSG_NEWSESSIONHOST, FAR *LPDPLMSG_NEWSESSIONHOST;
  466.  
  467.  
  468. /******************************************
  469.  *
  470.  *    DirectPlay Lobby message dwType values
  471.  *
  472.  *****************************************/
  473.  
  474. /*
  475.  *  The application has read the connection settings.
  476.  *  It is now O.K. for the lobby client to release
  477.  *  its IDirectPlayLobby interface.
  478.  */
  479. #define DPLSYS_CONNECTIONSETTINGSREAD   0x00000001
  480.  
  481. /*
  482.  *  The application's call to DirectPlayConnect failed
  483.  */
  484. #define DPLSYS_DPLAYCONNECTFAILED       0x00000002
  485.  
  486. /*
  487.  *  The application has created a DirectPlay session.
  488.  */
  489. #define DPLSYS_DPLAYCONNECTSUCCEEDED    0x00000003
  490.  
  491. /*
  492.  *  The application has terminated.
  493.  */
  494. #define DPLSYS_APPTERMINATED            0x00000004
  495.  
  496. /*
  497.  *  The message is a DPLMSG_SETPROPERTY message.
  498.  */
  499. #define DPLSYS_SETPROPERTY                0x00000005
  500.  
  501. /*
  502.  *  The message is a DPLMSG_SETPROPERTYRESPONSE message.
  503.  */
  504. #define DPLSYS_SETPROPERTYRESPONSE        0x00000006
  505.  
  506. /*
  507.  *  The message is a DPLMSG_GETPROPERTY message.
  508.  */
  509. #define DPLSYS_GETPROPERTY                0x00000007
  510.  
  511. /*
  512.  *  The message is a DPLMSG_GETPROPERTYRESPONSE message.
  513.  */
  514. #define DPLSYS_GETPROPERTYRESPONSE        0x00000008
  515.  
  516. /*
  517.  *  The message is a DPLMSG_NEWSESSIONHOST message.
  518.  */
  519. #define DPLSYS_NEWSESSIONHOST           0x00000009
  520.  
  521. /*
  522.  *  New connection settings are available.
  523.  */
  524. #define DPLSYS_NEWCONNECTIONSETTINGS    0x0000000A
  525.  
  526.  
  527. /****************************************************************************
  528.  *
  529.  * DirectPlay defined property GUIDs and associated data structures
  530.  *
  531.  ****************************************************************************/
  532.  
  533. /*
  534.  * DPLPROPERTY_MessagesSupported
  535.  *
  536.  * Request whether the lobby supports standard.  Lobby with respond with either
  537.  * TRUE or FALSE or may not respond at all.
  538.  * 
  539.  * Property data is a single BOOL with TRUE or FALSE
  540.  */
  541. // {762CCDA1-D916-11d0-BA39-00C04FD7ED67}
  542. DEFINE_GUID(DPLPROPERTY_MessagesSupported, 
  543. 0x762ccda1, 0xd916, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
  544.  
  545. /*
  546.  * DPLPROPERTY_LobbyGuid
  547.  *
  548.  * Request the GUID that identifies the lobby software that the application
  549.  * is communicating with.
  550.  *
  551.  * Property data is a single GUID.
  552.  */
  553. // {F56920A0-D218-11d0-BA39-00C04FD7ED67}
  554. DEFINE_GUID(DPLPROPERTY_LobbyGuid, 
  555. 0xf56920a0, 0xd218, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
  556.  
  557. /*
  558.  * DPLPROPERTY_PlayerGuid
  559.  *
  560.  * Request the GUID that identifies the player on this machine for sending
  561.  * property data back to the lobby.
  562.  *
  563.  * Property data is the DPLDATA_PLAYERDATA structure
  564.  */
  565. // {B4319322-D20D-11d0-BA39-00C04FD7ED67}
  566. DEFINE_GUID(DPLPROPERTY_PlayerGuid, 
  567. 0xb4319322, 0xd20d, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
  568.  
  569. /*
  570.  * DPLDATA_PLAYERGUID
  571.  *
  572.  * Data structure to hold the GUID of the player and player creation flags
  573.  * from the lobby.
  574.  */
  575. typedef struct _DPLDATA_PLAYERGUID
  576. {
  577.     GUID    guidPlayer;
  578.     DWORD    dwPlayerFlags;
  579. } DPLDATA_PLAYERGUID, FAR *LPDPLDATA_PLAYERGUID;
  580.  
  581. /*
  582.  * DPLPROPERTY_PlayerScore
  583.  *
  584.  * Used to send an array of long integers to the lobby indicating the 
  585.  * score of a player.
  586.  *
  587.  * Property data is the DPLDATA_PLAYERSCORE structure.
  588.  */
  589. // {48784000-D219-11d0-BA39-00C04FD7ED67}
  590. DEFINE_GUID(DPLPROPERTY_PlayerScore, 
  591. 0x48784000, 0xd219, 0x11d0, 0xba, 0x39, 0x0, 0xc0, 0x4f, 0xd7, 0xed, 0x67);
  592.  
  593. /*
  594.  * DPLDATA_PLAYERSCORE
  595.  *
  596.  * Data structure to hold an array of long integers representing a player score.
  597.  * Application must allocate enough memory to hold all the scores.
  598.  */
  599. typedef struct _DPLDATA_PLAYERSCORE
  600. {
  601.     DWORD    dwScoreCount;
  602.     LONG    Score[1];
  603. } DPLDATA_PLAYERSCORE, FAR *LPDPLDATA_PLAYERSCORE;
  604.  
  605. /****************************************************************************
  606.  *
  607.  * DirectPlay Address ID's
  608.  *
  609.  ****************************************************************************/
  610.  
  611. /* DirectPlay Address
  612.  *
  613.  * A DirectPlay address consists of multiple chunks of data, each tagged
  614.  * with a GUID signifying the type of data in the chunk. The chunk also
  615.  * has a length so that unknown chunk types can be skipped.
  616.  *
  617.  * The EnumAddress() function is used to parse these address data chunks.
  618.  */
  619.  
  620. /*
  621.  * DPADDRESS
  622.  *
  623.  * Header for block of address data elements
  624.  */
  625. typedef struct _DPADDRESS
  626. {
  627.     GUID                guidDataType;
  628.     DWORD               dwDataSize;
  629. } DPADDRESS;
  630.  
  631. typedef DPADDRESS FAR *LPDPADDRESS;
  632.  
  633. /*
  634.  * DPAID_TotalSize
  635.  *
  636.  * Chunk is a DWORD containing size of entire DPADDRESS structure
  637.  */
  638.  
  639. // {1318F560-912C-11d0-9DAA-00A0C90A43CB}
  640. DEFINE_GUID(DPAID_TotalSize, 
  641. 0x1318f560, 0x912c, 0x11d0, 0x9d, 0xaa, 0x0, 0xa0, 0xc9, 0xa, 0x43, 0xcb);
  642.  
  643. /*
  644.  * DPAID_ServiceProvider
  645.  *
  646.  * Chunk is a GUID describing the service provider that created the chunk.
  647.  * All addresses must contain this chunk.
  648.  */
  649.  
  650. // {07D916C0-E0AF-11cf-9C4E-00A0C905425E}
  651. DEFINE_GUID(DPAID_ServiceProvider, 
  652. 0x7d916c0, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  653.  
  654. /*
  655.  * DPAID_LobbyProvider
  656.  *
  657.  * Chunk is a GUID describing the lobby provider that created the chunk.
  658.  * All addresses must contain this chunk.
  659.  */
  660.  
  661. // {59B95640-9667-11d0-A77D-0000F803ABFC}
  662. DEFINE_GUID(DPAID_LobbyProvider, 
  663. 0x59b95640, 0x9667, 0x11d0, 0xa7, 0x7d, 0x0, 0x0, 0xf8, 0x3, 0xab, 0xfc);
  664.  
  665. /*
  666.  * DPAID_Phone and DPAID_PhoneW
  667.  *
  668.  * Chunk is a string containing a phone number (i.e. "1-800-555-1212")
  669.  * in ANSI or UNICODE format
  670.  */
  671.  
  672. // {78EC89A0-E0AF-11cf-9C4E-00A0C905425E}
  673. DEFINE_GUID(DPAID_Phone, 
  674. 0x78ec89a0, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  675.  
  676. // {BA5A7A70-9DBF-11d0-9CC1-00A0C905425E}
  677. DEFINE_GUID(DPAID_PhoneW, 
  678. 0xba5a7a70, 0x9dbf, 0x11d0, 0x9c, 0xc1, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  679.  
  680. /*
  681.  * DPAID_Modem and DPAID_ModemW
  682.  *
  683.  * Chunk is a string containing a modem name registered with TAPI
  684.  * in ANSI or UNICODE format
  685.  */
  686.  
  687. // {F6DCC200-A2FE-11d0-9C4F-00A0C905425E}
  688. DEFINE_GUID(DPAID_Modem, 
  689. 0xf6dcc200, 0xa2fe, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  690.  
  691. // {01FD92E0-A2FF-11d0-9C4F-00A0C905425E}
  692. DEFINE_GUID(DPAID_ModemW, 
  693. 0x1fd92e0, 0xa2ff, 0x11d0, 0x9c, 0x4f, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  694.  
  695. /*
  696.  * DPAID_Inet and DPAID_InetW
  697.  *
  698.  * Chunk is a string containing a TCP/IP host name or an IP address
  699.  * (i.e. "dplay.microsoft.com" or "137.55.100.173") in ANSI or UNICODE format
  700.  */
  701.  
  702. // {C4A54DA0-E0AF-11cf-9C4E-00A0C905425E}
  703. DEFINE_GUID(DPAID_INet, 
  704. 0xc4a54da0, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  705.  
  706. // {E63232A0-9DBF-11d0-9CC1-00A0C905425E}
  707. DEFINE_GUID(DPAID_INetW, 
  708. 0xe63232a0, 0x9dbf, 0x11d0, 0x9c, 0xc1, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  709.  
  710. /*
  711.  * DPAID_InetPort
  712.  *
  713.  * Chunk is the port number used for creating the apps TCP and UDP sockets.
  714.  * WORD value (i.e. 47624).
  715.  */
  716.  
  717. // {E4524541-8EA5-11d1-8A96-006097B01411}
  718. DEFINE_GUID(DPAID_INetPort, 
  719. 0xe4524541, 0x8ea5, 0x11d1, 0x8a, 0x96, 0x0, 0x60, 0x97, 0xb0, 0x14, 0x11);
  720.  
  721. #ifdef BIGMESSAGEDEFENSE
  722. #endif
  723.  
  724. /*
  725.  * DPCOMPORTADDRESS
  726.  *
  727.  * Used to specify com port settings. The constants that define baud rate,
  728.  * stop bits and parity are defined in WINBASE.H. The constants for flow
  729.  * control are given below.
  730.  */
  731.  
  732. #define DPCPA_NOFLOW        0           // no flow control
  733. #define DPCPA_XONXOFFFLOW   1           // software flow control
  734. #define DPCPA_RTSFLOW       2           // hardware flow control with RTS
  735. #define DPCPA_DTRFLOW       3           // hardware flow control with DTR
  736. #define DPCPA_RTSDTRFLOW    4           // hardware flow control with RTS and DTR
  737.  
  738. typedef struct _DPCOMPORTADDRESS
  739. {
  740.     DWORD   dwComPort;                  // COM port to use (1-4)
  741.     DWORD   dwBaudRate;                 // baud rate (100-256k)
  742.     DWORD   dwStopBits;                 // no. stop bits (1-2)
  743.     DWORD   dwParity;                   // parity (none, odd, even, mark)
  744.     DWORD   dwFlowControl;              // flow control (none, xon/xoff, rts, dtr)
  745. } DPCOMPORTADDRESS;
  746.  
  747. typedef DPCOMPORTADDRESS FAR *LPDPCOMPORTADDRESS;
  748.  
  749. /*
  750.  * DPAID_ComPort
  751.  *
  752.  * Chunk contains a DPCOMPORTADDRESS structure defining the serial port.
  753.  */
  754.  
  755. // {F2F0CE00-E0AF-11cf-9C4E-00A0C905425E}
  756. DEFINE_GUID(DPAID_ComPort, 
  757. 0xf2f0ce00, 0xe0af, 0x11cf, 0x9c, 0x4e, 0x0, 0xa0, 0xc9, 0x5, 0x42, 0x5e);
  758.  
  759. /****************************************************************************
  760.  *
  761.  *     dplobby 1.0 obsolete definitions
  762.  *    Included for compatibility only.
  763.  *
  764.  ****************************************************************************/
  765. #define DPLAD_SYSTEM          DPLMSG_SYSTEM
  766.  
  767.  
  768. #ifdef __cplusplus
  769. };
  770. #endif /* __cplusplus */
  771.  
  772. #endif /* __DPLOBBY_INCLUDED__ */
  773.  
  774.