2 * Undocumented functions from COMCTL32.DLL
4 * Copyright 1998 Eric Kohl
5 * 1998 Juergen Schmied <j.schmied@metronet.de>
6 * 2000 Eric Kohl for CodeWeavers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 * All of these functions are UNDOCUMENTED!! And I mean UNDOCUMENTED!!!!
24 * Do NOT rely on names or contents of undocumented structures and types!!!
25 * These functions are used by EXPLORER.EXE, IEXPLORE.EXE and
26 * COMCTL32.DLL (internally).
30 #include "wine/port.h"
38 #define NONAMELESSUNION
39 #define NONAMELESSSTRUCT
51 #include "wine/unicode.h"
54 #include "wine/debug.h"
56 WINE_DEFAULT_DEBUG_CHANNEL(commctrl
);
58 static const WCHAR strMRUList
[] = { 'M','R','U','L','i','s','t',0 };
60 /**************************************************************************
63 * Allocates memory block from the dll's private heap
66 * dwSize [I] size of the allocated memory block
69 * Success: pointer to allocated memory block
72 LPVOID WINAPI
Alloc (DWORD dwSize
)
74 return LocalAlloc( LMEM_ZEROINIT
, dwSize
);
78 /**************************************************************************
79 * ReAlloc [COMCTL32.72]
81 * Changes the size of an allocated memory block or allocates a memory
82 * block using the dll's private heap.
85 * lpSrc [I] pointer to memory block which will be resized
86 * dwSize [I] new size of the memory block.
89 * Success: pointer to the resized memory block
93 * If lpSrc is a NULL-pointer, then ReAlloc allocates a memory
96 LPVOID WINAPI
ReAlloc (LPVOID lpSrc
, DWORD dwSize
)
99 return LocalReAlloc( lpSrc
, dwSize
, LMEM_ZEROINIT
| LMEM_MOVEABLE
);
101 return LocalAlloc( LMEM_ZEROINIT
, dwSize
);
105 /**************************************************************************
108 * Frees an allocated memory block from the dll's private heap.
111 * lpMem [I] pointer to memory block which will be freed
117 BOOL WINAPI
Free (LPVOID lpMem
)
119 return !LocalFree( lpMem
);
123 /**************************************************************************
124 * GetSize [COMCTL32.74]
126 * Retrieves the size of the specified memory block from the dll's
130 * lpMem [I] pointer to an allocated memory block
133 * Success: size of the specified memory block
136 DWORD WINAPI
GetSize (LPVOID lpMem
)
138 return LocalSize( lpMem
);
142 /**************************************************************************
143 * MRU-Functions {COMCTL32}
146 * The MRU-Api is a set of functions to manipulate lists of M.R.U. (Most Recently
147 * Used) items. It is an undocumented Api that is used (at least) by the shell
148 * and explorer to implement their recent documents feature.
150 * Since these functions are undocumented, they are unsupported by MS and
151 * may change at any time.
153 * Internally, the list is implemented as a last in, last out list of items
154 * persisted into the system registry under a caller chosen key. Each list
155 * item is given a one character identifier in the Ascii range from 'a' to
156 * '}'. A list of the identifiers in order from newest to oldest is stored
157 * under the same key in a value named "MRUList".
159 * Items are re-ordered by changing the order of the values in the MRUList
160 * value. When a new item is added, it becomes the new value of the oldest
161 * identifier, and that identifier is moved to the front of the MRUList value.
163 * Wine stores MRU-lists in the same registry format as Windows, so when
164 * switching between the builtin and native comctl32.dll no problems or
165 * incompatibilities should occur.
167 * The following undocumented structure is used to create an MRU-list:
168 *|typedef INT (CALLBACK *MRUStringCmpFn)(LPCTSTR lhs, LPCTSTR rhs);
169 *|typedef INT (CALLBACK *MRUBinaryCmpFn)(LPCVOID lhs, LPCVOID rhs, DWORD length);
171 *|typedef struct tagCREATEMRULIST
177 *| LPCTSTR lpszSubKey;
179 *|} CREATEMRULIST, *LPCREATEMRULIST;
182 * cbSize [I] The size of the CREATEMRULIST structure. This must be set
183 * to sizeof(CREATEMRULIST) by the caller.
184 * nMaxItems [I] The maximum number of items allowed in the list. Because
185 * of the limited number of identifiers, this should be set to
186 * a value from 1 to 30 by the caller.
187 * dwFlags [I] If bit 0 is set, the list will be used to store binary
188 * data, otherwise it is assumed to store strings. If bit 1
189 * is set, every change made to the list will be reflected in
190 * the registry immediately, otherwise changes will only be
191 * written when the list is closed.
192 * hKey [I] The registry key that the list should be written under.
193 * This must be supplied by the caller.
194 * lpszSubKey [I] A caller supplied name of a subkey under hKey to write
195 * the list to. This may not be blank.
196 * lpfnCompare [I] A caller supplied comparison function, which may be either
197 * an MRUStringCmpFn if dwFlags does not have bit 0 set, or a
198 * MRUBinaryCmpFn otherwise.
201 * - Create an MRU-list with CreateMRUList() or CreateMRUListLazy().
202 * - Add items to an MRU-list with AddMRUString() or AddMRUData().
203 * - Remove items from an MRU-list with DelMRUString().
204 * - Find data in an MRU-list with FindMRUString() or FindMRUData().
205 * - Iterate through an MRU-list with EnumMRUList().
206 * - Free an MRU-list with FreeMRUList().
209 typedef struct tagCREATEMRULISTA
217 } CREATEMRULISTA
, *LPCREATEMRULISTA
;
219 typedef struct tagCREATEMRULISTW
227 } CREATEMRULISTW
, *LPCREATEMRULISTW
;
230 #define MRUF_STRING_LIST 0 /* list will contain strings */
231 #define MRUF_BINARY_LIST 1 /* list will contain binary data */
232 #define MRUF_DELAYED_SAVE 2 /* only save list order to reg. is FreeMRUList */
234 /* If list is a string list lpfnCompare has the following prototype
235 * int CALLBACK MRUCompareString(LPCSTR s1, LPCSTR s2)
236 * for binary lists the prototype is
237 * int CALLBACK MRUCompareBinary(LPCVOID data1, LPCVOID data2, DWORD cbData)
238 * where cbData is the no. of bytes to compare.
239 * Need to check what return value means identical - 0?
242 typedef struct tagWINEMRUITEM
244 DWORD size
; /* size of data stored */
245 DWORD itemFlag
; /* flags */
247 } WINEMRUITEM
, *LPWINEMRUITEM
;
250 #define WMRUIF_CHANGED 0x0001 /* this dataitem changed */
252 typedef struct tagWINEMRULIST
254 CREATEMRULISTW extview
; /* original create information */
255 BOOL isUnicode
; /* is compare fn Unicode */
256 DWORD wineFlags
; /* internal flags */
257 DWORD cursize
; /* current size of realMRU */
258 LPWSTR realMRU
; /* pointer to string of index names */
259 LPWINEMRUITEM
*array
; /* array of pointers to data */
260 /* in 'a' to 'z' order */
261 } WINEMRULIST
, *LPWINEMRULIST
;
264 #define WMRUF_CHANGED 0x0001 /* MRU list has changed */
266 /**************************************************************************
267 * MRU_SaveChanged (internal)
269 * Local MRU saving code
271 static void MRU_SaveChanged ( LPWINEMRULIST mp
)
278 /* or should we do the following instead of RegOpenKeyEx:
281 /* open the sub key */
282 if ((err
= RegOpenKeyExW( mp
->extview
.hKey
, mp
->extview
.lpszSubKey
,
283 0, KEY_WRITE
, &newkey
))) {
284 /* not present - what to do ??? */
285 ERR("Could not open key, error=%d, attempting to create\n",
287 if ((err
= RegCreateKeyExW( mp
->extview
.hKey
, mp
->extview
.lpszSubKey
,
290 REG_OPTION_NON_VOLATILE
,
291 KEY_READ
| KEY_WRITE
,
295 ERR("failed to create key /%s/, err=%d\n",
296 debugstr_w(mp
->extview
.lpszSubKey
), err
);
300 if (mp
->wineFlags
& WMRUF_CHANGED
) {
301 mp
->wineFlags
&= ~WMRUF_CHANGED
;
302 err
= RegSetValueExW(newkey
, strMRUList
, 0, REG_SZ
, (LPBYTE
)mp
->realMRU
,
303 (strlenW(mp
->realMRU
) + 1)*sizeof(WCHAR
));
305 ERR("error saving MRUList, err=%d\n", err
);
307 TRACE("saving MRUList=/%s/\n", debugstr_w(mp
->realMRU
));
310 for(i
=0; i
<mp
->cursize
; i
++) {
311 witem
= mp
->array
[i
];
312 if (witem
->itemFlag
& WMRUIF_CHANGED
) {
313 witem
->itemFlag
&= ~WMRUIF_CHANGED
;
314 realname
[0] = 'a' + i
;
315 err
= RegSetValueExW(newkey
, realname
, 0,
316 (mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) ?
318 &witem
->datastart
, witem
->size
);
320 ERR("error saving /%s/, err=%d\n", debugstr_w(realname
), err
);
322 TRACE("saving value for name /%s/ size=%ld\n",
323 debugstr_w(realname
), witem
->size
);
326 RegCloseKey( newkey
);
329 /**************************************************************************
330 * FreeMRUList [COMCTL32.152]
332 * Frees a most-recently-used items list.
335 * hMRUList [I] Handle to list.
340 void WINAPI
FreeMRUList (HANDLE hMRUList
)
342 LPWINEMRULIST mp
= (LPWINEMRULIST
)hMRUList
;
345 TRACE("(%p)\n", hMRUList
);
349 if (mp
->wineFlags
& WMRUF_CHANGED
) {
350 /* need to open key and then save the info */
351 MRU_SaveChanged( mp
);
354 for(i
=0; i
<mp
->extview
.nMaxItems
; i
++) {
360 Free((LPWSTR
)mp
->extview
.lpszSubKey
);
365 /**************************************************************************
366 * FindMRUData [COMCTL32.169]
368 * Searches binary list for item that matches lpData of length cbData.
369 * Returns position in list order 0 -> MRU and if lpRegNum != NULL then value
370 * corresponding to item's reg. name will be stored in it ('a' -> 0).
373 * hList [I] list handle
374 * lpData [I] data to find
375 * cbData [I] length of data
376 * lpRegNum [O] position in registry (maybe NULL)
379 * Position in list 0 -> MRU. -1 if item not found.
381 INT WINAPI
FindMRUData (HANDLE hList
, LPCVOID lpData
, DWORD cbData
,
384 LPWINEMRULIST mp
= (LPWINEMRULIST
)hList
;
389 if (!mp
->extview
.lpfnCompare
)
392 if(!(mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) && !mp
->isUnicode
) {
393 DWORD len
= WideCharToMultiByte(CP_ACP
, 0, lpData
, -1,
394 NULL
, 0, NULL
, NULL
);
396 WideCharToMultiByte(CP_ACP
, 0, lpData
, -1, dataA
, len
, NULL
, NULL
);
399 for(i
=0; i
<mp
->cursize
; i
++) {
400 if (mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) {
401 if (!mp
->extview
.lpfnCompare(lpData
, &mp
->array
[i
]->datastart
,
407 if (!mp
->extview
.lpfnCompare(lpData
, &mp
->array
[i
]->datastart
))
410 DWORD len
= WideCharToMultiByte(CP_ACP
, 0,
411 (LPWSTR
)&mp
->array
[i
]->datastart
, -1,
412 NULL
, 0, NULL
, NULL
);
413 LPSTR itemA
= Alloc(len
);
415 WideCharToMultiByte(CP_ACP
, 0, (LPWSTR
)&mp
->array
[i
]->datastart
, -1,
416 itemA
, len
, NULL
, NULL
);
418 cmp
= mp
->extview
.lpfnCompare(dataA
, itemA
);
431 if (lpRegNum
&& (ret
!= -1))
434 TRACE("(%p, %p, %ld, %p) returning %d\n",
435 hList
, lpData
, cbData
, lpRegNum
, ret
);
441 /**************************************************************************
442 * AddMRUData [COMCTL32.167]
444 * Add item to MRU binary list. If item already exists in list then it is
445 * simply moved up to the top of the list and not added again. If list is
446 * full then the least recently used item is removed to make room.
449 * hList [I] Handle to list.
450 * lpData [I] ptr to data to add.
451 * cbData [I] no. of bytes of data.
454 * No. corresponding to registry name where value is stored 'a' -> 0 etc.
457 INT WINAPI
AddMRUData (HANDLE hList
, LPCVOID lpData
, DWORD cbData
)
459 LPWINEMRULIST mp
= (LPWINEMRULIST
)hList
;
463 if ((replace
= FindMRUData (hList
, lpData
, cbData
, NULL
)) >= 0) {
464 /* Item exists, just move it to the front */
465 LPWSTR pos
= strchrW(mp
->realMRU
, replace
+ 'a');
466 while (pos
> mp
->realMRU
)
473 /* either add a new entry or replace oldest */
474 if (mp
->cursize
< mp
->extview
.nMaxItems
) {
475 /* Add in a new item */
476 replace
= mp
->cursize
;
480 /* get the oldest entry and replace data */
481 replace
= mp
->realMRU
[mp
->cursize
- 1] - 'a';
482 Free(mp
->array
[replace
]);
485 /* Allocate space for new item and move in the data */
486 mp
->array
[replace
] = witem
= Alloc(cbData
+ sizeof(WINEMRUITEM
));
487 witem
->itemFlag
|= WMRUIF_CHANGED
;
488 witem
->size
= cbData
;
489 memcpy( &witem
->datastart
, lpData
, cbData
);
491 /* now rotate MRU list */
492 for(i
=mp
->cursize
-1; i
>=1; i
--)
493 mp
->realMRU
[i
] = mp
->realMRU
[i
-1];
496 /* The new item gets the front spot */
497 mp
->wineFlags
|= WMRUF_CHANGED
;
498 mp
->realMRU
[0] = replace
+ 'a';
500 TRACE("(%p, %p, %ld) adding data, /%c/ now most current\n",
501 hList
, lpData
, cbData
, replace
+'a');
503 if (!(mp
->extview
.dwFlags
& MRUF_DELAYED_SAVE
)) {
504 /* save changed stuff right now */
505 MRU_SaveChanged( mp
);
511 /**************************************************************************
512 * AddMRUStringW [COMCTL32.401]
514 * Add an item to an MRU string list.
517 * hList [I] Handle to list.
518 * lpszString [I] The string to add.
521 * Success: The number corresponding to the registry name where the string
522 * has been stored (0 maps to 'a', 1 to 'b' and so on).
523 * Failure: -1, if hList is NULL or memory allocation fails. If lpszString
524 * is invalid, the function returns 0, and GetLastError() returns
525 * ERROR_INVALID_PARAMETER. The last error value is set only in
529 * -If lpszString exists in the list already, it is moved to the top of the
530 * MRU list (it is not duplicated).
531 * -If the list is full the least recently used list entry is replaced with
533 * -If this function returns 0 you should check the last error value to
534 * ensure the call really succeeded.
536 INT WINAPI
AddMRUStringW(HANDLE hList
, LPCWSTR lpszString
)
538 TRACE("(%p,%s)\n", hList
, debugstr_w(lpszString
));
543 if (!lpszString
|| IsBadStringPtrW(lpszString
, -1))
545 SetLastError(ERROR_INVALID_PARAMETER
);
549 return AddMRUData(hList
, lpszString
,
550 (strlenW(lpszString
) + 1) * sizeof(WCHAR
));
553 /**************************************************************************
554 * AddMRUStringA [COMCTL32.153]
558 INT WINAPI
AddMRUStringA(HANDLE hList
, LPCSTR lpszString
)
564 TRACE("(%p,%s)\n", hList
, debugstr_a(lpszString
));
569 if (IsBadStringPtrA(lpszString
, -1))
571 SetLastError(ERROR_INVALID_PARAMETER
);
575 len
= MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, NULL
, 0) * sizeof(WCHAR
);
576 stringW
= Alloc(len
);
580 MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, stringW
, len
/sizeof(WCHAR
));
581 ret
= AddMRUData(hList
, stringW
, len
);
586 /**************************************************************************
587 * DelMRUString [COMCTL32.156]
589 * Removes item from either string or binary list (despite its name)
592 * hList [I] list handle
593 * nItemPos [I] item position to remove 0 -> MRU
596 * TRUE if successful, FALSE if nItemPos is out of range.
598 BOOL WINAPI
DelMRUString(HANDLE hList
, INT nItemPos
)
600 FIXME("(%p, %d): stub\n", hList
, nItemPos
);
604 /**************************************************************************
605 * FindMRUStringW [COMCTL32.402]
607 * See FindMRUStringA.
609 INT WINAPI
FindMRUStringW (HANDLE hList
, LPCWSTR lpszString
, LPINT lpRegNum
)
611 return FindMRUData(hList
, lpszString
,
612 (lstrlenW(lpszString
) + 1) * sizeof(WCHAR
), lpRegNum
);
615 /**************************************************************************
616 * FindMRUStringA [COMCTL32.155]
618 * Searches string list for item that matches lpszString.
619 * Returns position in list order 0 -> MRU and if lpRegNum != NULL then value
620 * corresponding to item's reg. name will be stored in it ('a' -> 0).
623 * hList [I] list handle
624 * lpszString [I] string to find
625 * lpRegNum [O] position in registry (maybe NULL)
628 * Position in list 0 -> MRU. -1 if item not found.
630 INT WINAPI
FindMRUStringA (HANDLE hList
, LPCSTR lpszString
, LPINT lpRegNum
)
632 DWORD len
= MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, NULL
, 0);
633 LPWSTR stringW
= Alloc(len
* sizeof(WCHAR
));
636 MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, stringW
, len
);
637 ret
= FindMRUData(hList
, stringW
, len
* sizeof(WCHAR
), lpRegNum
);
642 /*************************************************************************
643 * CreateMRUListLazy_common (internal)
645 static HANDLE
CreateMRUListLazy_common(LPWINEMRULIST mp
)
649 DWORD datasize
, dwdisp
;
654 /* get space to save indices that will turn into names
655 * but in order of most to least recently used
657 mp
->realMRU
= Alloc((mp
->extview
.nMaxItems
+ 2) * sizeof(WCHAR
));
659 /* get space to save pointers to actual data in order of
660 * 'a' to 'z' (0 to n).
662 mp
->array
= Alloc(mp
->extview
.nMaxItems
* sizeof(LPVOID
));
664 /* open the sub key */
665 if ((err
= RegCreateKeyExW( mp
->extview
.hKey
, mp
->extview
.lpszSubKey
,
668 REG_OPTION_NON_VOLATILE
,
669 KEY_READ
| KEY_WRITE
,
673 /* error - what to do ??? */
674 ERR("(%lu %lu %lx %p %s %p): Could not open key, error=%d\n",
675 mp
->extview
.cbSize
, mp
->extview
.nMaxItems
, mp
->extview
.dwFlags
,
676 mp
->extview
.hKey
, debugstr_w(mp
->extview
.lpszSubKey
),
677 mp
->extview
.lpfnCompare
, err
);
681 /* get values from key 'MRUList' */
683 datasize
= (mp
->extview
.nMaxItems
+ 1) * sizeof(WCHAR
);
684 if((err
=RegQueryValueExW( newkey
, strMRUList
, 0, &type
,
685 (LPBYTE
)mp
->realMRU
, &datasize
))) {
686 /* not present - set size to 1 (will become 0 later) */
691 datasize
/= sizeof(WCHAR
);
693 TRACE("MRU list = %s, datasize = %ld\n", debugstr_w(mp
->realMRU
), datasize
);
695 mp
->cursize
= datasize
- 1;
696 /* datasize now has number of items in the MRUList */
698 /* get actual values for each entry */
700 for(i
=0; i
<mp
->cursize
; i
++) {
701 realname
[0] = 'a' + i
;
702 if(RegQueryValueExW( newkey
, realname
, 0, &type
, 0, &datasize
)) {
703 /* not present - what to do ??? */
704 ERR("Key %s not found 1\n", debugstr_w(realname
));
706 mp
->array
[i
] = witem
= Alloc(datasize
+ sizeof(WINEMRUITEM
));
707 witem
->size
= datasize
;
708 if(RegQueryValueExW( newkey
, realname
, 0, &type
,
709 &witem
->datastart
, &datasize
)) {
710 /* not present - what to do ??? */
711 ERR("Key %s not found 2\n", debugstr_w(realname
));
714 RegCloseKey( newkey
);
719 TRACE("(%lu %lu %lx %p %s %p): Current Size = %ld\n",
720 mp
->extview
.cbSize
, mp
->extview
.nMaxItems
, mp
->extview
.dwFlags
,
721 mp
->extview
.hKey
, debugstr_w(mp
->extview
.lpszSubKey
),
722 mp
->extview
.lpfnCompare
, mp
->cursize
);
726 /**************************************************************************
727 * CreateMRUListLazyW [COMCTL32.404]
729 * See CreateMRUListLazyA.
731 HANDLE WINAPI
CreateMRUListLazyW (LPCREATEMRULISTW lpcml
, DWORD dwParam2
,
732 DWORD dwParam3
, DWORD dwParam4
)
736 /* Native does not check for a NULL lpcml */
738 if (lpcml
->cbSize
!= sizeof(CREATEMRULISTW
) || !lpcml
->hKey
||
739 IsBadStringPtrW(lpcml
->lpszSubKey
, -1))
742 mp
= Alloc(sizeof(WINEMRULIST
));
743 memcpy(&mp
->extview
, lpcml
, sizeof(CREATEMRULISTW
));
744 mp
->extview
.lpszSubKey
= Alloc((strlenW(lpcml
->lpszSubKey
) + 1) * sizeof(WCHAR
));
745 strcpyW((LPWSTR
)mp
->extview
.lpszSubKey
, lpcml
->lpszSubKey
);
746 mp
->isUnicode
= TRUE
;
748 return CreateMRUListLazy_common(mp
);
751 /**************************************************************************
752 * CreateMRUListLazyA [COMCTL32.157]
754 * Creates a most-recently-used list.
757 * lpcml [I] ptr to CREATEMRULIST structure.
758 * dwParam2 [I] Unknown
759 * dwParam3 [I] Unknown
760 * dwParam4 [I] Unknown
763 * Handle to MRU list.
765 HANDLE WINAPI
CreateMRUListLazyA (LPCREATEMRULISTA lpcml
, DWORD dwParam2
,
766 DWORD dwParam3
, DWORD dwParam4
)
771 /* Native does not check for a NULL lpcml */
773 if (lpcml
->cbSize
!= sizeof(CREATEMRULISTA
) || !lpcml
->hKey
||
774 IsBadStringPtrA(lpcml
->lpszSubKey
, -1))
777 mp
= Alloc(sizeof(WINEMRULIST
));
778 memcpy(&mp
->extview
, lpcml
, sizeof(CREATEMRULISTW
));
779 len
= MultiByteToWideChar(CP_ACP
, 0, lpcml
->lpszSubKey
, -1, NULL
, 0);
780 mp
->extview
.lpszSubKey
= Alloc(len
* sizeof(WCHAR
));
781 MultiByteToWideChar(CP_ACP
, 0, lpcml
->lpszSubKey
, -1,
782 (LPWSTR
)mp
->extview
.lpszSubKey
, len
);
783 mp
->isUnicode
= FALSE
;
784 return CreateMRUListLazy_common(mp
);
787 /**************************************************************************
788 * CreateMRUListW [COMCTL32.400]
790 * See CreateMRUListA.
792 HANDLE WINAPI
CreateMRUListW (LPCREATEMRULISTW lpcml
)
794 return CreateMRUListLazyW(lpcml
, 0, 0, 0);
797 /**************************************************************************
798 * CreateMRUListA [COMCTL32.151]
800 * Creates a most-recently-used list.
803 * lpcml [I] ptr to CREATEMRULIST structure.
806 * Handle to MRU list.
808 HANDLE WINAPI
CreateMRUListA (LPCREATEMRULISTA lpcml
)
810 return CreateMRUListLazyA (lpcml
, 0, 0, 0);
814 /**************************************************************************
815 * EnumMRUListW [COMCTL32.403]
817 * Enumerate item in a most-recenty-used list
820 * hList [I] list handle
821 * nItemPos [I] item position to enumerate
822 * lpBuffer [O] buffer to receive item
823 * nBufferSize [I] size of buffer
826 * For binary lists specifies how many bytes were copied to buffer, for
827 * string lists specifies full length of string. Enumerating past the end
828 * of list returns -1.
829 * If lpBuffer == NULL or nItemPos is -ve return value is no. of items in
832 INT WINAPI
EnumMRUListW (HANDLE hList
, INT nItemPos
, LPVOID lpBuffer
,
835 LPWINEMRULIST mp
= (LPWINEMRULIST
) hList
;
837 INT desired
, datasize
;
839 if (nItemPos
>= mp
->cursize
) return -1;
840 if ((nItemPos
< 0) || !lpBuffer
) return mp
->cursize
;
841 desired
= mp
->realMRU
[nItemPos
];
843 TRACE("nItemPos=%d, desired=%d\n", nItemPos
, desired
);
844 witem
= mp
->array
[desired
];
845 datasize
= min( witem
->size
, nBufferSize
);
846 memcpy( lpBuffer
, &witem
->datastart
, datasize
);
847 TRACE("(%p, %d, %p, %ld): returning len=%d\n",
848 hList
, nItemPos
, lpBuffer
, nBufferSize
, datasize
);
852 /**************************************************************************
853 * EnumMRUListA [COMCTL32.154]
857 INT WINAPI
EnumMRUListA (HANDLE hList
, INT nItemPos
, LPVOID lpBuffer
,
860 LPWINEMRULIST mp
= (LPWINEMRULIST
) hList
;
862 INT desired
, datasize
;
865 if (nItemPos
>= mp
->cursize
) return -1;
866 if ((nItemPos
< 0) || !lpBuffer
) return mp
->cursize
;
867 desired
= mp
->realMRU
[nItemPos
];
869 TRACE("nItemPos=%d, desired=%d\n", nItemPos
, desired
);
870 witem
= mp
->array
[desired
];
871 if(mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) {
872 datasize
= min( witem
->size
, nBufferSize
);
873 memcpy( lpBuffer
, &witem
->datastart
, datasize
);
875 lenA
= WideCharToMultiByte(CP_ACP
, 0, (LPWSTR
)&witem
->datastart
, -1,
876 NULL
, 0, NULL
, NULL
);
877 datasize
= min( witem
->size
, nBufferSize
);
878 WideCharToMultiByte(CP_ACP
, 0, (LPWSTR
)&witem
->datastart
, -1,
879 lpBuffer
, datasize
, NULL
, NULL
);
881 TRACE("(%p, %d, %p, %ld): returning len=%d\n",
882 hList
, nItemPos
, lpBuffer
, nBufferSize
, datasize
);
887 /**************************************************************************
888 * Str_GetPtrA [COMCTL32.233]
890 * Copies a string into a destination buffer.
893 * lpSrc [I] Source string
894 * lpDest [O] Destination buffer
895 * nMaxLen [I] Size of buffer in characters
898 * The number of characters copied.
900 INT WINAPI
Str_GetPtrA (LPCSTR lpSrc
, LPSTR lpDest
, INT nMaxLen
)
904 TRACE("(%p %p %d)\n", lpSrc
, lpDest
, nMaxLen
);
906 if (!lpDest
&& lpSrc
)
907 return strlen (lpSrc
);
917 len
= strlen (lpSrc
);
921 RtlMoveMemory (lpDest
, lpSrc
, len
);
928 /**************************************************************************
929 * Str_SetPtrA [COMCTL32.234]
931 * Makes a copy of a string, allocating memory if necessary.
934 * lppDest [O] Pointer to destination string
935 * lpSrc [I] Source string
942 * Set lpSrc to NULL to free the memory allocated by a previous call
945 BOOL WINAPI
Str_SetPtrA (LPSTR
*lppDest
, LPCSTR lpSrc
)
947 TRACE("(%p %p)\n", lppDest
, lpSrc
);
950 LPSTR ptr
= ReAlloc (*lppDest
, strlen (lpSrc
) + 1);
967 /**************************************************************************
968 * Str_GetPtrW [COMCTL32.235]
972 INT WINAPI
Str_GetPtrW (LPCWSTR lpSrc
, LPWSTR lpDest
, INT nMaxLen
)
976 TRACE("(%p %p %d)\n", lpSrc
, lpDest
, nMaxLen
);
978 if (!lpDest
&& lpSrc
)
979 return strlenW (lpSrc
);
989 len
= strlenW (lpSrc
);
993 RtlMoveMemory (lpDest
, lpSrc
, len
*sizeof(WCHAR
));
1000 /**************************************************************************
1001 * Str_SetPtrW [COMCTL32.236]
1005 BOOL WINAPI
Str_SetPtrW (LPWSTR
*lppDest
, LPCWSTR lpSrc
)
1007 TRACE("(%p %p)\n", lppDest
, lpSrc
);
1010 INT len
= strlenW (lpSrc
) + 1;
1011 LPWSTR ptr
= ReAlloc (*lppDest
, len
* sizeof(WCHAR
));
1014 strcpyW (ptr
, lpSrc
);
1028 /**************************************************************************
1029 * Str_GetPtrWtoA [internal]
1031 * Converts a unicode string into a multi byte string
1034 * lpSrc [I] Pointer to the unicode source string
1035 * lpDest [O] Pointer to caller supplied storage for the multi byte string
1036 * nMaxLen [I] Size, in bytes, of the destination buffer
1039 * Length, in bytes, of the converted string.
1042 INT
Str_GetPtrWtoA (LPCWSTR lpSrc
, LPSTR lpDest
, INT nMaxLen
)
1046 TRACE("(%s %p %d)\n", debugstr_w(lpSrc
), lpDest
, nMaxLen
);
1048 if (!lpDest
&& lpSrc
)
1049 return WideCharToMultiByte(CP_ACP
, 0, lpSrc
, -1, 0, 0, NULL
, NULL
);
1054 if (lpSrc
== NULL
) {
1059 len
= WideCharToMultiByte(CP_ACP
, 0, lpSrc
, -1, 0, 0, NULL
, NULL
);
1063 WideCharToMultiByte(CP_ACP
, 0, lpSrc
, -1, lpDest
, len
, NULL
, NULL
);
1070 /**************************************************************************
1071 * Str_SetPtrAtoW [internal]
1073 * Converts a multi byte string to a unicode string.
1074 * If the pointer to the destination buffer is NULL a buffer is allocated.
1075 * If the destination buffer is too small to keep the converted multi byte
1076 * string the destination buffer is reallocated. If the source pointer is
1077 * NULL, the destination buffer is freed.
1080 * lppDest [I/O] pointer to a pointer to the destination buffer
1081 * lpSrc [I] pointer to a multi byte string
1084 * TRUE: conversion successful
1087 BOOL
Str_SetPtrAtoW (LPWSTR
*lppDest
, LPCSTR lpSrc
)
1089 TRACE("(%p %s)\n", lppDest
, lpSrc
);
1092 INT len
= MultiByteToWideChar(CP_ACP
,0,lpSrc
,-1,NULL
,0);
1093 LPWSTR ptr
= ReAlloc (*lppDest
, len
*sizeof(WCHAR
));
1097 MultiByteToWideChar(CP_ACP
,0,lpSrc
,-1,ptr
,len
);
1110 /**************************************************************************
1111 * Str_SetPtrWtoA [internal]
1113 * Converts a unicode string to a multi byte string.
1114 * If the pointer to the destination buffer is NULL a buffer is allocated.
1115 * If the destination buffer is too small to keep the converted wide
1116 * string the destination buffer is reallocated. If the source pointer is
1117 * NULL, the destination buffer is freed.
1120 * lppDest [I/O] pointer to a pointer to the destination buffer
1121 * lpSrc [I] pointer to a wide string
1124 * TRUE: conversion successful
1127 BOOL
Str_SetPtrWtoA (LPSTR
*lppDest
, LPCWSTR lpSrc
)
1129 TRACE("(%p %s)\n", lppDest
, debugstr_w(lpSrc
));
1132 INT len
= WideCharToMultiByte(CP_ACP
,0,lpSrc
,-1,NULL
,0,NULL
,FALSE
);
1133 LPSTR ptr
= ReAlloc (*lppDest
, len
*sizeof(CHAR
));
1137 WideCharToMultiByte(CP_ACP
,0,lpSrc
,-1,ptr
,len
,NULL
,FALSE
);
1151 /**************************************************************************
1152 * Notification functions
1155 typedef struct tagNOTIFYDATA
1163 } NOTIFYDATA
, *LPNOTIFYDATA
;
1166 /**************************************************************************
1167 * DoNotify [Internal]
1170 static LRESULT
DoNotify (LPNOTIFYDATA lpNotify
, UINT uCode
, LPNMHDR lpHdr
)
1173 LPNMHDR lpNmh
= NULL
;
1176 TRACE("(%p %p %d %p 0x%08lx)\n",
1177 lpNotify
->hwndFrom
, lpNotify
->hwndTo
, uCode
, lpHdr
,
1178 lpNotify
->dwParam5
);
1180 if (!lpNotify
->hwndTo
)
1183 if (lpNotify
->hwndFrom
== (HWND
)-1) {
1185 idFrom
= lpHdr
->idFrom
;
1188 if (lpNotify
->hwndFrom
)
1189 idFrom
= GetDlgCtrlID (lpNotify
->hwndFrom
);
1191 lpNmh
= (lpHdr
) ? lpHdr
: &nmhdr
;
1193 lpNmh
->hwndFrom
= lpNotify
->hwndFrom
;
1194 lpNmh
->idFrom
= idFrom
;
1195 lpNmh
->code
= uCode
;
1198 return SendMessageW (lpNotify
->hwndTo
, WM_NOTIFY
, idFrom
, (LPARAM
)lpNmh
);
1202 /**************************************************************************
1203 * SendNotify [COMCTL32.341]
1205 * Sends a WM_NOTIFY message to the specified window.
1208 * hwndTo [I] Window to receive the message
1209 * hwndFrom [I] Window that the message is from (see notes)
1210 * uCode [I] Notification code
1211 * lpHdr [I] The NMHDR and any additional information to send or NULL
1214 * Success: return value from notification
1218 * If hwndFrom is -1 then the identifier of the control sending the
1219 * message is taken from the NMHDR structure.
1220 * If hwndFrom is not -1 then lpHdr can be NULL.
1222 LRESULT WINAPI
SendNotify (HWND hwndTo
, HWND hwndFrom
, UINT uCode
, LPNMHDR lpHdr
)
1226 TRACE("(%p %p %d %p)\n",
1227 hwndTo
, hwndFrom
, uCode
, lpHdr
);
1229 notify
.hwndFrom
= hwndFrom
;
1230 notify
.hwndTo
= hwndTo
;
1231 notify
.dwParam5
= 0;
1232 notify
.dwParam6
= 0;
1234 return DoNotify (¬ify
, uCode
, lpHdr
);
1238 /**************************************************************************
1239 * SendNotifyEx [COMCTL32.342]
1241 * Sends a WM_NOTIFY message to the specified window.
1244 * hwndFrom [I] Window to receive the message
1245 * hwndTo [I] Window that the message is from
1246 * uCode [I] Notification code
1247 * lpHdr [I] The NMHDR and any additional information to send or NULL
1248 * dwParam5 [I] Unknown
1251 * Success: return value from notification
1255 * If hwndFrom is -1 then the identifier of the control sending the
1256 * message is taken from the NMHDR structure.
1257 * If hwndFrom is not -1 then lpHdr can be NULL.
1259 LRESULT WINAPI
SendNotifyEx (HWND hwndTo
, HWND hwndFrom
, UINT uCode
,
1260 LPNMHDR lpHdr
, DWORD dwParam5
)
1265 TRACE("(%p %p %d %p 0x%08lx)\n",
1266 hwndFrom
, hwndTo
, uCode
, lpHdr
, dwParam5
);
1268 hwndNotify
= hwndTo
;
1270 if (IsWindow (hwndFrom
)) {
1271 hwndNotify
= GetParent (hwndFrom
);
1277 notify
.hwndFrom
= hwndFrom
;
1278 notify
.hwndTo
= hwndNotify
;
1279 notify
.dwParam5
= dwParam5
;
1280 notify
.dwParam6
= 0;
1282 return DoNotify (¬ify
, uCode
, lpHdr
);