include/ddeml.h

   1 /*
   2  * DDEML library definitions
   3  *
   4  * Copyright 1997 Alexandre Julliard
   5  * Copyright 1997 Len White
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #ifndef __WINE_DDEML_H
  23 #define __WINE_DDEML_H
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* defined(__cplusplus) */
  28
  29 #ifdef _USER32_
  30 #define WINUSERAPI
  31 #else
  32 #define WINUSERAPI DECLSPEC_IMPORT
  33 #endif
  34
  35 /* Codepage Constants
  36  */
  37
  38 #define CP_WINANSI      1004
  39 #define CP_WINUNICODE   1200
  40
  41 /* DDE synchronisation constants
  42  */
  43
  44 #define MSGF_DDEMGR 0x8001
  45
  46 #define QID_SYNC        0xFFFFFFFF
  47
  48 /*   Type variation for MS  deliberate departures from ANSI standards
  49  */
  50
  51 #define EXPENTRY CALLBACK
  52
  53 #define SZDDESYS_TOPIC          TEXT("System")
  54 #define SZDDESYS_ITEM_TOPICS    TEXT("Topics")
  55 #define SZDDESYS_ITEM_SYSITEMS  TEXT("SysItems")
  56 #define SZDDESYS_ITEM_RTNMSG    TEXT("ReturnMessage")
  57 #define SZDDESYS_ITEM_STATUS    TEXT("Status")
  58 #define SZDDESYS_ITEM_FORMATS   TEXT("Formats")
  59 #define SZDDESYS_ITEM_HELP      TEXT("Help")
  60 #define SZDDE_ITEM_ITEMLIST     TEXT("TopicItemList")
  61
  62 /***************************************************
  63
  64       FLAGS Section - copied from Microsoft SDK as must be standard, probably Copyright Microsoft Corporation
  65
  66 ***************************************************/
  67
  68 #define     XST_NULL              0
  69 #define     XST_INCOMPLETE        1
  70 #define     XST_CONNECTED         2
  71 #define     XST_INIT1             3
  72 #define     XST_INIT2             4
  73 #define     XST_REQSENT           5
  74 #define     XST_DATARCVD          6
  75 #define     XST_POKESENT          7
  76 #define     XST_POKEACKRCVD       8
  77 #define     XST_EXECSENT          9
  78 #define     XST_EXECACKRCVD      10
  79 #define     XST_ADVSENT          11
  80 #define     XST_UNADVSENT        12
  81 #define     XST_ADVACKRCVD       13
  82 #define     XST_UNADVACKRCVD     14
  83 #define     XST_ADVDATASENT      15
  84 #define     XST_ADVDATAACKRCVD   16
  85
  86 #define     ST_CONNECTED            0x0001
  87 #define     ST_ADVISE               0x0002
  88 #define     ST_ISLOCAL              0x0004
  89 #define     ST_BLOCKED              0x0008
  90 #define     ST_CLIENT               0x0010
  91 #define     ST_TERMINATED           0x0020
  92 #define     ST_INLIST               0x0040
  93 #define     ST_BLOCKNEXT            0x0080
  94 #define     ST_ISSELF               0x0100
  95
  96 /*
  97  * DdeEnableCallback function codes
  98  */
  99
 100 #define     EC_ENABLEALL                 0
 101 #define     EC_ENABLEONE                 ST_BLOCKNEXT
 102 #define     EC_DISABLE                   ST_BLOCKED
 103 #define     EC_QUERYWAITING              2
 104
 105 /*
 106  * Callback filter flags for use with standard apps.
 107  */
 108
 109 #define     CBF_FAIL_SELFCONNECTIONS     0x00001000
 110 #define     CBF_FAIL_CONNECTIONS         0x00002000
 111 #define     CBF_FAIL_ADVISES             0x00004000
 112 #define     CBF_FAIL_EXECUTES            0x00008000
 113 #define     CBF_FAIL_POKES               0x00010000
 114 #define     CBF_FAIL_REQUESTS            0x00020000
 115 #define     CBF_FAIL_ALLSVRXACTIONS      0x0003f000
 116
 117 #define     CBF_SKIP_CONNECT_CONFIRMS    0x00040000
 118 #define     CBF_SKIP_REGISTRATIONS       0x00080000
 119 #define     CBF_SKIP_UNREGISTRATIONS     0x00100000
 120 #define     CBF_SKIP_DISCONNECTS         0x00200000
 121 #define     CBF_SKIP_ALLNOTIFICATIONS    0x003c0000
 122
 123 #define     CBR_BLOCK                    ((HDDEDATA)~0UL)
 124
 125 /*
 126  * Application command flags
 127  */
 128 #define     APPCMD_CLIENTONLY            0x00000010L
 129 #define     APPCMD_FILTERINITS           0x00000020L
 130 #define     APPCMD_MASK                  0x00000FF0L
 131
 132 /*
 133  * Application classification flags
 134  */
 135
 136 #define     APPCLASS_STANDARD            0x00000000L
 137 #define     APPCLASS_MONITOR             0x00000001L
 138 #define     APPCLASS_MASK                0x0000000FL
 139
 140 /*
 141  * Callback filter flags for use with MONITOR apps - 0 implies no monitor
 142  * callbacks.
 143  */
 144 #define     MF_HSZ_INFO                  0x01000000
 145 #define     MF_SENDMSGS                  0x02000000
 146 #define     MF_POSTMSGS                  0x04000000
 147 #define     MF_CALLBACKS                 0x08000000
 148 #define     MF_ERRORS                    0x10000000
 149 #define     MF_LINKS                     0x20000000
 150 #define     MF_CONV                      0x40000000
 151
 152 #define     MF_MASK                      0xFF000000
 153
 154 /*
 155  *      DdeNameService service name flags
 156  */
 157
 158 #define     DNS_REGISTER                 0x0001
 159 #define     DNS_UNREGISTER               0x0002
 160 #define     DNS_FILTERON                 0x0004
 161 #define     DNS_FILTEROFF                0x0008
 162
 163
 164 /****************************************************
 165
 166       End of Flags section
 167
 168 ****************************************************/
 169
 170 /****************************************************
 171
 172         Message Types Section
 173
 174 ****************************************************/
 175
 176 #define XTYPF_NOBLOCK           0x0002          /* CBR_NOBLOCK will not work */
 177 #define XTYPF_NODATA            0x0004          /* DDE_FDEFERUPD  */
 178 #define XTYPF_ACKREQ            0x0008          /* DDE_FACKREQ */
 179
 180 #define XCLASS_MASK             0xFC00
 181 #define XCLASS_BOOL             0x1000
 182 #define XCLASS_DATA             0x2000
 183 #define XCLASS_FLAGS            0x4000
 184 #define XCLASS_NOTIFICATION     0x8000
 185
 186 #define XTYP_ERROR              (0x0000 | XCLASS_NOTIFICATION | XTYPF_NOBLOCK)
 187 #define XTYP_ADVDATA            (0x0010 | XCLASS_FLAGS)
 188 #define XTYP_ADVREQ             (0x0020 | XCLASS_DATA | XTYPF_NOBLOCK)
 189 #define XTYP_ADVSTART           (0x0030 | XCLASS_BOOL)
 190 #define XTYP_ADVSTOP            (0x0040 | XCLASS_NOTIFICATION)
 191 #define XTYP_EXECUTE            (0x0050 | XCLASS_FLAGS)
 192 #define XTYP_CONNECT            (0x0060 | XCLASS_BOOL | XTYPF_NOBLOCK)
 193 #define XTYP_CONNECT_CONFIRM    (0x0070 | XCLASS_NOTIFICATION | XTYPF_NOBLOCK)
 194 #define XTYP_XACT_COMPLETE      (0x0080 | XCLASS_NOTIFICATION )
 195 #define XTYP_POKE               (0x0090 | XCLASS_FLAGS)
 196 #define XTYP_REGISTER           (0x00A0 | XCLASS_NOTIFICATION | XTYPF_NOBLOCK )
 197 #define XTYP_REQUEST            (0x00B0 | XCLASS_DATA )
 198 #define XTYP_DISCONNECT         (0x00C0 | XCLASS_NOTIFICATION | XTYPF_NOBLOCK )
 199 #define XTYP_UNREGISTER         (0x00D0 | XCLASS_NOTIFICATION | XTYPF_NOBLOCK )
 200 #define XTYP_WILDCONNECT        (0x00E0 | XCLASS_DATA | XTYPF_NOBLOCK)
 201 #define XTYP_MONITOR            (0x00F0 | XCLASS_NOTIFICATION | XTYPF_NOBLOCK)
 202
 203 #define XTYP_MASK               0x00F0
 204 #define XTYP_SHIFT              4
 205
 206 #define TIMEOUT_ASYNC           0xFFFFFFFF
 207
 208 #define CADV_LATEACK            0xFFFF
 209
 210 /**************************************************
 211
 212         End of Message Types Section
 213
 214 ****************************************************/
 215
 216 /*****************************************************
 217
 218         DDE Codes for wStatus field
 219
 220 *****************************************************/
 221
 222 #define DDE_FACK                0x8000
 223 #define DDE_FBUSY               0x4000
 224 #define DDE_FDEFERUPD           0x4000
 225 #define DDE_FACKREQ             0x8000
 226 #define DDE_FRELEASE            0x2000
 227 #define DDE_FREQUESTED          0x1000
 228 #define DDE_FAPPSTATUS          0x00FF
 229 #define DDE_FNOTPROCESSED       0x0000
 230
 231 #define DDE_FACKRESERVED        (~(DDE_FACK | DDE_FBUSY | DDE_FAPPSTATUS))
 232 #define DDE_FADVRESERVED        (~(DDE_FACKREQ | DDE_FDEFERUPD))
 233 #define DDE_FDATRESERVED        (~(DDE_FACKREQ | DDE_FRELEASE | DDE_FREQUESTED))
 234 #define DDE_FPOKRESERVED        (~(DDE_FRELEASE))
 235
 236 /*****************************************************
 237
 238         End of wStatus codes
 239
 240 *****************************************************/
 241
 242 /****************************************************
 243
 244       Return Codes section again copied from SDK as must be same
 245
 246 *****************************************************/
 247
 248 #define     DMLERR_NO_ERROR                    0       /* must be 0 */
 249
 250 #define     DMLERR_FIRST                       0x4000
 251
 252 #define     DMLERR_ADVACKTIMEOUT               0x4000
 253 #define     DMLERR_BUSY                        0x4001
 254 #define     DMLERR_DATAACKTIMEOUT              0x4002
 255 #define     DMLERR_DLL_NOT_INITIALIZED         0x4003
 256 #define     DMLERR_DLL_USAGE                   0x4004
 257 #define     DMLERR_EXECACKTIMEOUT              0x4005
 258 #define     DMLERR_INVALIDPARAMETER            0x4006
 259 #define     DMLERR_LOW_MEMORY                  0x4007
 260 #define     DMLERR_MEMORY_ERROR                0x4008
 261 #define     DMLERR_NOTPROCESSED                0x4009
 262 #define     DMLERR_NO_CONV_ESTABLISHED         0x400a
 263 #define     DMLERR_POKEACKTIMEOUT              0x400b
 264 #define     DMLERR_POSTMSG_FAILED              0x400c
 265 #define     DMLERR_REENTRANCY                  0x400d
 266 #define     DMLERR_SERVER_DIED                 0x400e
 267 #define     DMLERR_SYS_ERROR                   0x400f
 268 #define     DMLERR_UNADVACKTIMEOUT             0x4010
 269 #define     DMLERR_UNFOUND_QUEUE_ID            0x4011
 270
 271 #define     DMLERR_LAST                        0x4011
 272
 273 #define     HDATA_APPOWNED                     0x0001
 274
 275 /*****************************************************
 276
 277       End of Return Codes and Microsoft section
 278
 279 ******************************************************/
 280
 281
 282
 283 DECLARE_HANDLE(HCONVLIST);
 284 DECLARE_HANDLE(HCONV);
 285 DECLARE_HANDLE(HSZ);
 286 DECLARE_HANDLE(HDDEDATA);
 287
 288
 289
 290 /*******************************************************
 291
 292         API Entry Points
 293
 294 *******************************************************/
 295
 296 typedef HDDEDATA (CALLBACK *PFNCALLBACK)(UINT, UINT, HCONV, HSZ, HSZ,
 297                                          HDDEDATA, ULONG_PTR, ULONG_PTR);
 298
 299 /***************************************************
 300
 301         Externally visible data structures
 302
 303 ***************************************************/
 304
 305 typedef struct tagHSZPAIR
 306 {
 307     HSZ hszSvc;
 308     HSZ hszTopic;
 309 } HSZPAIR, *PHSZPAIR;
 310
 311 typedef struct tagCONVCONTEXT
 312 {
 313     UINT  cb;
 314     UINT  wFlags;
 315     UINT  wCountryID;
 316     INT   iCodePage;
 317     DWORD dwLangID;
 318     DWORD dwSecurity;
 319     SECURITY_QUALITY_OF_SERVICE qos;
 320 } CONVCONTEXT, *PCONVCONTEXT;
 321
 322 typedef struct tagCONVINFO
 323 {
 324     DWORD               cb;
 325     DWORD_PTR           hUser;
 326     HCONV               hConvPartner;
 327     HSZ                 hszSvcPartner;
 328     HSZ                 hszServiceReq;
 329     HSZ                 hszTopic;
 330     HSZ                 hszItem;
 331     UINT                wFmt;
 332     UINT                wType;
 333     UINT                wStatus;
 334     UINT                wConvst;
 335     UINT                wLastError;
 336     HCONVLIST           hConvList;
 337     CONVCONTEXT         ConvCtxt;
 338     HWND                hwnd;
 339     HWND                hwndPartner;
 340 } CONVINFO, *PCONVINFO;
 341
 342 /*            Interface Definitions             */
 343
 344 WINUSERAPI BOOL      WINAPI DdeAbandonTransaction(DWORD idInst, HCONV hConv, DWORD idTransaction);
 345 WINUSERAPI LPBYTE    WINAPI DdeAccessData(HDDEDATA,LPDWORD);
 346 WINUSERAPI HDDEDATA  WINAPI DdeAddData(HDDEDATA,LPBYTE,DWORD,DWORD);
 347 WINUSERAPI HDDEDATA  WINAPI DdeClientTransaction(LPBYTE,DWORD,HCONV,HSZ,UINT,UINT,DWORD,LPDWORD);
 348 WINUSERAPI INT       WINAPI DdeCmpStringHandles(HSZ,HSZ);
 349 WINUSERAPI HCONV     WINAPI DdeConnect(DWORD,HSZ,HSZ,PCONVCONTEXT);
 350 WINUSERAPI HCONVLIST WINAPI DdeConnectList(DWORD,HSZ,HSZ,HCONVLIST,PCONVCONTEXT);
 351 WINUSERAPI HDDEDATA  WINAPI DdeCreateDataHandle(DWORD,LPBYTE,DWORD,DWORD,HSZ,UINT,UINT);
 352 WINUSERAPI HSZ       WINAPI DdeCreateStringHandleA(DWORD,LPCSTR,INT);
 353 WINUSERAPI HSZ       WINAPI DdeCreateStringHandleW(DWORD,LPCWSTR,INT);
 354 #define                     DdeCreateStringHandle WINELIB_NAME_AW(DdeCreateStringHandle)
 355 WINUSERAPI BOOL      WINAPI DdeDisconnect(HCONV);
 356 WINUSERAPI BOOL      WINAPI DdeDisconnectList(HCONVLIST);
 357 WINUSERAPI BOOL      WINAPI DdeEnableCallback(DWORD,HCONV,UINT);
 358 WINUSERAPI BOOL      WINAPI DdeFreeDataHandle(HDDEDATA);
 359 WINUSERAPI BOOL      WINAPI DdeFreeStringHandle(DWORD,HSZ);
 360 WINUSERAPI DWORD     WINAPI DdeGetData(HDDEDATA,LPBYTE,DWORD,DWORD);
 361 WINUSERAPI UINT      WINAPI DdeGetLastError(DWORD);
 362 WINUSERAPI BOOL      WINAPI DdeImpersonateClient(HCONV);
 363 WINUSERAPI UINT      WINAPI DdeInitializeA(LPDWORD,PFNCALLBACK,DWORD,DWORD);
 364 WINUSERAPI UINT      WINAPI DdeInitializeW(LPDWORD,PFNCALLBACK,DWORD,DWORD);
 365 #define                     DdeInitialize WINELIB_NAME_AW(DdeInitialize)
 366 WINUSERAPI BOOL      WINAPI DdeKeepStringHandle(DWORD,HSZ);
 367 WINUSERAPI HDDEDATA  WINAPI DdeNameService(DWORD,HSZ,HSZ,UINT);
 368 WINUSERAPI BOOL      WINAPI DdePostAdvise(DWORD,HSZ,HSZ);
 369 WINUSERAPI UINT      WINAPI DdeQueryConvInfo(HCONV,DWORD,PCONVINFO);
 370 WINUSERAPI HCONV     WINAPI DdeQueryNextServer(HCONVLIST, HCONV);
 371 WINUSERAPI DWORD     WINAPI DdeQueryStringA(DWORD, HSZ, LPSTR, DWORD, INT);
 372 WINUSERAPI DWORD     WINAPI DdeQueryStringW(DWORD, HSZ, LPWSTR, DWORD, INT);
 373 #define                     DdeQueryString WINELIB_NAME_AW(DdeQueryString)
 374 WINUSERAPI HCONV     WINAPI DdeReconnect(HCONV);
 375 WINUSERAPI BOOL      WINAPI DdeSetUserHandle(HCONV,DWORD,DWORD);
 376 WINUSERAPI BOOL      WINAPI DdeUnaccessData(HDDEDATA);
 377 WINUSERAPI BOOL      WINAPI DdeUninitialize(DWORD);
 378
 379 #ifdef __cplusplus
 380 } /* extern "C" */
 381 #endif /* defined(__cplusplus) */
 382
 383 #endif  /* __WINE_DDEML_H */