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 *| LPTSTR 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=%d\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
++)
359 Free(mp
->extview
.lpszSubKey
);
364 /**************************************************************************
365 * FindMRUData [COMCTL32.169]
367 * Searches binary list for item that matches lpData of length cbData.
368 * Returns position in list order 0 -> MRU and if lpRegNum != NULL then value
369 * corresponding to item's reg. name will be stored in it ('a' -> 0).
372 * hList [I] list handle
373 * lpData [I] data to find
374 * cbData [I] length of data
375 * lpRegNum [O] position in registry (maybe NULL)
378 * Position in list 0 -> MRU. -1 if item not found.
380 INT WINAPI
FindMRUData (HANDLE hList
, LPCVOID lpData
, DWORD cbData
,
383 const WINEMRULIST
*mp
= (LPWINEMRULIST
)hList
;
388 if (!mp
->extview
.lpfnCompare
)
391 if(!(mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) && !mp
->isUnicode
) {
392 DWORD len
= WideCharToMultiByte(CP_ACP
, 0, lpData
, -1,
393 NULL
, 0, NULL
, NULL
);
395 WideCharToMultiByte(CP_ACP
, 0, lpData
, -1, dataA
, len
, NULL
, NULL
);
398 for(i
=0; i
<mp
->cursize
; i
++) {
399 if (mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) {
400 if (!mp
->extview
.lpfnCompare(lpData
, &mp
->array
[i
]->datastart
,
406 if (!mp
->extview
.lpfnCompare(lpData
, &mp
->array
[i
]->datastart
))
409 DWORD len
= WideCharToMultiByte(CP_ACP
, 0,
410 (LPWSTR
)&mp
->array
[i
]->datastart
, -1,
411 NULL
, 0, NULL
, NULL
);
412 LPSTR itemA
= Alloc(len
);
414 WideCharToMultiByte(CP_ACP
, 0, (LPWSTR
)&mp
->array
[i
]->datastart
, -1,
415 itemA
, len
, NULL
, NULL
);
417 cmp
= mp
->extview
.lpfnCompare(dataA
, itemA
);
429 if (lpRegNum
&& (ret
!= -1))
432 TRACE("(%p, %p, %d, %p) returning %d\n",
433 hList
, lpData
, cbData
, lpRegNum
, ret
);
439 /**************************************************************************
440 * AddMRUData [COMCTL32.167]
442 * Add item to MRU binary list. If item already exists in list then it is
443 * simply moved up to the top of the list and not added again. If list is
444 * full then the least recently used item is removed to make room.
447 * hList [I] Handle to list.
448 * lpData [I] ptr to data to add.
449 * cbData [I] no. of bytes of data.
452 * No. corresponding to registry name where value is stored 'a' -> 0 etc.
455 INT WINAPI
AddMRUData (HANDLE hList
, LPCVOID lpData
, DWORD cbData
)
457 LPWINEMRULIST mp
= (LPWINEMRULIST
)hList
;
461 if ((replace
= FindMRUData (hList
, lpData
, cbData
, NULL
)) >= 0) {
462 /* Item exists, just move it to the front */
463 LPWSTR pos
= strchrW(mp
->realMRU
, replace
+ 'a');
464 while (pos
> mp
->realMRU
)
471 /* either add a new entry or replace oldest */
472 if (mp
->cursize
< mp
->extview
.nMaxItems
) {
473 /* Add in a new item */
474 replace
= mp
->cursize
;
478 /* get the oldest entry and replace data */
479 replace
= mp
->realMRU
[mp
->cursize
- 1] - 'a';
480 Free(mp
->array
[replace
]);
483 /* Allocate space for new item and move in the data */
484 mp
->array
[replace
] = witem
= Alloc(cbData
+ sizeof(WINEMRUITEM
));
485 witem
->itemFlag
|= WMRUIF_CHANGED
;
486 witem
->size
= cbData
;
487 memcpy( &witem
->datastart
, lpData
, cbData
);
489 /* now rotate MRU list */
490 for(i
=mp
->cursize
-1; i
>=1; i
--)
491 mp
->realMRU
[i
] = mp
->realMRU
[i
-1];
494 /* The new item gets the front spot */
495 mp
->wineFlags
|= WMRUF_CHANGED
;
496 mp
->realMRU
[0] = replace
+ 'a';
498 TRACE("(%p, %p, %d) adding data, /%c/ now most current\n",
499 hList
, lpData
, cbData
, replace
+'a');
501 if (!(mp
->extview
.dwFlags
& MRUF_DELAYED_SAVE
)) {
502 /* save changed stuff right now */
503 MRU_SaveChanged( mp
);
509 /**************************************************************************
510 * AddMRUStringW [COMCTL32.401]
512 * Add an item to an MRU string list.
515 * hList [I] Handle to list.
516 * lpszString [I] The string to add.
519 * Success: The number corresponding to the registry name where the string
520 * has been stored (0 maps to 'a', 1 to 'b' and so on).
521 * Failure: -1, if hList is NULL or memory allocation fails. If lpszString
522 * is invalid, the function returns 0, and GetLastError() returns
523 * ERROR_INVALID_PARAMETER. The last error value is set only in
527 * -If lpszString exists in the list already, it is moved to the top of the
528 * MRU list (it is not duplicated).
529 * -If the list is full the least recently used list entry is replaced with
531 * -If this function returns 0 you should check the last error value to
532 * ensure the call really succeeded.
534 INT WINAPI
AddMRUStringW(HANDLE hList
, LPCWSTR lpszString
)
536 TRACE("(%p,%s)\n", hList
, debugstr_w(lpszString
));
541 if (!lpszString
|| IsBadStringPtrW(lpszString
, -1))
543 SetLastError(ERROR_INVALID_PARAMETER
);
547 return AddMRUData(hList
, lpszString
,
548 (strlenW(lpszString
) + 1) * sizeof(WCHAR
));
551 /**************************************************************************
552 * AddMRUStringA [COMCTL32.153]
556 INT WINAPI
AddMRUStringA(HANDLE hList
, LPCSTR lpszString
)
562 TRACE("(%p,%s)\n", hList
, debugstr_a(lpszString
));
567 if (IsBadStringPtrA(lpszString
, -1))
569 SetLastError(ERROR_INVALID_PARAMETER
);
573 len
= MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, NULL
, 0) * sizeof(WCHAR
);
574 stringW
= Alloc(len
);
578 MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, stringW
, len
/sizeof(WCHAR
));
579 ret
= AddMRUData(hList
, stringW
, len
);
584 /**************************************************************************
585 * DelMRUString [COMCTL32.156]
587 * Removes item from either string or binary list (despite its name)
590 * hList [I] list handle
591 * nItemPos [I] item position to remove 0 -> MRU
594 * TRUE if successful, FALSE if nItemPos is out of range.
596 BOOL WINAPI
DelMRUString(HANDLE hList
, INT nItemPos
)
598 FIXME("(%p, %d): stub\n", hList
, nItemPos
);
602 /**************************************************************************
603 * FindMRUStringW [COMCTL32.402]
605 * See FindMRUStringA.
607 INT WINAPI
FindMRUStringW (HANDLE hList
, LPCWSTR lpszString
, LPINT lpRegNum
)
609 return FindMRUData(hList
, lpszString
,
610 (lstrlenW(lpszString
) + 1) * sizeof(WCHAR
), lpRegNum
);
613 /**************************************************************************
614 * FindMRUStringA [COMCTL32.155]
616 * Searches string list for item that matches lpszString.
617 * Returns position in list order 0 -> MRU and if lpRegNum != NULL then value
618 * corresponding to item's reg. name will be stored in it ('a' -> 0).
621 * hList [I] list handle
622 * lpszString [I] string to find
623 * lpRegNum [O] position in registry (maybe NULL)
626 * Position in list 0 -> MRU. -1 if item not found.
628 INT WINAPI
FindMRUStringA (HANDLE hList
, LPCSTR lpszString
, LPINT lpRegNum
)
630 DWORD len
= MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, NULL
, 0);
631 LPWSTR stringW
= Alloc(len
* sizeof(WCHAR
));
634 MultiByteToWideChar(CP_ACP
, 0, lpszString
, -1, stringW
, len
);
635 ret
= FindMRUData(hList
, stringW
, len
* sizeof(WCHAR
), lpRegNum
);
640 /*************************************************************************
641 * CreateMRUListLazy_common (internal)
643 static HANDLE
CreateMRUListLazy_common(LPWINEMRULIST mp
)
647 DWORD datasize
, dwdisp
;
652 /* get space to save indices that will turn into names
653 * but in order of most to least recently used
655 mp
->realMRU
= Alloc((mp
->extview
.nMaxItems
+ 2) * sizeof(WCHAR
));
657 /* get space to save pointers to actual data in order of
658 * 'a' to 'z' (0 to n).
660 mp
->array
= Alloc(mp
->extview
.nMaxItems
* sizeof(LPVOID
));
662 /* open the sub key */
663 if ((err
= RegCreateKeyExW( mp
->extview
.hKey
, mp
->extview
.lpszSubKey
,
666 REG_OPTION_NON_VOLATILE
,
667 KEY_READ
| KEY_WRITE
,
671 /* error - what to do ??? */
672 ERR("(%u %u %x %p %s %p): Could not open key, error=%d\n",
673 mp
->extview
.cbSize
, mp
->extview
.nMaxItems
, mp
->extview
.dwFlags
,
674 mp
->extview
.hKey
, debugstr_w(mp
->extview
.lpszSubKey
),
675 mp
->extview
.lpfnCompare
, err
);
679 /* get values from key 'MRUList' */
681 datasize
= (mp
->extview
.nMaxItems
+ 1) * sizeof(WCHAR
);
682 if((err
=RegQueryValueExW( newkey
, strMRUList
, 0, &type
,
683 (LPBYTE
)mp
->realMRU
, &datasize
))) {
684 /* not present - set size to 1 (will become 0 later) */
689 datasize
/= sizeof(WCHAR
);
691 TRACE("MRU list = %s, datasize = %d\n", debugstr_w(mp
->realMRU
), datasize
);
693 mp
->cursize
= datasize
- 1;
694 /* datasize now has number of items in the MRUList */
696 /* get actual values for each entry */
698 for(i
=0; i
<mp
->cursize
; i
++) {
699 realname
[0] = 'a' + i
;
700 if(RegQueryValueExW( newkey
, realname
, 0, &type
, 0, &datasize
)) {
701 /* not present - what to do ??? */
702 ERR("Key %s not found 1\n", debugstr_w(realname
));
704 mp
->array
[i
] = witem
= Alloc(datasize
+ sizeof(WINEMRUITEM
));
705 witem
->size
= datasize
;
706 if(RegQueryValueExW( newkey
, realname
, 0, &type
,
707 &witem
->datastart
, &datasize
)) {
708 /* not present - what to do ??? */
709 ERR("Key %s not found 2\n", debugstr_w(realname
));
712 RegCloseKey( newkey
);
717 TRACE("(%u %u %x %p %s %p): Current Size = %d\n",
718 mp
->extview
.cbSize
, mp
->extview
.nMaxItems
, mp
->extview
.dwFlags
,
719 mp
->extview
.hKey
, debugstr_w(mp
->extview
.lpszSubKey
),
720 mp
->extview
.lpfnCompare
, mp
->cursize
);
724 /**************************************************************************
725 * CreateMRUListLazyW [COMCTL32.404]
727 * See CreateMRUListLazyA.
729 HANDLE WINAPI
CreateMRUListLazyW (const CREATEMRULISTW
*lpcml
, DWORD dwParam2
,
730 DWORD dwParam3
, DWORD dwParam4
)
734 /* Native does not check for a NULL lpcml */
736 if (lpcml
->cbSize
!= sizeof(CREATEMRULISTW
) || !lpcml
->hKey
||
737 IsBadStringPtrW(lpcml
->lpszSubKey
, -1))
740 mp
= Alloc(sizeof(WINEMRULIST
));
741 memcpy(&mp
->extview
, lpcml
, sizeof(CREATEMRULISTW
));
742 mp
->extview
.lpszSubKey
= Alloc((strlenW(lpcml
->lpszSubKey
) + 1) * sizeof(WCHAR
));
743 strcpyW(mp
->extview
.lpszSubKey
, lpcml
->lpszSubKey
);
744 mp
->isUnicode
= TRUE
;
746 return CreateMRUListLazy_common(mp
);
749 /**************************************************************************
750 * CreateMRUListLazyA [COMCTL32.157]
752 * Creates a most-recently-used list.
755 * lpcml [I] ptr to CREATEMRULIST structure.
756 * dwParam2 [I] Unknown
757 * dwParam3 [I] Unknown
758 * dwParam4 [I] Unknown
761 * Handle to MRU list.
763 HANDLE WINAPI
CreateMRUListLazyA (const CREATEMRULISTA
*lpcml
, DWORD dwParam2
,
764 DWORD dwParam3
, DWORD dwParam4
)
769 /* Native does not check for a NULL lpcml */
771 if (lpcml
->cbSize
!= sizeof(CREATEMRULISTA
) || !lpcml
->hKey
||
772 IsBadStringPtrA(lpcml
->lpszSubKey
, -1))
775 mp
= Alloc(sizeof(WINEMRULIST
));
776 memcpy(&mp
->extview
, lpcml
, sizeof(CREATEMRULISTW
));
777 len
= MultiByteToWideChar(CP_ACP
, 0, lpcml
->lpszSubKey
, -1, NULL
, 0);
778 mp
->extview
.lpszSubKey
= Alloc(len
* sizeof(WCHAR
));
779 MultiByteToWideChar(CP_ACP
, 0, lpcml
->lpszSubKey
, -1,
780 mp
->extview
.lpszSubKey
, len
);
781 mp
->isUnicode
= FALSE
;
782 return CreateMRUListLazy_common(mp
);
785 /**************************************************************************
786 * CreateMRUListW [COMCTL32.400]
788 * See CreateMRUListA.
790 HANDLE WINAPI
CreateMRUListW (const CREATEMRULISTW
*lpcml
)
792 return CreateMRUListLazyW(lpcml
, 0, 0, 0);
795 /**************************************************************************
796 * CreateMRUListA [COMCTL32.151]
798 * Creates a most-recently-used list.
801 * lpcml [I] ptr to CREATEMRULIST structure.
804 * Handle to MRU list.
806 HANDLE WINAPI
CreateMRUListA (const CREATEMRULISTA
*lpcml
)
808 return CreateMRUListLazyA (lpcml
, 0, 0, 0);
812 /**************************************************************************
813 * EnumMRUListW [COMCTL32.403]
815 * Enumerate item in a most-recenty-used list
818 * hList [I] list handle
819 * nItemPos [I] item position to enumerate
820 * lpBuffer [O] buffer to receive item
821 * nBufferSize [I] size of buffer
824 * For binary lists specifies how many bytes were copied to buffer, for
825 * string lists specifies full length of string. Enumerating past the end
826 * of list returns -1.
827 * If lpBuffer == NULL or nItemPos is -ve return value is no. of items in
830 INT WINAPI
EnumMRUListW (HANDLE hList
, INT nItemPos
, LPVOID lpBuffer
,
833 const WINEMRULIST
*mp
= (LPWINEMRULIST
) hList
;
834 const WINEMRUITEM
*witem
;
835 INT desired
, datasize
;
837 if ((nItemPos
< 0) || !lpBuffer
) return mp
->cursize
;
838 if (nItemPos
>= mp
->cursize
) return -1;
839 desired
= mp
->realMRU
[nItemPos
];
841 TRACE("nItemPos=%d, desired=%d\n", nItemPos
, desired
);
842 witem
= mp
->array
[desired
];
843 datasize
= min( witem
->size
, nBufferSize
);
844 memcpy( lpBuffer
, &witem
->datastart
, datasize
);
845 TRACE("(%p, %d, %p, %d): returning len=%d\n",
846 hList
, nItemPos
, lpBuffer
, nBufferSize
, datasize
);
850 /**************************************************************************
851 * EnumMRUListA [COMCTL32.154]
855 INT WINAPI
EnumMRUListA (HANDLE hList
, INT nItemPos
, LPVOID lpBuffer
,
858 const WINEMRULIST
*mp
= (LPWINEMRULIST
) hList
;
860 INT desired
, datasize
;
863 if ((nItemPos
< 0) || !lpBuffer
) return mp
->cursize
;
864 if (nItemPos
>= mp
->cursize
) return -1;
865 desired
= mp
->realMRU
[nItemPos
];
867 TRACE("nItemPos=%d, desired=%d\n", nItemPos
, desired
);
868 witem
= mp
->array
[desired
];
869 if(mp
->extview
.dwFlags
& MRUF_BINARY_LIST
) {
870 datasize
= min( witem
->size
, nBufferSize
);
871 memcpy( lpBuffer
, &witem
->datastart
, datasize
);
873 lenA
= WideCharToMultiByte(CP_ACP
, 0, (LPWSTR
)&witem
->datastart
, -1,
874 NULL
, 0, NULL
, NULL
);
875 datasize
= min( witem
->size
, nBufferSize
);
876 WideCharToMultiByte(CP_ACP
, 0, (LPWSTR
)&witem
->datastart
, -1,
877 lpBuffer
, datasize
, NULL
, NULL
);
879 TRACE("(%p, %d, %p, %d): returning len=%d\n",
880 hList
, nItemPos
, lpBuffer
, nBufferSize
, datasize
);
884 /**************************************************************************
885 * Str_GetPtrWtoA [internal]
887 * Converts a unicode string into a multi byte string
890 * lpSrc [I] Pointer to the unicode source string
891 * lpDest [O] Pointer to caller supplied storage for the multi byte string
892 * nMaxLen [I] Size, in bytes, of the destination buffer
895 * Length, in bytes, of the converted string.
898 INT
Str_GetPtrWtoA (LPCWSTR lpSrc
, LPSTR lpDest
, INT nMaxLen
)
902 TRACE("(%s %p %d)\n", debugstr_w(lpSrc
), lpDest
, nMaxLen
);
904 if (!lpDest
&& lpSrc
)
905 return WideCharToMultiByte(CP_ACP
, 0, lpSrc
, -1, 0, 0, NULL
, NULL
);
915 len
= WideCharToMultiByte(CP_ACP
, 0, lpSrc
, -1, 0, 0, NULL
, NULL
);
919 WideCharToMultiByte(CP_ACP
, 0, lpSrc
, -1, lpDest
, len
, NULL
, NULL
);
925 /**************************************************************************
926 * Str_GetPtrAtoW [internal]
928 * Converts a multibyte string into a unicode string
931 * lpSrc [I] Pointer to the multibyte source string
932 * lpDest [O] Pointer to caller supplied storage for the unicode string
933 * nMaxLen [I] Size, in characters, of the destination buffer
936 * Length, in characters, of the converted string.
939 INT
Str_GetPtrAtoW (LPCSTR lpSrc
, LPWSTR lpDest
, INT nMaxLen
)
943 TRACE("(%s %p %d)\n", debugstr_a(lpSrc
), lpDest
, nMaxLen
);
945 if (!lpDest
&& lpSrc
)
946 return MultiByteToWideChar(CP_ACP
, 0, lpSrc
, -1, 0, 0);
956 len
= MultiByteToWideChar(CP_ACP
, 0, lpSrc
, -1, 0, 0);
960 MultiByteToWideChar(CP_ACP
, 0, lpSrc
, -1, lpDest
, len
);
967 /**************************************************************************
968 * Str_SetPtrAtoW [internal]
970 * Converts a multi byte string to a unicode string.
971 * If the pointer to the destination buffer is NULL a buffer is allocated.
972 * If the destination buffer is too small to keep the converted multi byte
973 * string the destination buffer is reallocated. If the source pointer is
974 * NULL, the destination buffer is freed.
977 * lppDest [I/O] pointer to a pointer to the destination buffer
978 * lpSrc [I] pointer to a multi byte string
981 * TRUE: conversion successful
984 BOOL
Str_SetPtrAtoW (LPWSTR
*lppDest
, LPCSTR lpSrc
)
986 TRACE("(%p %s)\n", lppDest
, lpSrc
);
989 INT len
= MultiByteToWideChar(CP_ACP
,0,lpSrc
,-1,NULL
,0);
990 LPWSTR ptr
= ReAlloc (*lppDest
, len
*sizeof(WCHAR
));
994 MultiByteToWideChar(CP_ACP
,0,lpSrc
,-1,ptr
,len
);
1005 /**************************************************************************
1006 * Str_SetPtrWtoA [internal]
1008 * Converts a unicode string to a multi byte string.
1009 * If the pointer to the destination buffer is NULL a buffer is allocated.
1010 * If the destination buffer is too small to keep the converted wide
1011 * string the destination buffer is reallocated. If the source pointer is
1012 * NULL, the destination buffer is freed.
1015 * lppDest [I/O] pointer to a pointer to the destination buffer
1016 * lpSrc [I] pointer to a wide string
1019 * TRUE: conversion successful
1022 BOOL
Str_SetPtrWtoA (LPSTR
*lppDest
, LPCWSTR lpSrc
)
1024 TRACE("(%p %s)\n", lppDest
, debugstr_w(lpSrc
));
1027 INT len
= WideCharToMultiByte(CP_ACP
,0,lpSrc
,-1,NULL
,0,NULL
,FALSE
);
1028 LPSTR ptr
= ReAlloc (*lppDest
, len
*sizeof(CHAR
));
1032 WideCharToMultiByte(CP_ACP
,0,lpSrc
,-1,ptr
,len
,NULL
,FALSE
);
1044 /**************************************************************************
1045 * Notification functions
1048 typedef struct tagNOTIFYDATA
1056 } NOTIFYDATA
, *LPNOTIFYDATA
;
1059 /**************************************************************************
1060 * DoNotify [Internal]
1063 static LRESULT
DoNotify (const NOTIFYDATA
*lpNotify
, UINT uCode
, LPNMHDR lpHdr
)
1066 LPNMHDR lpNmh
= NULL
;
1069 TRACE("(%p %p %d %p 0x%08x)\n",
1070 lpNotify
->hwndFrom
, lpNotify
->hwndTo
, uCode
, lpHdr
,
1071 lpNotify
->dwParam5
);
1073 if (!lpNotify
->hwndTo
)
1076 if (lpNotify
->hwndFrom
== (HWND
)-1) {
1078 idFrom
= lpHdr
->idFrom
;
1081 if (lpNotify
->hwndFrom
)
1082 idFrom
= GetDlgCtrlID (lpNotify
->hwndFrom
);
1084 lpNmh
= (lpHdr
) ? lpHdr
: &nmhdr
;
1086 lpNmh
->hwndFrom
= lpNotify
->hwndFrom
;
1087 lpNmh
->idFrom
= idFrom
;
1088 lpNmh
->code
= uCode
;
1091 return SendMessageW (lpNotify
->hwndTo
, WM_NOTIFY
, idFrom
, (LPARAM
)lpNmh
);
1095 /**************************************************************************
1096 * SendNotify [COMCTL32.341]
1098 * Sends a WM_NOTIFY message to the specified window.
1101 * hwndTo [I] Window to receive the message
1102 * hwndFrom [I] Window that the message is from (see notes)
1103 * uCode [I] Notification code
1104 * lpHdr [I] The NMHDR and any additional information to send or NULL
1107 * Success: return value from notification
1111 * If hwndFrom is -1 then the identifier of the control sending the
1112 * message is taken from the NMHDR structure.
1113 * If hwndFrom is not -1 then lpHdr can be NULL.
1115 LRESULT WINAPI
SendNotify (HWND hwndTo
, HWND hwndFrom
, UINT uCode
, LPNMHDR lpHdr
)
1119 TRACE("(%p %p %d %p)\n",
1120 hwndTo
, hwndFrom
, uCode
, lpHdr
);
1122 notify
.hwndFrom
= hwndFrom
;
1123 notify
.hwndTo
= hwndTo
;
1124 notify
.dwParam5
= 0;
1125 notify
.dwParam6
= 0;
1127 return DoNotify (¬ify
, uCode
, lpHdr
);
1131 /**************************************************************************
1132 * SendNotifyEx [COMCTL32.342]
1134 * Sends a WM_NOTIFY message to the specified window.
1137 * hwndFrom [I] Window to receive the message
1138 * hwndTo [I] Window that the message is from
1139 * uCode [I] Notification code
1140 * lpHdr [I] The NMHDR and any additional information to send or NULL
1141 * dwParam5 [I] Unknown
1144 * Success: return value from notification
1148 * If hwndFrom is -1 then the identifier of the control sending the
1149 * message is taken from the NMHDR structure.
1150 * If hwndFrom is not -1 then lpHdr can be NULL.
1152 LRESULT WINAPI
SendNotifyEx (HWND hwndTo
, HWND hwndFrom
, UINT uCode
,
1153 LPNMHDR lpHdr
, DWORD dwParam5
)
1158 TRACE("(%p %p %d %p 0x%08x)\n",
1159 hwndFrom
, hwndTo
, uCode
, lpHdr
, dwParam5
);
1161 hwndNotify
= hwndTo
;
1163 if (IsWindow (hwndFrom
)) {
1164 hwndNotify
= GetParent (hwndFrom
);
1170 notify
.hwndFrom
= hwndFrom
;
1171 notify
.hwndTo
= hwndNotify
;
1172 notify
.dwParam5
= dwParam5
;
1173 notify
.dwParam6
= 0;
1175 return DoNotify (¬ify
, uCode
, lpHdr
);