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