push 7f8c39dca3a5819e8ef115eebf7abed537de3a22
[wine/hacks.git] / dlls / user32 / dde_client.c
blob83bc9fb0ffe3678ba871dd2c08088d432823f786
1 /*
2 * DDEML library
4 * Copyright 1997 Alexandre Julliard
5 * Copyright 1997 Len White
6 * Copyright 1999 Keith Matthews
7 * Copyright 2000 Corel
8 * Copyright 2001 Eric Pouech
9 * Copyright 2004, 2005 Dmitry Timoshkov
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #include <stdarg.h>
27 #include <string.h>
28 #include "windef.h"
29 #include "winbase.h"
30 #include "wingdi.h"
31 #include "winuser.h"
32 #include "winnls.h"
33 #include "dde.h"
34 #include "ddeml.h"
35 #include "win.h"
36 #include "wine/debug.h"
37 #include "dde_private.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(ddeml);
41 static LRESULT CALLBACK WDML_ClientProc(HWND, UINT, WPARAM, LPARAM); /* only for one client, not conv list */
42 const char WDML_szClientConvClassA[] = "WineDdeClientA";
43 const WCHAR WDML_szClientConvClassW[] = {'W','i','n','e','D','d','e','C','l','i','e','n','t','W',0};
45 /******************************************************************************
46 * DdeConnectList [USER32.@] Establishes conversation with DDE servers
48 * PARAMS
49 * idInst [I] Instance identifier
50 * hszService [I] Handle to service name string
51 * hszTopic [I] Handle to topic name string
52 * hConvList [I] Handle to conversation list
53 * pCC [I] Pointer to structure with context data
55 * RETURNS
56 * Success: Handle to new conversation list
57 * Failure: 0
59 HCONVLIST WINAPI DdeConnectList(DWORD idInst, HSZ hszService, HSZ hszTopic,
60 HCONVLIST hConvList, PCONVCONTEXT pCC)
62 FIXME("(%d,%p,%p,%p,%p): stub\n", idInst, hszService, hszTopic, hConvList, pCC);
63 return (HCONVLIST)1;
66 /*****************************************************************
67 * DdeQueryNextServer [USER32.@]
69 HCONV WINAPI DdeQueryNextServer(HCONVLIST hConvList, HCONV hConvPrev)
71 FIXME("(%p,%p): stub\n", hConvList, hConvPrev);
72 return 0;
75 /******************************************************************************
76 * DdeDisconnectList [USER32.@] Destroys list and terminates conversations
79 * PARAMS
80 * hConvList [I] Handle to conversation list
82 * RETURNS
83 * Success: TRUE
84 * Failure: FALSE
86 BOOL WINAPI DdeDisconnectList(HCONVLIST hConvList)
88 FIXME("(%p): stub\n", hConvList);
89 return TRUE;
92 /*****************************************************************
93 * DdeConnect (USER32.@)
95 HCONV WINAPI DdeConnect(DWORD idInst, HSZ hszService, HSZ hszTopic,
96 PCONVCONTEXT pCC)
98 HWND hwndClient;
99 WDML_INSTANCE* pInstance;
100 WDML_CONV* pConv = NULL;
101 ATOM aSrv = 0, aTpc = 0;
103 TRACE("(0x%x,%p,%p,%p)\n", idInst, hszService, hszTopic, pCC);
105 pInstance = WDML_GetInstance(idInst);
106 if (!pInstance)
107 return NULL;
109 /* make sure this conv is never created */
110 pConv = WDML_FindConv(pInstance, WDML_CLIENT_SIDE, hszService, hszTopic);
111 if (pConv != NULL)
113 ERR("This Conv already exists: (%p)\n", pConv);
114 return NULL;
117 /* we need to establish a conversation with
118 server, so create a window for it */
120 if (pInstance->unicode)
122 WNDCLASSEXW wndclass;
124 wndclass.cbSize = sizeof(wndclass);
125 wndclass.style = 0;
126 wndclass.lpfnWndProc = WDML_ClientProc;
127 wndclass.cbClsExtra = 0;
128 wndclass.cbWndExtra = 2 * sizeof(ULONG_PTR);
129 wndclass.hInstance = 0;
130 wndclass.hIcon = 0;
131 wndclass.hCursor = 0;
132 wndclass.hbrBackground = 0;
133 wndclass.lpszMenuName = NULL;
134 wndclass.lpszClassName = WDML_szClientConvClassW;
135 wndclass.hIconSm = 0;
137 RegisterClassExW(&wndclass);
139 hwndClient = CreateWindowW(WDML_szClientConvClassW, NULL, WS_POPUP, 0, 0, 0, 0, 0, 0, 0, 0);
141 else
143 WNDCLASSEXA wndclass;
145 wndclass.cbSize = sizeof(wndclass);
146 wndclass.style = 0;
147 wndclass.lpfnWndProc = WDML_ClientProc;
148 wndclass.cbClsExtra = 0;
149 wndclass.cbWndExtra = 2 * sizeof(ULONG_PTR);
150 wndclass.hInstance = 0;
151 wndclass.hIcon = 0;
152 wndclass.hCursor = 0;
153 wndclass.hbrBackground = 0;
154 wndclass.lpszMenuName = NULL;
155 wndclass.lpszClassName = WDML_szClientConvClassA;
156 wndclass.hIconSm = 0;
158 RegisterClassExA(&wndclass);
160 hwndClient = CreateWindowA(WDML_szClientConvClassA, NULL, WS_POPUP, 0, 0, 0, 0, 0, 0, 0, 0);
163 SetWindowLongPtrW(hwndClient, GWL_WDML_INSTANCE, (ULONG_PTR)pInstance);
165 if (hszService)
167 aSrv = WDML_MakeAtomFromHsz(hszService);
168 if (!aSrv) goto theEnd;
170 if (hszTopic)
172 aTpc = WDML_MakeAtomFromHsz(hszTopic);
173 if (!aTpc) goto theEnd;
176 /* note: sent messages shall not use packing */
177 SendMessageTimeoutW( HWND_BROADCAST, WM_DDE_INITIATE, (WPARAM)hwndClient, MAKELPARAM(aSrv, aTpc),
178 SMTO_ABORTIFHUNG, 2000, NULL );
180 pInstance = WDML_GetInstance(idInst);
181 if (!pInstance)
183 goto theEnd;
186 /* At this point, Client WM_DDE_ACK should have saved hwndServer
187 for this instance id and hwndClient if server responds.
188 So get HCONV and return it. And add it to conv list */
189 pConv = WDML_GetConvFromWnd(hwndClient);
190 if (pConv == NULL || pConv->hwndServer == 0)
192 WARN("Done with INITIATE, but no Server window available\n");
193 pConv = NULL;
194 goto theEnd;
196 TRACE("Connected to Server window (%p)\n", pConv->hwndServer);
197 pConv->wConvst = XST_CONNECTED;
199 /* finish init of pConv */
200 if (pCC != NULL)
202 pConv->convContext = *pCC;
204 else
206 memset(&pConv->convContext, 0, sizeof(pConv->convContext));
207 pConv->convContext.cb = sizeof(pConv->convContext);
208 pConv->convContext.iCodePage = (pInstance->unicode) ? CP_WINUNICODE : CP_WINANSI;
211 theEnd:
213 if (aSrv) GlobalDeleteAtom(aSrv);
214 if (aTpc) GlobalDeleteAtom(aTpc);
215 return (HCONV)pConv;
218 /*****************************************************************
219 * DdeReconnect (DDEML.37)
220 * DdeReconnect (USER32.@)
222 HCONV WINAPI DdeReconnect(HCONV hConv)
224 WDML_CONV* pConv;
225 WDML_CONV* pNewConv = NULL;
226 ATOM aSrv = 0, aTpc = 0;
228 TRACE("(%p)\n", hConv);
230 pConv = WDML_GetConv(hConv, FALSE);
231 if (pConv != NULL && (pConv->wStatus & ST_CLIENT))
233 BOOL ret;
235 /* to reestablish a connection, we have to make sure that:
236 * 1/ pConv is the conversation attached to the client window (it wouldn't be
237 * if a call to DdeReconnect would have already been done...)
238 * FIXME: is this really an error ???
239 * 2/ the pConv conversation had really been deconnected
241 if (pConv == WDML_GetConvFromWnd(pConv->hwndClient) &&
242 (pConv->wStatus & ST_TERMINATED) && !(pConv->wStatus & ST_CONNECTED))
244 HWND hwndClient = pConv->hwndClient;
245 HWND hwndServer = pConv->hwndServer;
247 SetWindowLongPtrW(pConv->hwndClient, GWL_WDML_CONVERSATION, 0);
249 aSrv = WDML_MakeAtomFromHsz(pConv->hszService);
250 aTpc = WDML_MakeAtomFromHsz(pConv->hszTopic);
251 if (!aSrv || !aTpc) goto theEnd;
253 /* note: sent messages shall not use packing */
254 ret = SendMessageW(hwndServer, WM_DDE_INITIATE, (WPARAM)hwndClient,
255 MAKELPARAM(aSrv, aTpc));
257 pConv = WDML_GetConv(hConv, FALSE);
258 if (pConv == NULL)
260 FIXME("Should fail reconnection\n");
261 goto theEnd;
264 if (ret && (pNewConv = WDML_GetConvFromWnd(pConv->hwndClient)) != NULL)
266 /* re-establish all links... */
267 WDML_LINK* pLink;
269 for (pLink = pConv->instance->links[WDML_CLIENT_SIDE]; pLink; pLink = pLink->next)
271 if (pLink->hConv == hConv)
273 /* try to reestablish the links... */
274 DdeClientTransaction(NULL, 0, (HCONV)pNewConv, pLink->hszItem, pLink->uFmt,
275 pLink->transactionType, 1000, NULL);
279 else
281 /* reset the conversation as it was */
282 SetWindowLongPtrW(pConv->hwndClient, GWL_WDML_CONVERSATION, (ULONG_PTR)pConv);
287 theEnd:
289 if (aSrv) GlobalDeleteAtom(aSrv);
290 if (aTpc) GlobalDeleteAtom(aTpc);
291 return (HCONV)pNewConv;
294 /******************************************************************
295 * WDML_ClientQueueAdvise
297 * Creates and queue an WM_DDE_ADVISE transaction
299 static WDML_XACT* WDML_ClientQueueAdvise(WDML_CONV* pConv, UINT wType, UINT wFmt, HSZ hszItem)
301 DDEADVISE* pDdeAdvise;
302 WDML_XACT* pXAct;
303 ATOM atom;
305 TRACE("XTYP_ADVSTART (with%s data) transaction\n", (wType & XTYPF_NODATA) ? "out" : "");
307 atom = WDML_MakeAtomFromHsz(hszItem);
308 if (!atom) return NULL;
310 pXAct = WDML_AllocTransaction(pConv->instance, WM_DDE_ADVISE, wFmt, hszItem);
311 if (!pXAct)
313 GlobalDeleteAtom(atom);
314 return NULL;
317 pXAct->wType = wType & ~0x0F;
318 pXAct->hMem = GlobalAlloc(GHND | GMEM_DDESHARE, sizeof(DDEADVISE));
319 /* FIXME: hMem is unfreed for now... should be deleted in server */
321 /* pack DdeAdvise */
322 pDdeAdvise = (DDEADVISE*)GlobalLock(pXAct->hMem);
323 pDdeAdvise->fAckReq = (wType & XTYPF_ACKREQ) ? TRUE : FALSE;
324 pDdeAdvise->fDeferUpd = (wType & XTYPF_NODATA) ? TRUE : FALSE;
325 pDdeAdvise->cfFormat = wFmt;
326 GlobalUnlock(pXAct->hMem);
328 pXAct->lParam = PackDDElParam(WM_DDE_ADVISE, (UINT_PTR)pXAct->hMem, atom);
330 return pXAct;
333 /******************************************************************
334 * WDML_HandleAdviseReply
336 * handles the reply to an advise request
338 static WDML_QUEUE_STATE WDML_HandleAdviseReply(WDML_CONV* pConv, MSG* msg, WDML_XACT* pXAct, DWORD *ack)
340 DDEACK ddeAck;
341 UINT_PTR uiLo, uiHi;
342 HSZ hsz;
344 if (msg->message != WM_DDE_ACK || WIN_GetFullHandle((HWND)msg->wParam) != pConv->hwndServer)
346 return WDML_QS_PASS;
349 UnpackDDElParam(WM_DDE_ACK, msg->lParam, &uiLo, &uiHi);
350 hsz = WDML_MakeHszFromAtom(pConv->instance, uiHi);
352 if (DdeCmpStringHandles(hsz, pXAct->hszItem) != 0)
353 return WDML_QS_PASS;
355 GlobalDeleteAtom(uiHi);
356 FreeDDElParam(WM_DDE_ACK, msg->lParam);
358 if (ack) *ack = uiLo;
359 WDML_ExtractAck(uiLo, &ddeAck);
361 if (ddeAck.fAck)
363 WDML_LINK* pLink;
365 /* billx: first to see if the link is already created. */
366 pLink = WDML_FindLink(pConv->instance, (HCONV)pConv, WDML_CLIENT_SIDE,
367 pXAct->hszItem, TRUE, pXAct->wFmt);
368 if (pLink != NULL)
370 /* we found a link, and only need to modify it in case it changes */
371 pLink->transactionType = pXAct->wType;
373 else
375 WDML_AddLink(pConv->instance, (HCONV)pConv, WDML_CLIENT_SIDE,
376 pXAct->wType, pXAct->hszItem, pXAct->wFmt);
378 pXAct->hDdeData = (HDDEDATA)1;
380 else
382 TRACE("Returning FALSE on XTYP_ADVSTART - fAck was FALSE\n");
383 GlobalFree(pXAct->hMem);
384 pXAct->hDdeData = NULL;
387 return WDML_QS_HANDLED;
390 /******************************************************************
391 * WDML_ClientQueueUnadvise
393 * queues an unadvise transaction
395 static WDML_XACT* WDML_ClientQueueUnadvise(WDML_CONV* pConv, UINT wFmt, HSZ hszItem)
397 WDML_XACT* pXAct;
398 ATOM atom;
400 TRACE("XTYP_ADVSTOP transaction\n");
402 atom = WDML_MakeAtomFromHsz(hszItem);
403 if (!atom) return NULL;
405 pXAct = WDML_AllocTransaction(pConv->instance, WM_DDE_UNADVISE, wFmt, hszItem);
406 if (!pXAct)
408 GlobalDeleteAtom(atom);
409 return NULL;
412 /* end advise loop: post WM_DDE_UNADVISE to server to terminate link
413 * on the specified item.
415 pXAct->lParam = PackDDElParam(WM_DDE_UNADVISE, wFmt, atom);
416 return pXAct;
419 /******************************************************************
420 * WDML_HandleUnadviseReply
424 static WDML_QUEUE_STATE WDML_HandleUnadviseReply(WDML_CONV* pConv, MSG* msg, WDML_XACT* pXAct, DWORD *ack)
426 DDEACK ddeAck;
427 UINT_PTR uiLo, uiHi;
428 HSZ hsz;
430 if (msg->message != WM_DDE_ACK || WIN_GetFullHandle((HWND)msg->wParam) != pConv->hwndServer)
432 return WDML_QS_PASS;
435 UnpackDDElParam(WM_DDE_ACK, msg->lParam, &uiLo, &uiHi);
436 hsz = WDML_MakeHszFromAtom(pConv->instance, uiHi);
438 if (DdeCmpStringHandles(hsz, pXAct->hszItem) != 0)
439 return WDML_QS_PASS;
441 FreeDDElParam(WM_DDE_ACK, msg->lParam);
442 GlobalDeleteAtom(uiHi);
444 if (ack) *ack = uiLo;
445 WDML_ExtractAck(uiLo, &ddeAck);
447 TRACE("WM_DDE_ACK received while waiting for a timeout\n");
449 if (!ddeAck.fAck)
451 TRACE("Returning FALSE on XTYP_ADVSTOP - fAck was FALSE\n");
452 pXAct->hDdeData = NULL;
454 else
456 /* billx: remove the link */
457 WDML_RemoveLink(pConv->instance, (HCONV)pConv, WDML_CLIENT_SIDE,
458 pXAct->hszItem, pXAct->wFmt);
459 pXAct->hDdeData = (HDDEDATA)1;
461 return WDML_QS_HANDLED;
464 /******************************************************************
465 * WDML_ClientQueueRequest
469 static WDML_XACT* WDML_ClientQueueRequest(WDML_CONV* pConv, UINT wFmt, HSZ hszItem)
471 WDML_XACT* pXAct;
472 ATOM atom;
474 TRACE("XTYP_REQUEST transaction\n");
476 atom = WDML_MakeAtomFromHsz(hszItem);
477 if (!atom) return NULL;
479 pXAct = WDML_AllocTransaction(pConv->instance, WM_DDE_REQUEST, wFmt, hszItem);
480 if (!pXAct)
482 GlobalDeleteAtom(atom);
483 return NULL;
486 pXAct->lParam = PackDDElParam(WM_DDE_REQUEST, wFmt, atom);
488 return pXAct;
491 /******************************************************************
492 * WDML_HandleRequestReply
496 static WDML_QUEUE_STATE WDML_HandleRequestReply(WDML_CONV* pConv, MSG* msg, WDML_XACT* pXAct, DWORD *ack)
498 DDEACK ddeAck;
499 WINE_DDEHEAD wdh;
500 UINT_PTR uiLo, uiHi;
501 HSZ hsz;
503 if (WIN_GetFullHandle((HWND)msg->wParam) != pConv->hwndServer)
504 return WDML_QS_PASS;
506 switch (msg->message)
508 case WM_DDE_ACK:
509 UnpackDDElParam(WM_DDE_ACK, msg->lParam, &uiLo, &uiHi);
510 FreeDDElParam(WM_DDE_ACK, msg->lParam);
511 GlobalDeleteAtom(uiHi);
512 if (ack) *ack = uiLo;
513 WDML_ExtractAck(uiLo, &ddeAck);
514 pXAct->hDdeData = 0;
515 if (ddeAck.fAck)
516 ERR("Positive answer should appear in NACK for a request, assuming negative\n");
517 TRACE("Negative answer...\n");
518 break;
520 case WM_DDE_DATA:
521 UnpackDDElParam(WM_DDE_DATA, msg->lParam, &uiLo, &uiHi);
522 TRACE("Got the result (%08lx)\n", uiLo);
524 hsz = WDML_MakeHszFromAtom(pConv->instance, uiHi);
526 if (DdeCmpStringHandles(hsz, pXAct->hszItem) != 0)
527 return WDML_QS_PASS;
529 pXAct->hDdeData = WDML_Global2DataHandle((HGLOBAL)uiLo, &wdh);
530 if (wdh.fRelease)
532 GlobalFree((HGLOBAL)uiLo);
534 if (wdh.fAckReq)
536 pConv->instance->lastError = DMLERR_MEMORY_ERROR;
538 else
540 GlobalDeleteAtom(uiHi);
541 FreeDDElParam(WM_DDE_ACK, msg->lParam);
543 break;
545 default:
546 FreeDDElParam(msg->message, msg->lParam);
547 return WDML_QS_PASS;
550 return WDML_QS_HANDLED;
553 /******************************************************************
554 * WDML_BuildExecuteCommand
556 * Creates a DDE block suitable for sending in WM_DDE_COMMAND
557 * It also takes care of string conversion between the two window procedures
559 static HGLOBAL WDML_BuildExecuteCommand(WDML_CONV* pConv, LPCVOID pData, DWORD cbData)
561 HGLOBAL hMem;
562 BOOL clientUnicode, serverUnicode;
563 DWORD memSize;
565 clientUnicode = pConv->instance->unicode;
566 TRACE("client %p uses unicode = %d\n", pConv->hwndClient, clientUnicode);
567 /* FIXME: how exactly Windows determines what to use for the server side? */
568 serverUnicode = IsWindowUnicode(pConv->hwndServer) && IsWindowUnicode(pConv->hwndClient);
569 TRACE("server %p uses unicode = %d\n", pConv->hwndServer, serverUnicode);
571 if (clientUnicode == serverUnicode)
573 memSize = cbData;
575 else
577 if (clientUnicode)
579 memSize = WideCharToMultiByte( CP_ACP, 0, pData, cbData / sizeof(WCHAR), NULL, 0, NULL, NULL);
581 else
583 memSize = MultiByteToWideChar( CP_ACP, 0, pData, cbData, NULL, 0) * sizeof(WCHAR);
587 hMem = GlobalAlloc(GMEM_MOVEABLE | GMEM_DDESHARE, memSize);
589 if (hMem)
591 LPSTR pDst;
593 pDst = GlobalLock(hMem);
594 if (pDst)
596 if (clientUnicode == serverUnicode)
598 memcpy(pDst, pData, cbData);
600 else
602 if (clientUnicode)
604 WideCharToMultiByte( CP_ACP, 0, pData, cbData / sizeof(WCHAR), pDst, memSize, NULL, NULL);
606 else
608 MultiByteToWideChar( CP_ACP, 0, pData, cbData, (LPWSTR)pDst, memSize/sizeof(WCHAR));
612 GlobalUnlock(hMem);
614 else
616 GlobalFree(hMem);
617 hMem = 0;
620 return hMem;
623 /******************************************************************
624 * WDML_ClientQueueExecute
628 static WDML_XACT* WDML_ClientQueueExecute(WDML_CONV* pConv, LPVOID pData, DWORD cbData)
630 WDML_XACT* pXAct;
632 TRACE("XTYP_EXECUTE transaction\n");
634 pXAct = WDML_AllocTransaction(pConv->instance, WM_DDE_EXECUTE, 0, 0);
635 if (!pXAct)
636 return NULL;
638 if (cbData == (DWORD)-1)
640 HDDEDATA hDdeData = pData;
642 pData = DdeAccessData(hDdeData, &cbData);
643 if (pData)
645 pXAct->hMem = WDML_BuildExecuteCommand(pConv, pData, cbData);
646 DdeUnaccessData(hDdeData);
649 else
651 pXAct->hMem = WDML_BuildExecuteCommand(pConv, pData, cbData);
654 pXAct->lParam = (LPARAM)pXAct->hMem;
656 return pXAct;
659 /******************************************************************
660 * WDML_HandleExecuteReply
664 static WDML_QUEUE_STATE WDML_HandleExecuteReply(WDML_CONV* pConv, MSG* msg, WDML_XACT* pXAct, DWORD *ack)
666 DDEACK ddeAck;
667 UINT_PTR uiLo, uiHi;
669 if (msg->message != WM_DDE_ACK || WIN_GetFullHandle((HWND)msg->wParam) != pConv->hwndServer)
671 return WDML_QS_PASS;
674 UnpackDDElParam(WM_DDE_ACK, msg->lParam, &uiLo, &uiHi);
675 FreeDDElParam(WM_DDE_ACK, msg->lParam);
677 if ((HANDLE)uiHi != pXAct->hMem)
679 return WDML_QS_PASS;
682 if (ack) *ack = uiLo;
683 WDML_ExtractAck(uiLo, &ddeAck);
684 pXAct->hDdeData = (HDDEDATA)(UINT_PTR)ddeAck.fAck;
686 TRACE("hDdeData = %p\n", pXAct->hDdeData);
687 pConv->instance->lastError = (pXAct->hDdeData != 0) ? DMLERR_NO_ERROR : DMLERR_NOTPROCESSED;
689 return WDML_QS_HANDLED;
692 /******************************************************************
693 * WDML_ClientQueuePoke
697 static WDML_XACT* WDML_ClientQueuePoke(WDML_CONV* pConv, LPVOID pData, DWORD cbData,
698 UINT wFmt, HSZ hszItem)
700 DDE_DATAHANDLE_HEAD *dh;
701 WDML_XACT *pXAct;
702 DDEPOKE *ddePoke;
703 HGLOBAL hglobal;
704 ATOM atom;
706 TRACE("XTYP_POKE transaction\n");
708 atom = WDML_MakeAtomFromHsz(hszItem);
709 if (!atom) return NULL;
711 pXAct = WDML_AllocTransaction(pConv->instance, WM_DDE_POKE, wFmt, hszItem);
712 if (!pXAct)
714 GlobalDeleteAtom(atom);
715 return NULL;
718 if (cbData == (DWORD)-1)
720 hglobal = pData;
721 dh = (DDE_DATAHANDLE_HEAD *)GlobalLock(hglobal);
722 cbData = GlobalSize(hglobal) - sizeof(DDE_DATAHANDLE_HEAD);
723 pData = (LPVOID)(dh + 1);
724 GlobalUnlock(hglobal);
727 pXAct->hMem = GlobalAlloc(GHND | GMEM_DDESHARE, sizeof(DDEPOKE) + cbData);
728 ddePoke = GlobalLock(pXAct->hMem);
729 if (!ddePoke)
731 pConv->instance->lastError = DMLERR_MEMORY_ERROR;
732 return NULL;
735 ddePoke->unused = 0;
736 ddePoke->fRelease = TRUE;
737 ddePoke->cfFormat = wFmt;
738 memcpy(ddePoke->Value, pData, cbData);
739 GlobalUnlock(pXAct->hMem);
741 pXAct->lParam = PackDDElParam(WM_DDE_POKE, (UINT_PTR)pXAct->hMem, atom);
743 return pXAct;
746 /******************************************************************
747 * WDML_HandlePokeReply
751 static WDML_QUEUE_STATE WDML_HandlePokeReply(WDML_CONV* pConv, MSG* msg, WDML_XACT* pXAct, DWORD *ack)
753 UINT_PTR uiLo, uiHi;
754 HSZ hsz;
756 if (msg->message != WM_DDE_ACK && WIN_GetFullHandle((HWND)msg->wParam) != pConv->hwndServer)
758 return WDML_QS_PASS;
761 UnpackDDElParam(WM_DDE_ACK, msg->lParam, &uiLo, &uiHi);
762 hsz = WDML_MakeHszFromAtom(pConv->instance, uiHi);
763 if (DdeCmpStringHandles(hsz, pXAct->hszItem) != 0)
765 return WDML_QS_PASS;
767 FreeDDElParam(WM_DDE_ACK, msg->lParam);
768 GlobalDeleteAtom(uiHi);
770 if (ack) *ack = uiLo;
771 GlobalFree(pXAct->hMem);
773 pXAct->hDdeData = (HDDEDATA)TRUE;
774 return TRUE;
777 /******************************************************************
778 * WDML_ClientQueueTerminate
780 * Creates and queue an WM_DDE_TERMINATE transaction
782 static WDML_XACT* WDML_ClientQueueTerminate(WDML_CONV* pConv)
784 WDML_XACT* pXAct;
786 pXAct = WDML_AllocTransaction(pConv->instance, WM_DDE_TERMINATE, 0, 0);
787 if (!pXAct)
788 return NULL;
790 pXAct->lParam = 0;
791 pConv->wStatus &= ~ST_CONNECTED;
793 return pXAct;
796 /******************************************************************
797 * WDML_HandleTerminateReply
799 * handles the reply to a terminate request
801 static WDML_QUEUE_STATE WDML_HandleTerminateReply(WDML_CONV* pConv, MSG* msg)
803 if (msg->message != WM_DDE_TERMINATE)
805 /* FIXME: should delete data passed here */
806 return WDML_QS_SWALLOWED;
809 if (WIN_GetFullHandle((HWND)msg->wParam) != pConv->hwndServer)
811 FIXME("hmmm shouldn't happen\n");
812 return WDML_QS_PASS;
814 if (!pConv->instance->CBFflags & CBF_SKIP_DISCONNECTS)
816 WDML_InvokeCallback(pConv->instance, XTYP_DISCONNECT, 0, (HCONV)pConv,
817 0, 0, 0, 0, (pConv->wStatus & ST_ISSELF) ? 1 : 0);
819 WDML_RemoveConv(pConv, WDML_CLIENT_SIDE);
820 return WDML_QS_HANDLED;
823 /******************************************************************
824 * WDML_HandleIncomingData
828 static WDML_QUEUE_STATE WDML_HandleIncomingData(WDML_CONV* pConv, MSG* msg, HDDEDATA* hdd)
830 UINT_PTR uiLo, uiHi;
831 HDDEDATA hDdeDataIn, hDdeDataOut;
832 WDML_LINK* pLink;
833 WINE_DDEHEAD wdh;
834 HSZ hsz;
836 TRACE("WM_DDE_DATA message received in the Client Proc!\n");
837 /* wParam -- sending window handle */
838 /* lParam -- hDdeData & item HSZ */
840 UnpackDDElParam(WM_DDE_DATA, msg->lParam, &uiLo, &uiHi);
841 hsz = WDML_MakeHszFromAtom(pConv->instance, uiHi);
843 hDdeDataIn = WDML_Global2DataHandle((HGLOBAL)uiLo, &wdh);
845 /* billx:
846 * For hot link, data should be passed to its callback with
847 * XTYP_ADVDATA and callback should return the proper status.
849 pLink = WDML_FindLink(pConv->instance, (HCONV)pConv, WDML_CLIENT_SIDE, hsz,
850 uiLo ? TRUE : FALSE, wdh.cfFormat);
851 if (!pLink)
853 WDML_DecHSZ(pConv->instance, hsz);
854 DdeFreeDataHandle(hDdeDataIn);
855 return WDML_QS_PASS;
858 if (hDdeDataIn != 0 && wdh.fAckReq)
860 WDML_PostAck(pConv, WDML_CLIENT_SIDE, 0, FALSE, TRUE, uiHi, msg->lParam, WM_DDE_DATA);
861 if (msg->lParam)
862 msg->lParam = 0;
864 else
866 GlobalDeleteAtom(uiHi);
869 hDdeDataOut = WDML_InvokeCallback(pConv->instance, XTYP_ADVDATA, pLink->uFmt, pLink->hConv,
870 pConv->hszTopic, pLink->hszItem, hDdeDataIn, 0, 0);
872 if (hDdeDataOut != (HDDEDATA)DDE_FACK || wdh.fRelease)
874 if (uiLo) GlobalFree((HANDLE)uiLo);
877 DdeFreeDataHandle(hDdeDataIn);
879 WDML_DecHSZ(pConv->instance, hsz);
880 if (msg->lParam)
881 FreeDDElParam(WM_DDE_DATA, msg->lParam);
883 return WDML_QS_HANDLED;
886 /******************************************************************
887 * WDML_HandleIncomingTerminate
891 static WDML_QUEUE_STATE WDML_HandleIncomingTerminate(WDML_CONV* pConv, MSG* msg, HDDEDATA* hdd)
893 if (pConv->hwndServer != WIN_GetFullHandle((HWND)msg->wParam))
894 return WDML_QS_PASS;
896 pConv->wStatus |= ST_TERMINATED;
897 if (!pConv->instance->CBFflags & CBF_SKIP_DISCONNECTS)
899 WDML_InvokeCallback(pConv->instance, XTYP_DISCONNECT, 0, (HCONV)pConv,
900 0, 0, 0, 0, (pConv->wStatus & ST_ISSELF) ? 1 : 0);
902 if (pConv->wStatus & ST_CONNECTED)
904 /* don't care about result code (if server exists or not) */
905 PostMessageW(pConv->hwndServer, WM_DDE_TERMINATE, (WPARAM)pConv->hwndClient, 0L);
906 pConv->wStatus &= ~ST_CONNECTED;
908 /* have to keep connection around to allow reconnection */
909 return WDML_QS_HANDLED;
912 /******************************************************************
913 * WDML_HandleReply
915 * handles any incoming reply, and try to match to an already sent request
917 static WDML_QUEUE_STATE WDML_HandleReply(WDML_CONV* pConv, MSG* msg, HDDEDATA* hdd, DWORD *ack)
919 WDML_XACT* pXAct = pConv->transactions;
920 WDML_QUEUE_STATE qs;
922 if (pConv->transactions)
924 /* first check message against a pending transaction, if any */
925 switch (pXAct->ddeMsg)
927 case WM_DDE_ADVISE:
928 qs = WDML_HandleAdviseReply(pConv, msg, pXAct, ack);
929 break;
930 case WM_DDE_UNADVISE:
931 qs = WDML_HandleUnadviseReply(pConv, msg, pXAct, ack);
932 break;
933 case WM_DDE_EXECUTE:
934 qs = WDML_HandleExecuteReply(pConv, msg, pXAct, ack);
935 break;
936 case WM_DDE_REQUEST:
937 qs = WDML_HandleRequestReply(pConv, msg, pXAct, ack);
938 break;
939 case WM_DDE_POKE:
940 qs = WDML_HandlePokeReply(pConv, msg, pXAct, ack);
941 break;
942 case WM_DDE_TERMINATE:
943 qs = WDML_HandleTerminateReply(pConv, msg);
944 break;
945 default:
946 qs = WDML_QS_ERROR;
947 FIXME("oooch\n");
950 else
952 qs = WDML_QS_PASS;
955 /* now check the results */
956 switch (qs)
958 case WDML_QS_ERROR:
959 case WDML_QS_SWALLOWED:
960 *hdd = 0;
961 break;
962 case WDML_QS_HANDLED:
963 /* ok, we have resolved a pending transaction
964 * notify callback if asynchronous.
966 if (pXAct->dwTimeout == TIMEOUT_ASYNC && pXAct->ddeMsg != WM_DDE_TERMINATE)
968 WDML_InvokeCallback(pConv->instance, XTYP_XACT_COMPLETE, pXAct->wFmt,
969 (HCONV)pConv, pConv->hszTopic, pXAct->hszItem,
970 pXAct->hDdeData, MAKELONG(0, pXAct->xActID), 0 /* FIXME */);
971 qs = WDML_QS_PASS;
973 else
975 *hdd = pXAct->hDdeData;
977 break;
978 case WDML_QS_PASS:
979 /* no pending transaction found, try a warm/hot link or a termination request */
980 switch (msg->message)
982 case WM_DDE_DATA:
983 qs = WDML_HandleIncomingData(pConv, msg, hdd);
984 break;
985 case WM_DDE_TERMINATE:
986 qs = WDML_HandleIncomingTerminate(pConv, msg, hdd);
987 break;
988 case WM_DDE_ACK:
989 /* This happens at end of DdeClientTransaction XTYP_EXECUTE
990 * Without this assignment, DdeClientTransaction's return value is undefined
992 *hdd = (HDDEDATA)TRUE;
993 if (ack)
994 *ack = DDE_FACK;
995 break;
997 break;
998 case WDML_QS_BLOCK:
999 FIXME("shouldn't be used on client side\n");
1000 break;
1003 return qs;
1006 /******************************************************************
1007 * WDML_SyncWaitTransactionReply
1009 * waits until an answer for a sent request is received
1010 * time out is also handled. only used for synchronous transactions
1012 static HDDEDATA WDML_SyncWaitTransactionReply(HCONV hConv, DWORD dwTimeout, const WDML_XACT* pXAct, DWORD *ack)
1014 DWORD dwTime;
1015 DWORD err;
1016 WDML_CONV* pConv;
1018 TRACE("Starting wait for a timeout of %d ms\n", dwTimeout);
1020 /* FIXME: time 32 bit wrap around */
1021 dwTimeout += GetCurrentTime();
1023 while ((dwTime = GetCurrentTime()) < dwTimeout)
1025 /* we cannot be in the crit sect all the time because when client and server run in a
1026 * single process they need to share the access to the internal data
1028 if (MsgWaitForMultipleObjects(0, NULL, FALSE,
1029 dwTimeout - dwTime, QS_POSTMESSAGE) == WAIT_OBJECT_0)
1031 MSG msg;
1033 while (PeekMessageW(&msg, 0, WM_DDE_FIRST, WM_DDE_LAST, PM_REMOVE))
1035 HDDEDATA hdd = NULL;
1037 pConv = WDML_GetConv(hConv, FALSE);
1038 if (pConv == NULL)
1040 /* conversation no longer available... return failure */
1041 return 0;
1043 if (msg.hwnd == pConv->hwndClient)
1045 /* check that either pXAct has been processed or no more xActions are pending */
1046 BOOL ret = (pConv->transactions == pXAct);
1047 if (WDML_HandleReply(pConv, &msg, &hdd, ack) == WDML_QS_HANDLED)
1049 TRACE("WDML_HandleReply returned WDML_QS_HANDLED\n");
1050 ret = TRUE;
1052 else
1053 ret = (pConv->transactions == NULL || ret);
1055 if (ret)
1057 pConv->instance->lastError = hdd ? DMLERR_NO_ERROR : DMLERR_NOTPROCESSED;
1058 return hdd;
1061 else
1063 DispatchMessageW(&msg);
1069 TRACE("Timeout !!\n");
1071 pConv = WDML_GetConv(hConv, FALSE);
1072 if (pConv != NULL)
1074 if (pConv->transactions)
1076 switch (pConv->transactions->ddeMsg)
1078 case WM_DDE_ADVISE: err = DMLERR_ADVACKTIMEOUT; break;
1079 case WM_DDE_REQUEST: err = DMLERR_DATAACKTIMEOUT; break;
1080 case WM_DDE_EXECUTE: err = DMLERR_EXECACKTIMEOUT; break;
1081 case WM_DDE_POKE: err = DMLERR_POKEACKTIMEOUT; break;
1082 case WM_DDE_UNADVISE: err = DMLERR_UNADVACKTIMEOUT; break;
1083 default: err = DMLERR_INVALIDPARAMETER; break;
1086 pConv->instance->lastError = err;
1090 return 0;
1094 /*****************************************************************
1095 * WDML_ClientHandle
1097 HDDEDATA WDML_ClientHandle(WDML_CONV *pConv, WDML_XACT *pXAct, DWORD dwTimeout, LPDWORD pdwResult)
1099 HDDEDATA hDdeData;
1101 if (!PostMessageW(pConv->hwndServer, pXAct->ddeMsg, (WPARAM)pConv->hwndClient, pXAct->lParam))
1103 WARN("Failed posting message %x to %p (error=0x%x)\n",
1104 pXAct->ddeMsg, pConv->hwndServer, GetLastError());
1105 pConv->wStatus &= ~ST_CONNECTED;
1106 pConv->instance->lastError = DMLERR_POSTMSG_FAILED;
1107 return 0;
1109 pXAct->dwTimeout = dwTimeout;
1110 /* FIXME: should set the app bits on *pdwResult */
1112 if (dwTimeout == TIMEOUT_ASYNC)
1114 if (pdwResult)
1115 *pdwResult = MAKELONG(0, pXAct->xActID);
1117 hDdeData = (HDDEDATA)1;
1119 else
1120 hDdeData = WDML_SyncWaitTransactionReply((HCONV)pConv, dwTimeout, pXAct, pdwResult);
1122 return hDdeData;
1126 /*****************************************************************
1127 * DdeClientTransaction (USER32.@)
1129 HDDEDATA WINAPI DdeClientTransaction(LPBYTE pData, DWORD cbData, HCONV hConv, HSZ hszItem, UINT wFmt,
1130 UINT wType, DWORD dwTimeout, LPDWORD pdwResult)
1132 WDML_CONV* pConv;
1133 WDML_XACT* pXAct;
1134 HDDEDATA hDdeData = 0;
1136 TRACE("(%p,%d,%p,%p,%x,%x,%d,%p)\n",
1137 pData, cbData, hConv, hszItem, wFmt, wType, dwTimeout, pdwResult);
1139 if (hConv == 0)
1141 WARN("Invalid conversation handle NULL\n");
1142 return 0;
1145 pConv = WDML_GetConv(hConv, TRUE);
1146 if (pConv == NULL)
1148 /* cannot set error... cannot get back to DDE instance */
1149 return 0;
1152 switch (wType)
1154 case XTYP_EXECUTE:
1155 /* Windows simply ignores hszItem and wFmt in this case */
1156 pXAct = WDML_ClientQueueExecute(pConv, pData, cbData);
1157 break;
1158 case XTYP_POKE:
1159 if (!hszItem)
1161 pConv->instance->lastError = DMLERR_INVALIDPARAMETER;
1162 return 0;
1164 pXAct = WDML_ClientQueuePoke(pConv, pData, cbData, wFmt, hszItem);
1165 break;
1166 case XTYP_ADVSTART|XTYPF_NODATA:
1167 case XTYP_ADVSTART|XTYPF_NODATA|XTYPF_ACKREQ:
1168 case XTYP_ADVSTART:
1169 case XTYP_ADVSTART|XTYPF_ACKREQ:
1170 if (pData)
1172 pConv->instance->lastError = DMLERR_INVALIDPARAMETER;
1173 return 0;
1175 pXAct = WDML_ClientQueueAdvise(pConv, wType, wFmt, hszItem);
1176 break;
1177 case XTYP_ADVSTOP:
1178 if (pData)
1180 pConv->instance->lastError = DMLERR_INVALIDPARAMETER;
1181 return 0;
1183 pXAct = WDML_ClientQueueUnadvise(pConv, wFmt, hszItem);
1184 break;
1185 case XTYP_REQUEST:
1186 if (pData || !hszItem)
1188 pConv->instance->lastError = DMLERR_INVALIDPARAMETER;
1189 return 0;
1191 pXAct = WDML_ClientQueueRequest(pConv, wFmt, hszItem);
1192 break;
1193 default:
1194 FIXME("Unknown transaction type %04x\n", wType);
1195 /* unknown transaction type */
1196 pConv->instance->lastError = DMLERR_INVALIDPARAMETER;
1197 return 0;
1200 if (pXAct == NULL)
1202 pConv->instance->lastError = DMLERR_MEMORY_ERROR;
1203 return 0;
1206 WDML_QueueTransaction(pConv, pXAct);
1208 TRACE("pConv->wStatus %04x\n", pConv->wStatus);
1210 if (pConv->wStatus & ST_BLOCKED)
1212 TRACE("Transactions are blocked, add to the queue and exit\n");
1213 return (HDDEDATA)1;
1216 hDdeData = WDML_ClientHandle(pConv, pXAct, dwTimeout, pdwResult);
1217 if (dwTimeout != TIMEOUT_ASYNC)
1219 WDML_UnQueueTransaction(pConv, pXAct);
1220 WDML_FreeTransaction(pConv->instance, pXAct, TRUE);
1223 return hDdeData;
1226 /*****************************************************************
1227 * DdeAbandonTransaction (USER32.@)
1229 BOOL WINAPI DdeAbandonTransaction(DWORD idInst, HCONV hConv, DWORD idTransaction)
1231 WDML_INSTANCE* pInstance;
1232 WDML_CONV* pConv;
1233 WDML_XACT* pXAct;
1235 if ((pInstance = WDML_GetInstance(idInst)))
1237 if (hConv)
1239 if ((pConv = WDML_GetConv(hConv, TRUE)) && pConv->instance == pInstance)
1241 for (pXAct = pConv->transactions; pXAct; pXAct = pXAct->next)
1243 if (pXAct->dwTimeout == TIMEOUT_ASYNC &&
1244 (idTransaction == 0 || pXAct->xActID == idTransaction))
1246 WDML_UnQueueTransaction(pConv, pXAct);
1247 WDML_FreeTransaction(pInstance, pXAct, TRUE);
1252 else
1254 for (pConv = pInstance->convs[WDML_CLIENT_SIDE]; pConv; pConv = pConv->next)
1256 if (!(pConv->wStatus & ST_CONNECTED)) continue;
1257 for (pXAct = pConv->transactions; pXAct; pXAct = pXAct->next)
1259 if (pXAct->dwTimeout == TIMEOUT_ASYNC)
1261 WDML_UnQueueTransaction(pConv, pXAct);
1262 WDML_FreeTransaction(pInstance, pXAct, TRUE);
1269 return TRUE;
1272 /******************************************************************
1273 * WDML_ClientProc
1275 * Window Proc created on client side for each conversation
1277 static LRESULT CALLBACK WDML_ClientProc(HWND hwnd, UINT iMsg, WPARAM wParam, LPARAM lParam)
1279 UINT uiLo, uiHi;
1280 WDML_CONV* pConv = NULL;
1281 HSZ hszSrv, hszTpc;
1283 TRACE("%p %04x %08lx %08lx\n", hwnd, iMsg, wParam , lParam);
1285 if (iMsg == WM_DDE_ACK &&
1286 /* in the initial WM_INITIATE sendmessage */
1287 ((pConv = WDML_GetConvFromWnd(hwnd)) == NULL || pConv->wStatus == XST_INIT1))
1289 /* In response to WM_DDE_INITIATE, save server window */
1290 char buf[256];
1291 WDML_INSTANCE* pInstance;
1293 /* note: sent messages do not need packing */
1294 uiLo = LOWORD(lParam);
1295 uiHi = HIWORD(lParam);
1297 /* FIXME: convlist should be handled here */
1298 if (pConv)
1300 /* we already have started the conv with a server, drop other replies */
1301 GlobalDeleteAtom(uiLo);
1302 GlobalDeleteAtom(uiHi);
1303 PostMessageW((HWND)wParam, WM_DDE_TERMINATE, (WPARAM)hwnd, 0);
1304 return 0;
1307 pInstance = WDML_GetInstanceFromWnd(hwnd);
1309 hszSrv = WDML_MakeHszFromAtom(pInstance, uiLo);
1310 hszTpc = WDML_MakeHszFromAtom(pInstance, uiHi);
1312 pConv = WDML_AddConv(pInstance, WDML_CLIENT_SIDE, hszSrv, hszTpc, hwnd, (HWND)wParam);
1314 SetWindowLongPtrW(hwnd, GWL_WDML_CONVERSATION, (ULONG_PTR)pConv);
1315 pConv->wStatus |= ST_CONNECTED;
1316 pConv->wConvst = XST_INIT1;
1318 /* check if server is handled by DDEML */
1319 if ((GetClassNameA((HWND)wParam, buf, sizeof(buf)) &&
1320 lstrcmpiA(buf, WDML_szServerConvClassA) == 0) ||
1321 (GetClassNameW((HWND)wParam, (LPWSTR)buf, sizeof(buf)/sizeof(WCHAR)) &&
1322 lstrcmpiW((LPWSTR)buf, WDML_szServerConvClassW) == 0))
1324 pConv->wStatus |= ST_ISLOCAL;
1327 WDML_BroadcastDDEWindows(WDML_szEventClass, WM_WDML_CONNECT_CONFIRM, (WPARAM)hwnd, wParam);
1329 GlobalDeleteAtom(uiLo);
1330 GlobalDeleteAtom(uiHi);
1332 /* accept conversation */
1333 return 1;
1336 if (iMsg >= WM_DDE_FIRST && iMsg <= WM_DDE_LAST)
1338 pConv = WDML_GetConvFromWnd(hwnd);
1340 if (pConv)
1342 MSG msg;
1343 HDDEDATA hdd;
1345 msg.hwnd = hwnd;
1346 msg.message = iMsg;
1347 msg.wParam = wParam;
1348 msg.lParam = lParam;
1350 WDML_HandleReply(pConv, &msg, &hdd, NULL);
1353 return 0;
1356 return IsWindowUnicode(hwnd) ? DefWindowProcW(hwnd, iMsg, wParam, lParam) :
1357 DefWindowProcA(hwnd, iMsg, wParam, lParam);
1360 /*****************************************************************
1361 * DdeDisconnect (USER32.@)
1363 BOOL WINAPI DdeDisconnect(HCONV hConv)
1365 WDML_CONV* pConv = NULL;
1366 WDML_XACT* pXAct;
1367 BOOL ret = FALSE;
1369 TRACE("(%p)\n", hConv);
1371 if (hConv == 0)
1373 WARN("DdeDisconnect(): hConv = 0\n");
1374 return FALSE;
1377 pConv = WDML_GetConv(hConv, TRUE);
1378 if (pConv != NULL)
1380 if (pConv->wStatus & ST_CLIENT)
1382 /* FIXME: should abandon all pending transactions */
1383 pXAct = WDML_ClientQueueTerminate(pConv);
1384 if (pXAct != NULL)
1386 if (PostMessageW(pConv->hwndServer, pXAct->ddeMsg,
1387 (WPARAM)pConv->hwndClient, pXAct->lParam))
1389 WDML_SyncWaitTransactionReply(hConv, 10000, pXAct, NULL);
1390 ret = TRUE;
1392 else
1393 pConv->instance->lastError = DMLERR_POSTMSG_FAILED;
1395 WDML_FreeTransaction(pConv->instance, pXAct, TRUE);
1396 /* still have to destroy data associated with conversation */
1397 WDML_RemoveConv(pConv, WDML_CLIENT_SIDE);
1399 else
1401 FIXME("Not implemented yet for a server side conversation\n");
1406 return ret;
1409 /*****************************************************************
1410 * DdeImpersonateClient (USER32.@)
1412 BOOL WINAPI DdeImpersonateClient(HCONV hConv)
1414 WDML_CONV* pConv;
1415 BOOL ret = FALSE;
1417 TRACE("(%p)\n", hConv);
1419 pConv = WDML_GetConv(hConv, TRUE);
1420 if (pConv)
1422 ret = ImpersonateDdeClientWindow(pConv->hwndClient, pConv->hwndServer);
1424 return ret;