Implemented InternetGetConnectedStateExA.
[wine/wine64.git] / dlls / shell32 / pidl.c
blobf7018a47fad729f43cf86107a0e8488abe325971
1 /*
2 * pidl Handling
4 * Copyright 1998 Juergen Schmied
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * NOTES
21 * a pidl == NULL means desktop and is legal
25 #include "config.h"
26 #include "wine/port.h"
28 #include <ctype.h>
29 #include <stdarg.h>
30 #include <stdlib.h>
31 #include <string.h>
33 #define COBJMACROS
34 #define NONAMELESSUNION
35 #define NONAMELESSSTRUCT
37 #include "windef.h"
38 #include "winbase.h"
39 #include "winreg.h"
40 #include "objbase.h"
41 #include "shlguid.h"
42 #include "winerror.h"
43 #include "winnls.h"
44 #include "undocshell.h"
45 #include "shell32_main.h"
46 #include "shellapi.h"
47 #include "shlwapi.h"
49 #include "pidl.h"
50 #include "debughlp.h"
51 #include "wine/debug.h"
53 WINE_DEFAULT_DEBUG_CHANNEL(pidl);
54 WINE_DECLARE_DEBUG_CHANNEL(shell);
56 /* from comctl32.dll */
57 extern LPVOID WINAPI Alloc(INT);
58 extern BOOL WINAPI Free(LPVOID);
60 /*************************************************************************
61 * ILGetDisplayNameEx [SHELL32.186]
63 * Retrieves the display name of an ItemIDList
65 * PARAMS
66 * psf [I] Shell Folder to start with, if NULL the desktop is used
67 * pidl [I] ItemIDList relativ to the psf to get the display name for
68 * path [O] Filled in with the display name, assumed to be at least MAX_PATH long
69 * type [I] Type of display name to retrieve
70 * 0 = SHGDN_FORPARSING | SHGDN_FORADDRESSBAR uses always the desktop as root
71 * 1 = SHGDN_NORMAL relative to the root folder
72 * 2 = SHGDN_INFOLDER relative to the root folder, only the last name
74 * RETURNS
75 * True if the display name could be retrieved successfully, False otherwise
77 BOOL WINAPI ILGetDisplayNameExA(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, LPSTR path, DWORD type)
79 BOOL ret = FALSE;
80 WCHAR wPath[MAX_PATH];
82 TRACE("%p %p %p %ld\n", psf, pidl, path, type);
84 if (!pidl || !path)
85 return FALSE;
87 ret = ILGetDisplayNameExW(psf, pidl, wPath, type);
88 WideCharToMultiByte(CP_ACP, 0, wPath, -1, path, MAX_PATH, NULL, NULL);
89 TRACE("%p %p %s\n", psf, pidl, debugstr_a(path));
91 return ret;
94 BOOL WINAPI ILGetDisplayNameExW(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, LPWSTR path, DWORD type)
96 LPSHELLFOLDER psfParent, lsf = psf;
97 HRESULT ret = NO_ERROR;
98 LPCITEMIDLIST pidllast;
99 STRRET strret;
100 DWORD flag;
102 TRACE("%p %p %p %ld\n", psf, pidl, path, type);
104 if (!pidl || !path)
105 return FALSE;
107 if (!lsf)
109 ret = SHGetDesktopFolder(&lsf);
110 if (FAILED(ret))
111 return FALSE;
114 if (type >= 0 && type <= 2)
116 switch (type)
118 case ILGDN_FORPARSING:
119 flag = SHGDN_FORPARSING | SHGDN_FORADDRESSBAR;
120 break;
121 case ILGDN_NORMAL:
122 flag = SHGDN_NORMAL;
123 break;
124 case ILGDN_INFOLDER:
125 flag = SHGDN_INFOLDER;
126 break;
127 default:
128 FIXME("Unknown type parameter = %lx\n", type);
129 flag = SHGDN_FORPARSING | SHGDN_FORADDRESSBAR;
130 break;
132 if (!*(LPWORD)pidl || type == ILGDN_FORPARSING)
134 ret = IShellFolder_GetDisplayNameOf(lsf, pidl, flag, &strret);
135 if (SUCCEEDED(ret))
137 ret = StrRetToStrNW(path, MAX_PATH, &strret, pidl);
140 else
142 ret = SHBindToParent(pidl, &IID_IShellFolder, (LPVOID*)&psfParent, &pidllast);
143 if (SUCCEEDED(ret))
145 ret = IShellFolder_GetDisplayNameOf(psfParent, pidllast, flag, &strret);
146 if (SUCCEEDED(ret))
148 ret = StrRetToStrNW(path, MAX_PATH, &strret, pidllast);
150 IShellFolder_Release(psfParent);
155 TRACE("%p %p %s\n", psf, pidl, debugstr_w(path));
157 if (!psf)
158 IShellFolder_Release(lsf);
159 return SUCCEEDED(ret);
162 BOOL WINAPI ILGetDisplayNameEx(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, LPVOID path, DWORD type)
164 TRACE_(shell)("%p %p %p %ld\n", psf, pidl, path, type);
165 if (SHELL_OsIsUnicode())
166 return ILGetDisplayNameExW(psf, pidl, path, type);
167 return ILGetDisplayNameExA(psf, pidl, path, type);
170 /*************************************************************************
171 * ILGetDisplayName [SHELL32.15]
173 BOOL WINAPI ILGetDisplayName(LPCITEMIDLIST pidl, LPVOID path)
175 TRACE_(shell)("%p %p\n", pidl, path);
176 if (SHELL_OsIsUnicode())
177 return ILGetDisplayNameExW(NULL, pidl, path, ILGDN_FORPARSING);
178 return ILGetDisplayNameExA(NULL, pidl, path, ILGDN_FORPARSING);
181 /*************************************************************************
182 * ILFindLastID [SHELL32.16]
184 * NOTES
185 * observed: pidl=Desktop return=pidl
187 LPITEMIDLIST WINAPI ILFindLastID(LPCITEMIDLIST pidl)
189 LPCITEMIDLIST pidlLast = pidl;
191 TRACE("(pidl=%p)\n",pidl);
193 if (!pidl)
194 return NULL;
196 while (pidl->mkid.cb)
198 pidlLast = pidl;
199 pidl = ILGetNext(pidl);
201 return (LPITEMIDLIST)pidlLast;
203 /*************************************************************************
204 * ILRemoveLastID [SHELL32.17]
206 * NOTES
207 * when pidl=Desktop return=FALSE
209 BOOL WINAPI ILRemoveLastID(LPITEMIDLIST pidl)
211 TRACE_(shell)("pidl=%p\n",pidl);
213 if (!pidl || !pidl->mkid.cb)
214 return 0;
215 ILFindLastID(pidl)->mkid.cb = 0;
216 return 1;
219 /*************************************************************************
220 * ILClone [SHELL32.18]
222 * NOTES
223 * duplicate an idlist
225 LPITEMIDLIST WINAPI ILClone (LPCITEMIDLIST pidl)
226 { DWORD len;
227 LPITEMIDLIST newpidl;
229 if (!pidl)
230 return NULL;
232 len = ILGetSize(pidl);
233 newpidl = (LPITEMIDLIST)SHAlloc(len);
234 if (newpidl)
235 memcpy(newpidl,pidl,len);
237 TRACE("pidl=%p newpidl=%p\n",pidl, newpidl);
238 pdump(pidl);
240 return newpidl;
242 /*************************************************************************
243 * ILCloneFirst [SHELL32.19]
245 * NOTES
246 * duplicates the first idlist of a complex pidl
248 LPITEMIDLIST WINAPI ILCloneFirst(LPCITEMIDLIST pidl)
249 { DWORD len;
250 LPITEMIDLIST pidlNew = NULL;
252 TRACE("pidl=%p \n",pidl);
253 pdump(pidl);
255 if (pidl)
257 len = pidl->mkid.cb;
258 pidlNew = (LPITEMIDLIST) SHAlloc (len+2);
259 if (pidlNew)
261 memcpy(pidlNew,pidl,len+2); /* 2 -> mind a desktop pidl */
263 if (len)
264 ILGetNext(pidlNew)->mkid.cb = 0x00;
267 TRACE("-- newpidl=%p\n",pidlNew);
269 return pidlNew;
272 /*************************************************************************
273 * ILLoadFromStream (SHELL32.26)
275 * NOTES
276 * the first two bytes are the len, the pidl is following then
278 HRESULT WINAPI ILLoadFromStream (IStream * pStream, LPITEMIDLIST * ppPidl)
279 { WORD wLen = 0;
280 DWORD dwBytesRead;
281 HRESULT ret = E_FAIL;
284 TRACE_(shell)("%p %p\n", pStream , ppPidl);
286 if (*ppPidl)
287 { SHFree(*ppPidl);
288 *ppPidl = NULL;
291 IStream_AddRef (pStream);
293 if (SUCCEEDED(IStream_Read(pStream, (LPVOID)&wLen, 2, &dwBytesRead)))
295 TRACE("PIDL length is %d\n", wLen);
296 if (wLen != 0) {
297 *ppPidl = SHAlloc (wLen);
298 if (SUCCEEDED(IStream_Read(pStream, *ppPidl , wLen, &dwBytesRead))) {
299 TRACE("Stream read OK\n");
300 ret = S_OK;
301 } else {
302 WARN("reading pidl failed\n");
303 SHFree(*ppPidl);
304 *ppPidl = NULL;
306 } else {
307 *ppPidl = NULL;
308 ret = S_OK;
312 /* we are not yet fully compatible */
313 if (*ppPidl && !pcheck(*ppPidl))
315 WARN("Check failed\n");
316 SHFree(*ppPidl);
317 *ppPidl = NULL;
321 IStream_Release (pStream);
322 TRACE("done\n");
323 return ret;
326 /*************************************************************************
327 * ILSaveToStream (SHELL32.27)
329 * NOTES
330 * the first two bytes are the len, the pidl is following then
332 HRESULT WINAPI ILSaveToStream (IStream * pStream, LPCITEMIDLIST pPidl)
334 LPCITEMIDLIST pidl;
335 WORD wLen = 0;
336 HRESULT ret = E_FAIL;
338 TRACE_(shell)("%p %p\n", pStream, pPidl);
340 IStream_AddRef (pStream);
342 pidl = pPidl;
343 while (pidl->mkid.cb)
345 wLen += sizeof(WORD) + pidl->mkid.cb;
346 pidl = ILGetNext(pidl);
349 if (SUCCEEDED(IStream_Write(pStream, (LPVOID)&wLen, 2, NULL)))
351 if (SUCCEEDED(IStream_Write(pStream, pPidl, wLen, NULL)))
352 { ret = S_OK;
355 IStream_Release (pStream);
357 return ret;
360 /*************************************************************************
361 * SHILCreateFromPath [SHELL32.28]
363 * Create an ItemIDList from a path
365 * PARAMS
366 * path [I]
367 * ppidl [O]
368 * attributes [I/O] requested attributes on call and actual attributes when
369 * the function returns
371 * RETURNS
372 * NO_ERROR if successful, or an OLE errer code otherwise
374 * NOTES
375 * Wrapper for IShellFolder_ParseDisplayName().
377 HRESULT WINAPI SHILCreateFromPathA(LPCSTR path, LPITEMIDLIST * ppidl, DWORD * attributes)
379 LPSHELLFOLDER sf;
380 WCHAR lpszDisplayName[MAX_PATH];
381 DWORD pchEaten;
382 HRESULT ret = E_FAIL;
384 TRACE_(shell)("%s %p 0x%08lx\n", path, ppidl, attributes ? *attributes : 0);
386 if (!MultiByteToWideChar(CP_ACP, 0, path, -1, lpszDisplayName, MAX_PATH))
387 lpszDisplayName[MAX_PATH-1] = 0;
389 if (SUCCEEDED (SHGetDesktopFolder(&sf)))
391 ret = IShellFolder_ParseDisplayName(sf, 0, NULL, lpszDisplayName, &pchEaten, ppidl, attributes);
392 IShellFolder_Release(sf);
394 return ret;
397 HRESULT WINAPI SHILCreateFromPathW(LPCWSTR path, LPITEMIDLIST * ppidl, DWORD * attributes)
399 LPSHELLFOLDER sf;
400 DWORD pchEaten;
401 HRESULT ret = E_FAIL;
403 TRACE_(shell)("%s %p 0x%08lx\n", debugstr_w(path), ppidl, attributes ? *attributes : 0);
405 if (SUCCEEDED (SHGetDesktopFolder(&sf)))
407 ret = IShellFolder_ParseDisplayName(sf, 0, NULL, (LPWSTR)path, &pchEaten, ppidl, attributes);
408 IShellFolder_Release(sf);
410 return ret;
413 HRESULT WINAPI SHILCreateFromPathAW (LPCVOID path, LPITEMIDLIST * ppidl, DWORD * attributes)
415 if ( SHELL_OsIsUnicode())
416 return SHILCreateFromPathW (path, ppidl, attributes);
417 return SHILCreateFromPathA (path, ppidl, attributes);
420 /*************************************************************************
421 * SHCloneSpecialIDList [SHELL32.89]
423 * Create an ItemIDList to one of the special folders.
425 * PARAMS
426 * hwndOwner [in]
427 * nFolder [in] CSIDL_xxxxx
428 * fCreate [in] Create folder if it does not exist
430 * RETURNS
431 * Success: The newly created pidl
432 * Failure: NULL, if inputs are invalid.
434 * NOTES
435 * exported by ordinal.
436 * Caller is responsible for deallocating the returned ItemIDList with the
437 * shells IMalloc interface, aka ILFree.
439 LPITEMIDLIST WINAPI SHCloneSpecialIDList(HWND hwndOwner, DWORD nFolder, BOOL fCreate)
440 { LPITEMIDLIST ppidl;
441 TRACE_(shell)("(hwnd=%p,csidl=0x%lx,%s).\n", hwndOwner, nFolder, fCreate ? "T" : "F");
443 if (fCreate)
444 nFolder |= CSIDL_FLAG_CREATE;
446 SHGetSpecialFolderLocation(hwndOwner, nFolder, &ppidl);
447 return ppidl;
450 /*************************************************************************
451 * ILGlobalClone [SHELL32.20]
453 * Clones an ItemIDList using Alloc.
455 * PARAMS
456 * pidl [I] ItemIDList to clone
458 * RETURNS
459 * Newly allocated ItemIDList.
461 * NOTES
462 * exported by ordinal.
464 LPITEMIDLIST WINAPI ILGlobalClone(LPCITEMIDLIST pidl)
465 { DWORD len;
466 LPITEMIDLIST newpidl;
468 if (!pidl)
469 return NULL;
471 len = ILGetSize(pidl);
472 newpidl = (LPITEMIDLIST)Alloc(len);
473 if (newpidl)
474 memcpy(newpidl,pidl,len);
476 TRACE("pidl=%p newpidl=%p\n",pidl, newpidl);
477 pdump(pidl);
479 return newpidl;
482 /*************************************************************************
483 * ILIsEqual [SHELL32.21]
486 BOOL WINAPI ILIsEqual(LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
488 char szData1[MAX_PATH];
489 char szData2[MAX_PATH];
491 LPCITEMIDLIST pidltemp1 = pidl1;
492 LPCITEMIDLIST pidltemp2 = pidl2;
494 TRACE("pidl1=%p pidl2=%p\n",pidl1, pidl2);
496 /* explorer reads from registry directly (StreamMRU),
497 so we can only check here */
498 if ((!pcheck (pidl1)) || (!pcheck (pidl2))) return FALSE;
500 pdump (pidl1);
501 pdump (pidl2);
503 if ( (!pidl1) || (!pidl2) ) return FALSE;
505 while (pidltemp1->mkid.cb && pidltemp2->mkid.cb)
507 _ILSimpleGetText(pidltemp1, szData1, MAX_PATH);
508 _ILSimpleGetText(pidltemp2, szData2, MAX_PATH);
510 if (strcasecmp ( szData1, szData2 )!=0 )
511 return FALSE;
513 pidltemp1 = ILGetNext(pidltemp1);
514 pidltemp2 = ILGetNext(pidltemp2);
517 if (!pidltemp1->mkid.cb && !pidltemp2->mkid.cb)
519 return TRUE;
522 return FALSE;
524 /*************************************************************************
525 * ILIsParent [SHELL32.23]
527 * Verifies that pidlParent is indeed the (immediate) parent of pidlChild.
529 * PARAMS
530 * pidlParent [I]
531 * pidlChild [I]
532 * bImmediate [I] only return true if the parent is the direct parent
533 * of the child
535 * RETURNS
536 * True if the parent ItemIDlist is a complete part of the child ItemIdList,
537 * False otherwise.
539 * NOTES
540 * parent = a/b, child = a/b/c -> true, c is in folder a/b
541 * child = a/b/c/d -> false if bImmediate is true, d is not in folder a/b
542 * child = a/b/c/d -> true if bImmediate is false, d is in a subfolder of a/b
544 BOOL WINAPI ILIsParent(LPCITEMIDLIST pidlParent, LPCITEMIDLIST pidlChild, BOOL bImmediate)
546 char szData1[MAX_PATH];
547 char szData2[MAX_PATH];
549 LPCITEMIDLIST pParent = pidlParent;
550 LPCITEMIDLIST pChild = pidlChild;
552 TRACE("%p %p %x\n", pidlParent, pidlChild, bImmediate);
554 if (!pParent || !pChild) return FALSE;
556 while (pParent->mkid.cb && pChild->mkid.cb)
558 _ILSimpleGetText(pParent, szData1, MAX_PATH);
559 _ILSimpleGetText(pChild, szData2, MAX_PATH);
561 if (strcasecmp ( szData1, szData2 )!=0 )
562 return FALSE;
564 pParent = ILGetNext(pParent);
565 pChild = ILGetNext(pChild);
568 if ( pParent->mkid.cb || ! pChild->mkid.cb) /* child shorter or has equal length to parent */
569 return FALSE;
571 if ( ILGetNext(pChild)->mkid.cb && bImmediate) /* not immediate descent */
572 return FALSE;
574 return TRUE;
577 /*************************************************************************
578 * ILFindChild [SHELL32.24]
580 * Compares elements from pidl1 and pidl2.
582 * PARAMS
583 * pidl1 [I]
584 * pidl2 [I]
586 * RETURNS
587 * pidl1 is desktop pidl2
588 * pidl1 shorter pidl2 pointer to first different element of pidl2
589 * if there was at least one equal element
590 * pidl2 shorter pidl1 0
591 * pidl2 equal pidl1 pointer to last 0x00-element of pidl2
593 * NOTES
594 * exported by ordinal.
596 LPITEMIDLIST WINAPI ILFindChild(LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
598 char szData1[MAX_PATH];
599 char szData2[MAX_PATH];
601 LPCITEMIDLIST pidltemp1 = pidl1;
602 LPCITEMIDLIST pidltemp2 = pidl2;
603 LPCITEMIDLIST ret=NULL;
605 TRACE("pidl1=%p pidl2=%p\n",pidl1, pidl2);
607 /* explorer reads from registry directly (StreamMRU),
608 so we can only check here */
609 if ((!pcheck (pidl1)) || (!pcheck (pidl2)))
610 return FALSE;
612 pdump (pidl1);
613 pdump (pidl2);
615 if ( _ILIsDesktop(pidl1) )
617 ret = pidl2;
619 else
621 while (pidltemp1->mkid.cb && pidltemp2->mkid.cb)
623 _ILSimpleGetText(pidltemp1, szData1, MAX_PATH);
624 _ILSimpleGetText(pidltemp2, szData2, MAX_PATH);
626 if (strcasecmp(szData1,szData2))
627 break;
629 pidltemp1 = ILGetNext(pidltemp1);
630 pidltemp2 = ILGetNext(pidltemp2);
631 ret = pidltemp2;
634 if (pidltemp1->mkid.cb)
636 ret = NULL; /* elements of pidl1 left*/
639 TRACE_(shell)("--- %p\n", ret);
640 return (LPITEMIDLIST)ret; /* pidl 1 is shorter */
643 /*************************************************************************
644 * ILCombine [SHELL32.25]
646 * Concatenates two complex ItemIDLists.
648 * PARAMS
649 * pidl1 [I] first complex ItemIDLists
650 * pidl2 [I] complex ItemIDLists to append
652 * RETURNS
653 * if both pidl's == NULL NULL
654 * if pidl1 == NULL cloned pidl2
655 * if pidl2 == NULL cloned pidl1
656 * otherwise new pidl with pidl2 appended to pidl1
658 * NOTES
659 * exported by ordinal.
660 * Does not destroy the passed in ItemIDLists!
662 LPITEMIDLIST WINAPI ILCombine(LPCITEMIDLIST pidl1, LPCITEMIDLIST pidl2)
664 DWORD len1,len2;
665 LPITEMIDLIST pidlNew;
667 TRACE("pidl=%p pidl=%p\n",pidl1,pidl2);
669 if(!pidl1 && !pidl2) return NULL;
671 pdump (pidl1);
672 pdump (pidl2);
674 if(!pidl1)
676 pidlNew = ILClone(pidl2);
677 return pidlNew;
680 if(!pidl2)
682 pidlNew = ILClone(pidl1);
683 return pidlNew;
686 len1 = ILGetSize(pidl1)-2;
687 len2 = ILGetSize(pidl2);
688 pidlNew = SHAlloc(len1+len2);
690 if (pidlNew)
692 memcpy(pidlNew,pidl1,len1);
693 memcpy(((BYTE *)pidlNew)+len1,pidl2,len2);
696 /* TRACE(pidl,"--new pidl=%p\n",pidlNew);*/
697 return pidlNew;
700 /*************************************************************************
701 * SHGetRealIDL [SHELL32.98]
703 * NOTES
705 HRESULT WINAPI SHGetRealIDL(LPSHELLFOLDER lpsf, LPCITEMIDLIST pidlSimple, LPITEMIDLIST *pidlReal)
707 IDataObject* pDataObj;
708 HRESULT hr = IShellFolder_GetUIObjectOf(lpsf, 0, 1, &pidlSimple, &IID_IDataObject, 0, (LPVOID*)&pDataObj);
710 if (SUCCEEDED(hr)) {
711 STGMEDIUM medium;
712 FORMATETC fmt;
714 fmt.cfFormat = RegisterClipboardFormatA(CFSTR_SHELLIDLIST);
715 fmt.ptd = NULL;
716 fmt.dwAspect = DVASPECT_CONTENT;
717 fmt.lindex = -1;
718 fmt.tymed = TYMED_HGLOBAL;
720 hr = IDataObject_GetData(pDataObj, &fmt, &medium);
722 IDataObject_Release(pDataObj);
724 if (SUCCEEDED(hr)) {
725 /*assert(pida->cidl==1);*/
726 LPIDA pida = (LPIDA)GlobalLock(medium.u.hGlobal);
728 LPCITEMIDLIST pidl_folder = (LPCITEMIDLIST) ((LPBYTE)pida+pida->aoffset[0]);
729 LPCITEMIDLIST pidl_child = (LPCITEMIDLIST) ((LPBYTE)pida+pida->aoffset[1]);
731 *pidlReal = ILCombine(pidl_folder, pidl_child);
733 if (!*pidlReal)
734 hr = E_OUTOFMEMORY;
736 GlobalUnlock(medium.u.hGlobal);
737 GlobalFree(medium.u.hGlobal);
741 return hr;
744 /*************************************************************************
745 * SHLogILFromFSIL [SHELL32.95]
747 * NOTES
748 * pild = CSIDL_DESKTOP ret = 0
749 * pild = CSIDL_DRIVES ret = 0
751 LPITEMIDLIST WINAPI SHLogILFromFSIL(LPITEMIDLIST pidl)
753 FIXME("(pidl=%p)\n",pidl);
755 pdump(pidl);
757 return 0;
760 /*************************************************************************
761 * ILGetSize [SHELL32.152]
763 * Gets the byte size of an ItemIDList including zero terminator
765 * PARAMS
766 * pidl [I] ItemIDList
768 * RETURNS
769 * size of pidl in bytes
771 * NOTES
772 * exported by ordinal
774 UINT WINAPI ILGetSize(LPCITEMIDLIST pidl)
776 LPCSHITEMID si = &(pidl->mkid);
777 UINT len=0;
779 if (pidl)
780 { while (si->cb)
781 { len += si->cb;
782 si = (LPSHITEMID)(((LPBYTE)si)+si->cb);
784 len += 2;
786 TRACE("pidl=%p size=%u\n",pidl, len);
787 return len;
790 /*************************************************************************
791 * ILGetNext [SHELL32.153]
793 * Gets the next ItemID of an ItemIDList
795 * PARAMS
796 * pidl [I] ItemIDList
798 * RETURNS
799 * null -> null
800 * desktop -> null
801 * simple pidl -> pointer to 0x0000 element
803 * NOTES
804 * exported by ordinal.
806 LPITEMIDLIST WINAPI ILGetNext(LPCITEMIDLIST pidl)
808 WORD len;
810 TRACE("%p\n", pidl);
812 if(pidl)
814 len = pidl->mkid.cb;
815 if (len)
817 pidl = (LPITEMIDLIST) (((LPBYTE)pidl)+len);
818 TRACE("-- %p\n", pidl);
819 return (LPITEMIDLIST)pidl;
822 return NULL;
825 /*************************************************************************
826 * ILAppend [SHELL32.154]
828 * Adds the single ItemID item to the ItemIDList indicated by pidl.
829 * If bEnd is FALSE, inserts the item in the front of the list,
830 * otherwise it adds the item to the end. (???)
832 * PARAMS
833 * pidl [I] ItemIDList to extend
834 * item [I] ItemID to prepend/append
835 * bEnd [I] Indicates if the item should be appended
837 * NOTES
838 * Destroys the passed in idlist! (???)
840 LPITEMIDLIST WINAPI ILAppend(LPITEMIDLIST pidl, LPCITEMIDLIST item, BOOL bEnd)
842 LPITEMIDLIST idlRet;
844 WARN("(pidl=%p,pidl=%p,%08u)semi-stub\n",pidl,item,bEnd);
846 pdump (pidl);
847 pdump (item);
849 if (_ILIsDesktop(pidl))
851 idlRet = ILClone(item);
852 if (pidl)
853 SHFree (pidl);
854 return idlRet;
857 if (bEnd)
859 idlRet = ILCombine(pidl, item);
861 else
863 idlRet = ILCombine(item, pidl);
866 SHFree(pidl);
867 return idlRet;
870 /*************************************************************************
871 * ILFree [SHELL32.155]
873 * Frees memory (if not NULL) allocated by SHMalloc allocator
875 * PARAMS
876 * pidl [I]
878 * NOTES
879 * exported by ordinal
881 void WINAPI ILFree(LPITEMIDLIST pidl)
883 TRACE("(pidl=%p)\n",pidl);
884 if(pidl) SHFree(pidl);
887 /*************************************************************************
888 * ILGlobalFree [SHELL32.156]
890 * Frees memory (if not NULL) allocated by Alloc allocator
892 * PARAMS
893 * pidl [I]
895 * NOTES
896 * exported by ordinal.
898 void WINAPI ILGlobalFree( LPITEMIDLIST pidl)
900 TRACE("%p\n", pidl);
902 if(!pidl) return;
903 Free(pidl);
906 /*************************************************************************
907 * ILCreateFromPathA [SHELL32.189]
909 * Creates a complex ItemIDList from a path and returns it.
911 * PARAMS
912 * path [I]
914 * RETURNS
915 * the newly created complex ItemIDList or NULL if failed
917 * NOTES
918 * exported by ordinal.
921 LPITEMIDLIST WINAPI ILCreateFromPathA (LPCSTR path)
923 LPITEMIDLIST pidlnew = NULL;
925 TRACE_(shell)("%s\n", debugstr_a(path));
927 if (SUCCEEDED(SHILCreateFromPathA(path, &pidlnew, NULL)))
928 return pidlnew;
929 return NULL;
932 /*************************************************************************
933 * ILCreateFromPathW [SHELL32.190]
935 LPITEMIDLIST WINAPI ILCreateFromPathW (LPCWSTR path)
937 LPITEMIDLIST pidlnew = NULL;
939 TRACE_(shell)("%s\n", debugstr_w(path));
941 if (SUCCEEDED(SHILCreateFromPathW(path, &pidlnew, NULL)))
942 return pidlnew;
943 return NULL;
946 /*************************************************************************
947 * ILCreateFromPath [SHELL32.157]
949 LPITEMIDLIST WINAPI ILCreateFromPathAW (LPCVOID path)
951 if ( SHELL_OsIsUnicode())
952 return ILCreateFromPathW (path);
953 return ILCreateFromPathA (path);
956 /*************************************************************************
957 * _ILParsePathW [internal]
959 * Creates an ItemIDList from a path and returns it.
961 * PARAMS
962 * path [I] path to parse and convert into an ItemIDList
963 * lpFindFile [I] pointer to buffer to initialize the FileSystem
964 * Bind Data object with
965 * bBindCtx [I] indicates to create a BindContext and assign a
966 * FileSystem Bind Data object
967 * ppidl [O] the newly create ItemIDList
968 * prgfInOut [I/O] requested attributes on input and actual
969 * attributes on return
971 * RETURNS
972 * NO_ERROR on success or an OLE error code
974 * NOTES
975 * If either lpFindFile is non-NULL or bBindCtx is TRUE, this function
976 * creates a BindContext object and assigns a FileSystem Bind Data object
977 * to it, passing the BindContext to IShellFolder_ParseDisplayName. Each
978 * IShellFolder uses that FileSystem Bind Data object of the BindContext
979 * to pass data about the current path element to the next object. This
980 * is used to avoid having to verify the current path element on disk, so
981 * that creating an ItemIDList from a non-existent path still can work.
983 static HRESULT WINAPI _ILParsePathW(LPCWSTR path, LPWIN32_FIND_DATAW lpFindFile,
984 BOOL bBindCtx, LPITEMIDLIST *ppidl, LPDWORD prgfInOut)
986 LPSHELLFOLDER pSF = NULL;
987 LPBC pBC = NULL;
988 HRESULT ret;
990 TRACE("%s %p %d (%p)->%p (%p)->0x%lx\n", debugstr_w(path), lpFindFile, bBindCtx,
991 ppidl, ppidl ? *ppidl : NULL,
992 prgfInOut, prgfInOut ? *prgfInOut : 0);
994 ret = SHGetDesktopFolder(&pSF);
995 if (FAILED(ret))
997 return ret;
1000 if (lpFindFile || bBindCtx)
1001 ret = IFileSystemBindData_Constructor(lpFindFile, &pBC);
1003 if (SUCCEEDED(ret))
1005 ret = IShellFolder_ParseDisplayName(pSF, 0, pBC, (LPOLESTR)path, NULL, ppidl, prgfInOut);
1008 if (pBC)
1010 IBindCtx_Release(pBC);
1011 pBC = NULL;
1014 IShellFolder_Release(pSF);
1016 if (!SUCCEEDED(ret) && ppidl)
1017 *ppidl = NULL;
1019 TRACE("%s %p 0x%lx\n", debugstr_w(path), ppidl ? *ppidl : NULL, prgfInOut ? *prgfInOut : 0);
1021 return ret;
1024 /*************************************************************************
1025 * SHSimpleIDListFromPath [SHELL32.162]
1027 * Creates a simple ItemIDList from a path and returns it. This function
1028 * does not fail on non-existent paths.
1030 * PARAMS
1031 * path [I] path to parse and convert into an ItemIDList
1033 * RETURNS
1034 * the newly created simple ItemIDList
1036 * NOTES
1037 * Simple in the name does not mean a relative ItemIDList but rather a
1038 * fully qualified list, where only the file name is filled in and the
1039 * directory flag for those ItemID elements this is known about, eg.
1040 * it is not the last element in the ItemIDList or the actual directory
1041 * exists on disk.
1042 * exported by ordinal.
1044 LPITEMIDLIST WINAPI SHSimpleIDListFromPathA(LPCSTR lpszPath)
1046 LPITEMIDLIST pidl = NULL;
1047 LPWSTR wPath = NULL;
1048 int len;
1050 TRACE("%s\n", debugstr_a(lpszPath));
1052 if (lpszPath)
1054 len = MultiByteToWideChar(CP_ACP, 0, lpszPath, -1, NULL, 0);
1055 wPath = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
1056 MultiByteToWideChar(CP_ACP, 0, lpszPath, -1, wPath, len);
1059 _ILParsePathW(wPath, NULL, TRUE, &pidl, NULL);
1061 if (wPath) HeapFree(GetProcessHeap(), 0, wPath);
1062 TRACE("%s %p\n", debugstr_a(lpszPath), pidl);
1063 return pidl;
1066 LPITEMIDLIST WINAPI SHSimpleIDListFromPathW(LPCWSTR lpszPath)
1068 LPITEMIDLIST pidl = NULL;
1070 TRACE("%s\n", debugstr_w(lpszPath));
1072 _ILParsePathW(lpszPath, NULL, TRUE, &pidl, NULL);
1073 TRACE("%s %p\n", debugstr_w(lpszPath), pidl);
1074 return pidl;
1077 LPITEMIDLIST WINAPI SHSimpleIDListFromPathAW(LPCVOID lpszPath)
1079 if ( SHELL_OsIsUnicode())
1080 return SHSimpleIDListFromPathW (lpszPath);
1081 return SHSimpleIDListFromPathA (lpszPath);
1084 /*************************************************************************
1085 * SHGetDataFromIDListA [SHELL32.247]
1087 * NOTES
1088 * the pidl can be a simple one. since we can't get the path out of the pidl
1089 * we have to take all data from the pidl
1091 HRESULT WINAPI SHGetDataFromIDListA(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, int nFormat, LPVOID dest, int len)
1093 TRACE_(shell)("sf=%p pidl=%p 0x%04x %p 0x%04x stub\n",psf,pidl,nFormat,dest,len);
1095 pdump(pidl);
1096 if (!psf || !dest ) return E_INVALIDARG;
1098 switch (nFormat)
1100 case SHGDFIL_FINDDATA:
1102 LPSTR filename, shortname;
1103 WIN32_FIND_DATAA * pfd = dest;
1105 if (_ILIsDrive(pidl))
1106 return E_INVALIDARG;
1108 if (len < (int)sizeof(WIN32_FIND_DATAA)) return E_INVALIDARG;
1110 ZeroMemory(pfd, sizeof (WIN32_FIND_DATAA));
1111 _ILGetFileDateTime( pidl, &(pfd->ftLastWriteTime));
1112 pfd->dwFileAttributes = _ILGetFileAttributes(pidl, NULL, 0);
1113 pfd->nFileSizeLow = _ILGetFileSize ( pidl, NULL, 0);
1115 filename = _ILGetTextPointer(pidl);
1116 shortname = _ILGetSTextPointer(pidl);
1118 if (filename)
1119 lstrcpynA(pfd->cFileName, filename, MAX_PATH);
1120 else
1121 pfd->cFileName[0] = '\0';
1123 if (shortname)
1124 lstrcpynA(pfd->cAlternateFileName, shortname, MAX_PATH);
1125 else
1126 pfd->cAlternateFileName[0] = '\0';
1128 return NOERROR;
1130 case SHGDFIL_NETRESOURCE:
1131 case SHGDFIL_DESCRIPTIONID:
1132 FIXME_(shell)("SHGDFIL %i stub\n", nFormat);
1133 break;
1135 default:
1136 ERR_(shell)("Unknown SHGDFIL %i, please report\n", nFormat);
1139 return E_INVALIDARG;
1142 /*************************************************************************
1143 * SHGetDataFromIDListW [SHELL32.248]
1146 HRESULT WINAPI SHGetDataFromIDListW(LPSHELLFOLDER psf, LPCITEMIDLIST pidl, int nFormat, LPVOID dest, int len)
1148 TRACE_(shell)("sf=%p pidl=%p 0x%04x %p 0x%04x stub\n",psf,pidl,nFormat,dest,len);
1150 pdump(pidl);
1152 if (! psf || !dest ) return E_INVALIDARG;
1154 switch (nFormat)
1156 case SHGDFIL_FINDDATA:
1158 LPSTR filename, shortname;
1159 WIN32_FIND_DATAW * pfd = dest;
1161 if (_ILIsDrive(pidl))
1162 return E_INVALIDARG;
1164 if (len < (int)sizeof(WIN32_FIND_DATAW)) return E_INVALIDARG;
1166 ZeroMemory(pfd, sizeof (WIN32_FIND_DATAA));
1167 _ILGetFileDateTime( pidl, &(pfd->ftLastWriteTime));
1168 pfd->dwFileAttributes = _ILGetFileAttributes(pidl, NULL, 0);
1169 pfd->nFileSizeLow = _ILGetFileSize ( pidl, NULL, 0);
1171 filename = _ILGetTextPointer(pidl);
1172 shortname = _ILGetSTextPointer(pidl);
1174 if (!filename)
1175 pfd->cFileName[0] = '\0';
1176 else if (!MultiByteToWideChar(CP_ACP, 0, filename, -1, pfd->cFileName, MAX_PATH))
1177 pfd->cFileName[MAX_PATH-1] = 0;
1179 if (!shortname)
1180 pfd->cAlternateFileName[0] = '\0';
1181 else if (!MultiByteToWideChar(CP_ACP, 0, shortname, -1, pfd->cAlternateFileName, 14))
1182 pfd->cAlternateFileName[13] = 0;
1184 return NOERROR;
1185 case SHGDFIL_NETRESOURCE:
1186 case SHGDFIL_DESCRIPTIONID:
1187 FIXME_(shell)("SHGDFIL %i stub\n", nFormat);
1188 break;
1190 default:
1191 ERR_(shell)("Unknown SHGDFIL %i, please report\n", nFormat);
1194 return E_INVALIDARG;
1197 /*************************************************************************
1198 * SHELL_GetPathFromIDListA
1200 HRESULT SHELL_GetPathFromIDListA(LPCITEMIDLIST pidl, LPSTR pszPath, UINT uOutSize)
1202 HRESULT hr = S_OK;
1204 pszPath[0]=0;
1206 /* One case is a PIDL rooted at desktop level */
1207 if (_ILIsValue(pidl) || _ILIsFolder(pidl)) {
1208 hr = SHGetSpecialFolderPathA(0, pszPath, CSIDL_DESKTOP, FALSE);
1210 if (SUCCEEDED(hr))
1211 PathAddBackslashA(pszPath);
1213 /* The only other valid case is a item ID list beginning at "My Computer" */
1214 else if (_ILIsMyComputer(pidl))
1215 pidl = ILGetNext(pidl);
1217 if (SUCCEEDED(hr)) {
1218 LPSTR txt;
1220 while(pidl && pidl->mkid.cb) {
1221 if (_ILIsSpecialFolder(pidl))
1222 {hr = E_INVALIDARG; break;}
1224 txt = _ILGetTextPointer(pidl);
1225 if (!txt)
1226 {hr = E_INVALIDARG; break;}
1228 if (lstrlenA(txt) > pidl->mkid.cb)
1229 ERR("pidl %p is borked\n",pidl);
1231 /* make sure there's enough space for the next segment */
1232 if ( (lstrlenA(txt) + lstrlenA(pszPath)) > uOutSize)
1233 {hr = E_INVALIDARG; break;}
1234 lstrcatA( pszPath, txt );
1236 pidl = ILGetNext(pidl);
1237 if (!pidl)
1238 {hr = E_INVALIDARG; break;}
1240 if (!pidl->mkid.cb) {
1241 /* We are at the end and successfully converted the complete PIDL. */
1242 break;
1245 if( (lstrlenA(pszPath) + 1) > uOutSize)
1246 {hr = E_INVALIDARG; break;}
1247 if (!PathAddBackslashA(pszPath))
1248 {hr = E_INVALIDARG; break;}
1250 } else
1251 hr = E_INVALIDARG;
1253 TRACE_(shell)("-- %s, 0x%08lx\n", pszPath, hr);
1254 return hr;
1257 /*************************************************************************
1258 * SHGetPathFromIDListA [SHELL32.@][NT 4.0: SHELL32.220]
1260 * PARAMETERS
1261 * pidl, [IN] pidl
1262 * pszPath [OUT] path
1264 * RETURNS
1265 * path from a passed PIDL.
1267 * NOTES
1268 * NULL returns FALSE
1269 * desktop pidl gives path to desktop directory back
1270 * special pidls returning FALSE
1272 BOOL WINAPI SHGetPathFromIDListA(LPCITEMIDLIST pidl, LPSTR pszPath)
1274 HRESULT hr;
1276 TRACE_(shell)("(pidl=%p,%p)\n",pidl,pszPath);
1277 pdump(pidl);
1279 if (!pidl)
1280 return FALSE;
1282 hr = SHELL_GetPathFromIDListA(pidl, pszPath, MAX_PATH);
1284 return SUCCEEDED(hr);
1287 /*************************************************************************
1288 * SHELL_GetPathFromIDListW
1290 HRESULT SHELL_GetPathFromIDListW(LPCITEMIDLIST pidl, LPWSTR pszPath, UINT uOutSize)
1292 HRESULT hr = S_OK;
1293 UINT len;
1295 pszPath[0]=0;
1297 /* One case is a PIDL rooted at desktop level */
1298 if (_ILIsValue(pidl) || _ILIsFolder(pidl)) {
1299 hr = SHGetSpecialFolderPathW(0, pszPath, CSIDL_DESKTOP, FALSE);
1301 if (SUCCEEDED(hr))
1302 PathAddBackslashW(pszPath);
1304 /* The only other valid case is a item ID list beginning at "My Computer" */
1305 else if (_ILIsMyComputer(pidl))
1306 pidl = ILGetNext(pidl);
1308 if (SUCCEEDED(hr)) {
1309 LPSTR txt;
1311 while(pidl && pidl->mkid.cb) {
1312 if (_ILIsSpecialFolder(pidl))
1313 {hr = E_INVALIDARG; break;}
1315 txt = _ILGetTextPointer(pidl);
1316 if (!txt)
1317 {hr = E_INVALIDARG; break;}
1319 if (lstrlenA(txt) > pidl->mkid.cb)
1320 ERR("pidl %p is borked\n",pidl);
1321 len = MultiByteToWideChar(CP_ACP, 0, txt, -1, NULL, 0);
1322 if ( (lstrlenW(pszPath) + len) > uOutSize )
1323 {hr = E_INVALIDARG; break;}
1325 MultiByteToWideChar(CP_ACP, 0, txt, -1,
1326 &pszPath[lstrlenW(pszPath)], len);
1328 pidl = ILGetNext(pidl);
1329 if (!pidl)
1330 {hr = E_INVALIDARG; break;}
1332 if (!pidl->mkid.cb) {
1333 /* We are at the end and successfully converted the complete PIDL. */
1334 break;
1337 if ( (lstrlenW(pszPath) + 1) > uOutSize )
1338 {hr = E_INVALIDARG; break;}
1339 if (!PathAddBackslashW(pszPath))
1340 {hr = E_INVALIDARG; break;}
1342 } else
1343 hr = E_INVALIDARG;
1345 TRACE_(shell)("-- %s, 0x%08lx\n", debugstr_w(pszPath), hr);
1346 return hr;
1349 /*************************************************************************
1350 * SHGetPathFromIDListW [SHELL32.@]
1352 BOOL WINAPI SHGetPathFromIDListW(LPCITEMIDLIST pidl, LPWSTR pszPath)
1354 HRESULT hr;
1356 TRACE_(shell)("(pidl=%p,%p)\n", pidl, debugstr_w(pszPath));
1357 pdump(pidl);
1359 if (!pidl)
1360 return FALSE;
1362 hr = SHELL_GetPathFromIDListW(pidl, pszPath, MAX_PATH);
1364 TRACE_(shell)("-- %s, 0x%08lx\n",debugstr_w(pszPath), hr);
1365 return SUCCEEDED(hr);
1368 /*************************************************************************
1369 * SHGetPathFromIDList [SHELL32.@][NT 4.0: SHELL32.219]
1371 BOOL WINAPI SHGetPathFromIDListAW(LPCITEMIDLIST pidl,LPVOID pszPath)
1373 TRACE_(shell)("(pidl=%p,%p)\n",pidl,pszPath);
1375 if (SHELL_OsIsUnicode())
1376 return SHGetPathFromIDListW(pidl,pszPath);
1377 return SHGetPathFromIDListA(pidl,pszPath);
1380 /*************************************************************************
1381 * SHBindToParent [shell version 5.0]
1383 HRESULT WINAPI SHBindToParent(LPCITEMIDLIST pidl, REFIID riid, LPVOID *ppv, LPCITEMIDLIST *ppidlLast)
1385 IShellFolder * psf;
1386 LPITEMIDLIST pidlChild, pidlParent;
1387 HRESULT hr=E_FAIL;
1389 TRACE_(shell)("pidl=%p\n", pidl);
1390 pdump(pidl);
1392 *ppv = NULL;
1393 if (ppidlLast) *ppidlLast = NULL;
1395 if (_ILIsPidlSimple(pidl))
1397 IShellFolder* desktop;
1399 /* we are on desktop level */
1400 hr = SHGetDesktopFolder(&desktop);
1402 if (SUCCEEDED(hr))
1404 hr = IShellFolder_QueryInterface(desktop, riid, ppv);
1406 if (SUCCEEDED(hr) && ppidlLast)
1407 *ppidlLast = ILClone(pidl);
1409 IShellFolder_Release(desktop);
1412 else
1414 pidlChild = ILClone(ILFindLastID(pidl));
1415 pidlParent = ILClone(pidl);
1416 ILRemoveLastID(pidlParent);
1418 hr = SHGetDesktopFolder(&psf);
1420 if (SUCCEEDED(hr))
1421 hr = IShellFolder_BindToObject(psf, pidlParent, NULL, riid, ppv);
1423 if (SUCCEEDED(hr) && ppidlLast)
1424 *ppidlLast = pidlChild;
1425 else
1426 ILFree (pidlChild);
1428 SHFree (pidlParent);
1429 if (psf) IShellFolder_Release(psf);
1433 TRACE_(shell)("-- psf=%p pidl=%p ret=0x%08lx\n", *ppv, (ppidlLast)?*ppidlLast:NULL, hr);
1434 return hr;
1437 /**************************************************************************
1439 * internal functions
1441 * ### 1. section creating pidls ###
1443 *************************************************************************
1445 LPITEMIDLIST _ILAlloc(PIDLTYPE type, size_t size)
1447 LPITEMIDLIST pidlOut = NULL;
1449 if((pidlOut = SHAlloc(size + 5)))
1451 LPPIDLDATA pData;
1452 LPITEMIDLIST pidlNext;
1454 ZeroMemory(pidlOut, size + 5);
1455 pidlOut->mkid.cb = size + 3;
1457 if ((pData = _ILGetDataPointer(pidlOut)))
1458 pData->type = type;
1460 if ((pidlNext = ILGetNext(pidlOut)))
1461 pidlNext->mkid.cb = 0x00;
1462 TRACE("-- (pidl=%p, size=%u)\n", pidlOut, size);
1465 return pidlOut;
1468 LPITEMIDLIST _ILCreateDesktop()
1470 LPITEMIDLIST ret;
1472 TRACE("()\n");
1473 ret = SHAlloc(2);
1474 if (ret)
1475 ret->mkid.cb = 0;
1476 return ret;
1479 LPITEMIDLIST _ILCreateMyComputer()
1480 { TRACE("()\n");
1481 return _ILCreateGuid(PT_GUID, &CLSID_MyComputer);
1484 LPITEMIDLIST _ILCreateIExplore()
1485 { TRACE("()\n");
1486 return _ILCreateGuid(PT_GUID, &CLSID_Internet);
1489 LPITEMIDLIST _ILCreateControlPanel()
1491 LPITEMIDLIST parent = _ILCreateGuid(PT_GUID, &CLSID_MyComputer), ret = NULL;
1493 TRACE("()\n");
1494 if (parent)
1496 LPITEMIDLIST cpl = _ILCreateGuid(PT_SHELLEXT, &CLSID_ControlPanel);
1498 if (cpl)
1500 ret = ILCombine(parent, cpl);
1501 SHFree(cpl);
1503 SHFree(parent);
1505 return ret;
1508 LPITEMIDLIST _ILCreatePrinters()
1510 LPITEMIDLIST parent = _ILCreateGuid(PT_GUID, &CLSID_MyComputer), ret = NULL;
1512 TRACE("()\n");
1513 if (parent)
1515 LPITEMIDLIST printers = _ILCreateGuid(PT_YAGUID, &CLSID_Printers);
1517 if (printers)
1519 ret = ILCombine(parent, printers);
1520 SHFree(printers);
1522 SHFree(parent);
1524 return ret;
1527 LPITEMIDLIST _ILCreateNetwork()
1528 { TRACE("()\n");
1529 return _ILCreateGuid(PT_GUID, &CLSID_NetworkPlaces);
1532 LPITEMIDLIST _ILCreateBitBucket()
1533 { TRACE("()\n");
1534 return _ILCreateGuid(PT_GUID, &CLSID_RecycleBin);
1537 LPITEMIDLIST _ILCreateGuid(PIDLTYPE type, REFIID guid)
1539 LPITEMIDLIST pidlOut;
1541 if (type == PT_SHELLEXT || type == PT_GUID || type == PT_YAGUID)
1543 pidlOut = _ILAlloc(type, sizeof(GUIDStruct));
1544 if (pidlOut)
1546 LPPIDLDATA pData = _ILGetDataPointer(pidlOut);
1548 memcpy(&(pData->u.guid.guid), guid, sizeof(GUID));
1549 TRACE("-- create GUID-pidl %s\n",
1550 debugstr_guid(&(pData->u.guid.guid)));
1553 else
1555 WARN("%d: invalid type for GUID\n", type);
1556 pidlOut = NULL;
1558 return pidlOut;
1561 LPITEMIDLIST _ILCreateGuidFromStrA(LPCSTR szGUID)
1563 IID iid;
1565 if (!SUCCEEDED(SHCLSIDFromStringA(szGUID, &iid)))
1567 ERR("%s is not a GUID\n", szGUID);
1568 return NULL;
1570 return _ILCreateGuid(PT_GUID, &iid);
1573 LPITEMIDLIST _ILCreateFromFindDataA(WIN32_FIND_DATAA * stffile )
1575 char buff[MAX_PATH + 14 +1]; /* see WIN32_FIND_DATA */
1576 char * pbuff = buff;
1577 size_t len, len1;
1578 LPITEMIDLIST pidl;
1579 PIDLTYPE type;
1581 if (!stffile)
1582 return NULL;
1584 TRACE("(%s, %s)\n",stffile->cAlternateFileName, stffile->cFileName);
1586 /* prepare buffer with both names */
1587 len = strlen (stffile->cFileName) + 1;
1588 memcpy (pbuff, stffile->cFileName, len);
1589 pbuff += len;
1591 len1 = strlen (stffile->cAlternateFileName)+1;
1592 memcpy (pbuff, stffile->cAlternateFileName, len1);
1594 type = (stffile->dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) ? PT_FOLDER :
1595 PT_VALUE;
1596 /* FileStruct already has one byte for the first name, so use len - 1 in
1597 * size calculation
1599 if ((pidl = _ILAlloc(type, sizeof(FileStruct) + (len - 1) + len1)))
1601 LPPIDLDATA pData;
1602 LPSTR pszDest;
1604 /* set attributes */
1605 if ((pData = _ILGetDataPointer(pidl)))
1607 pData->type = type;
1608 FileTimeToDosDateTime(&(stffile->ftLastWriteTime),&pData->u.file.uFileDate,&pData->u.file.uFileTime);
1609 pData->u.file.dwFileSize = stffile->nFileSizeLow;
1610 pData->u.file.uFileAttribs = (WORD)stffile->dwFileAttributes;
1612 if ((pszDest = _ILGetTextPointer(pidl)))
1614 memcpy(pszDest, buff, len + len1);
1615 TRACE("-- create Value: %s\n",debugstr_a(pszDest));
1618 return pidl;
1621 HRESULT _ILCreateFromPathA(LPCSTR szPath, LPITEMIDLIST* ppidl)
1623 HANDLE hFile;
1624 WIN32_FIND_DATAA stffile;
1626 if (!ppidl)
1627 return E_INVALIDARG;
1629 hFile = FindFirstFileA(szPath, &stffile);
1631 if (hFile == INVALID_HANDLE_VALUE)
1632 return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
1634 FindClose(hFile);
1636 *ppidl = _ILCreateFromFindDataA(&stffile);
1638 return *ppidl ? S_OK : E_OUTOFMEMORY;
1641 LPITEMIDLIST _ILCreateDrive(LPCWSTR lpszNew)
1643 WCHAR sTemp[4];
1644 LPITEMIDLIST pidlOut;
1646 sTemp[0]=toupperW(lpszNew[0]);
1647 sTemp[1]=':';
1648 sTemp[2]='\\';
1649 sTemp[3]=0x00;
1650 TRACE("(%s)\n",debugstr_w(sTemp));
1652 if ((pidlOut = _ILAlloc(PT_DRIVE, sizeof(DriveStruct))))
1654 LPSTR pszDest;
1656 if ((pszDest = _ILGetTextPointer(pidlOut)))
1658 WideCharToMultiByte(CP_ACP, 0, sTemp, sizeof(sTemp)/sizeof(WCHAR), pszDest, sizeof(sTemp)/sizeof(WCHAR), NULL, NULL);
1659 TRACE("-- create Drive: %s\n", debugstr_a(pszDest));
1662 return pidlOut;
1665 /**************************************************************************
1666 * _ILGetDrive()
1668 * Gets the text for the drive eg. 'c:\'
1670 * RETURNS
1671 * strlen (lpszText)
1673 DWORD _ILGetDrive(LPCITEMIDLIST pidl,LPSTR pOut, UINT uSize)
1674 { TRACE("(%p,%p,%u)\n",pidl,pOut,uSize);
1676 if(_ILIsMyComputer(pidl))
1677 pidl = ILGetNext(pidl);
1679 if (pidl && _ILIsDrive(pidl))
1680 return _ILSimpleGetText(pidl, pOut, uSize);
1682 return 0;
1685 /**************************************************************************
1687 * ### 2. section testing pidls ###
1689 **************************************************************************
1690 * _ILIsDesktop()
1691 * _ILIsMyComputer()
1692 * _ILIsSpecialFolder()
1693 * _ILIsDrive()
1694 * _ILIsFolder()
1695 * _ILIsValue()
1696 * _ILIsPidlSimple()
1698 BOOL _ILIsDesktop(LPCITEMIDLIST pidl)
1699 { TRACE("(%p)\n",pidl);
1700 return pidl && pidl->mkid.cb ? 0 : 1;
1703 BOOL _ILIsMyComputer(LPCITEMIDLIST pidl)
1705 REFIID iid = _ILGetGUIDPointer(pidl);
1707 TRACE("(%p)\n",pidl);
1709 if (iid)
1710 return IsEqualIID(iid, &CLSID_MyComputer);
1711 return FALSE;
1714 BOOL _ILIsSpecialFolder (LPCITEMIDLIST pidl)
1716 LPPIDLDATA lpPData = _ILGetDataPointer(pidl);
1717 TRACE("(%p)\n",pidl);
1718 return (pidl && ( (lpPData && (PT_GUID== lpPData->type || PT_SHELLEXT== lpPData->type)) ||
1719 (pidl && pidl->mkid.cb == 0x00)
1723 BOOL _ILIsDrive(LPCITEMIDLIST pidl)
1724 { LPPIDLDATA lpPData = _ILGetDataPointer(pidl);
1725 TRACE("(%p)\n",pidl);
1726 return (pidl && lpPData && (PT_DRIVE == lpPData->type ||
1727 PT_DRIVE1 == lpPData->type ||
1728 PT_DRIVE2 == lpPData->type ||
1729 PT_DRIVE3 == lpPData->type));
1732 BOOL _ILIsFolder(LPCITEMIDLIST pidl)
1733 { LPPIDLDATA lpPData = _ILGetDataPointer(pidl);
1734 TRACE("(%p)\n",pidl);
1735 return (pidl && lpPData && (PT_FOLDER == lpPData->type || PT_FOLDER1 == lpPData->type));
1738 BOOL _ILIsValue(LPCITEMIDLIST pidl)
1739 { LPPIDLDATA lpPData = _ILGetDataPointer(pidl);
1740 TRACE("(%p)\n",pidl);
1741 return (pidl && lpPData && PT_VALUE == lpPData->type);
1744 BOOL _ILIsCPanelStruct(LPCITEMIDLIST pidl)
1745 { LPPIDLDATA lpPData = _ILGetDataPointer(pidl);
1746 TRACE("(%p)\n",pidl);
1747 return (pidl && lpPData && (lpPData->type == 0));
1750 /**************************************************************************
1751 * _ILIsPidlSimple
1753 BOOL _ILIsPidlSimple ( LPCITEMIDLIST pidl)
1755 BOOL ret = TRUE;
1757 if(! _ILIsDesktop(pidl)) /* pidl=NULL or mkid.cb=0 */
1759 WORD len = pidl->mkid.cb;
1760 LPCITEMIDLIST pidlnext = (LPCITEMIDLIST) (((LPBYTE)pidl) + len );
1761 if (pidlnext->mkid.cb)
1762 ret = FALSE;
1765 TRACE("%s\n", ret ? "Yes" : "No");
1766 return ret;
1769 /**************************************************************************
1771 * ### 3. section getting values from pidls ###
1774 /**************************************************************************
1775 * _ILSimpleGetText
1777 * gets the text for the first item in the pidl (eg. simple pidl)
1779 * returns the length of the string
1781 DWORD _ILSimpleGetText (LPCITEMIDLIST pidl, LPSTR szOut, UINT uOutSize)
1783 DWORD dwReturn=0;
1784 LPSTR szSrc;
1785 GUID const * riid;
1786 char szTemp[MAX_PATH];
1788 TRACE("(%p %p %x)\n",pidl,szOut,uOutSize);
1790 if (!pidl) return 0;
1792 if (szOut)
1793 *szOut = 0;
1795 if (_ILIsDesktop(pidl))
1797 /* desktop */
1798 if (HCR_GetClassNameA(&CLSID_ShellDesktop, szTemp, MAX_PATH))
1800 if (szOut)
1801 lstrcpynA(szOut, szTemp, uOutSize);
1803 dwReturn = strlen (szTemp);
1806 else if (( szSrc = _ILGetTextPointer(pidl) ))
1808 /* filesystem */
1809 if (szOut)
1810 lstrcpynA(szOut, szSrc, uOutSize);
1812 dwReturn = strlen(szSrc);
1814 else if (( riid = _ILGetGUIDPointer(pidl) ))
1816 /* special folder */
1817 if ( HCR_GetClassNameA(riid, szTemp, MAX_PATH) )
1819 if (szOut)
1820 lstrcpynA(szOut, szTemp, uOutSize);
1822 dwReturn = strlen (szTemp);
1825 else
1827 ERR("-- no text\n");
1830 TRACE("-- (%p=%s 0x%08lx)\n",szOut,debugstr_a(szOut),dwReturn);
1831 return dwReturn;
1834 /**************************************************************************
1835 * _ILSimpleGetTextW
1837 * gets the text for the first item in the pidl (eg. simple pidl)
1839 * returns the length of the string
1841 DWORD _ILSimpleGetTextW (LPCITEMIDLIST pidl, LPWSTR szOut, UINT uOutSize)
1843 DWORD dwReturn;
1844 char szTemp[MAX_PATH];
1846 TRACE("(%p %p %x)\n",pidl,szOut,uOutSize);
1848 dwReturn = _ILSimpleGetText(pidl, szTemp, uOutSize);
1850 if (!MultiByteToWideChar(CP_ACP, 0, szTemp, -1, szOut, MAX_PATH))
1851 *szOut = 0;
1853 TRACE("-- (%p=%s 0x%08lx)\n",szOut,debugstr_w(szOut),dwReturn);
1854 return dwReturn;
1857 /**************************************************************************
1859 * ### 4. getting pointers to parts of pidls ###
1861 **************************************************************************
1862 * _ILGetDataPointer()
1864 LPPIDLDATA _ILGetDataPointer(LPCITEMIDLIST pidl)
1866 if(pidl && pidl->mkid.cb != 0x00)
1867 return (LPPIDLDATA) &(pidl->mkid.abID);
1868 return NULL;
1871 /**************************************************************************
1872 * _ILGetTextPointer()
1873 * gets a pointer to the long filename string stored in the pidl
1875 LPSTR _ILGetTextPointer(LPCITEMIDLIST pidl)
1876 {/* TRACE(pidl,"(pidl%p)\n", pidl);*/
1878 LPPIDLDATA pdata = _ILGetDataPointer(pidl);
1880 if (pdata)
1882 switch (pdata->type)
1884 case PT_GUID:
1885 case PT_SHELLEXT:
1886 case PT_YAGUID:
1887 return NULL;
1889 case PT_DRIVE:
1890 case PT_DRIVE1:
1891 case PT_DRIVE2:
1892 case PT_DRIVE3:
1893 return (LPSTR)&(pdata->u.drive.szDriveName);
1895 case PT_FOLDER:
1896 case PT_FOLDER1:
1897 case PT_VALUE:
1898 case PT_IESPECIAL1:
1899 case PT_IESPECIAL2:
1900 return (LPSTR)&(pdata->u.file.szNames);
1902 case PT_WORKGRP:
1903 case PT_COMP:
1904 case PT_NETWORK:
1905 case PT_NETPROVIDER:
1906 case PT_SHARE:
1907 return (LPSTR)&(pdata->u.network.szNames);
1910 return NULL;
1913 /**************************************************************************
1914 * _ILGetSTextPointer()
1915 * gets a pointer to the short filename string stored in the pidl
1917 LPSTR _ILGetSTextPointer(LPCITEMIDLIST pidl)
1918 {/* TRACE(pidl,"(pidl%p)\n", pidl);*/
1920 LPPIDLDATA pdata =_ILGetDataPointer(pidl);
1922 if (pdata)
1924 switch (pdata->type)
1926 case PT_FOLDER:
1927 case PT_VALUE:
1928 case PT_IESPECIAL1:
1929 case PT_IESPECIAL2:
1930 return (LPSTR)(pdata->u.file.szNames + strlen (pdata->u.file.szNames) + 1);
1932 case PT_WORKGRP:
1933 return (LPSTR)(pdata->u.network.szNames + strlen (pdata->u.network.szNames) + 1);
1936 return NULL;
1939 /**************************************************************************
1940 * _ILGetGUIDPointer()
1942 * returns reference to guid stored in some pidls
1944 IID* _ILGetGUIDPointer(LPCITEMIDLIST pidl)
1946 LPPIDLDATA pdata =_ILGetDataPointer(pidl);
1948 TRACE("%p\n", pidl);
1950 if (pdata)
1952 TRACE("pdata->type 0x%04x\n", pdata->type);
1953 switch (pdata->type)
1955 case PT_SHELLEXT:
1956 case PT_GUID:
1957 return &(pdata->u.guid.guid);
1959 default:
1960 TRACE("Unknown pidl type 0x%04x\n", pdata->type);
1961 break;
1964 return NULL;
1967 /*************************************************************************
1968 * _ILGetFileDateTime
1970 * Given the ItemIdList, get the FileTime
1972 * PARAMS
1973 * pidl [I] The ItemIDList
1974 * pFt [I] the resulted FILETIME of the file
1976 * RETURNS
1977 * True if Successful
1979 * NOTES
1982 BOOL _ILGetFileDateTime(LPCITEMIDLIST pidl, FILETIME *pFt)
1984 LPPIDLDATA pdata = _ILGetDataPointer(pidl);
1986 if(! pdata) return FALSE;
1988 switch (pdata->type)
1990 case PT_FOLDER:
1991 case PT_VALUE:
1992 DosDateTimeToFileTime(pdata->u.file.uFileDate, pdata->u.file.uFileTime, pFt);
1993 break;
1994 default:
1995 return FALSE;
1997 return TRUE;
2000 BOOL _ILGetFileDate (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize)
2002 FILETIME ft,lft;
2003 SYSTEMTIME time;
2004 BOOL ret;
2006 if (_ILGetFileDateTime( pidl, &ft )) {
2007 FileTimeToLocalFileTime(&ft, &lft);
2008 FileTimeToSystemTime (&lft, &time);
2009 ret = GetDateFormatA(LOCALE_USER_DEFAULT,DATE_SHORTDATE,&time, NULL, pOut, uOutSize);
2010 } else {
2011 pOut[0] = '\0';
2012 ret = FALSE;
2014 return ret;
2018 /*************************************************************************
2019 * _ILGetFileSize
2021 * Given the ItemIdList, get the FileSize
2023 * PARAMS
2024 * pidl [I] The ItemIDList
2025 * pOut [I] The buffer to save the result
2026 * uOutsize [I] The size of the buffer
2028 * RETURNS
2029 * The FileSize
2031 * NOTES
2032 * pOut can be null when no string is needed
2035 DWORD _ILGetFileSize (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize)
2037 LPPIDLDATA pdata = _ILGetDataPointer(pidl);
2038 DWORD dwSize;
2040 if(! pdata) return 0;
2042 switch (pdata->type)
2044 case PT_VALUE:
2045 dwSize = pdata->u.file.dwFileSize;
2046 if (pOut) StrFormatByteSizeA(dwSize, pOut, uOutSize);
2047 return dwSize;
2049 if (pOut) *pOut = 0x00;
2050 return 0;
2053 BOOL _ILGetExtension (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize)
2055 char szTemp[MAX_PATH];
2056 const char * pPoint;
2057 LPCITEMIDLIST pidlTemp=pidl;
2059 TRACE("pidl=%p\n",pidl);
2061 if (!pidl) return FALSE;
2063 pidlTemp = ILFindLastID(pidl);
2065 if (!_ILIsValue(pidlTemp)) return FALSE;
2066 if (!_ILSimpleGetText(pidlTemp, szTemp, MAX_PATH)) return FALSE;
2068 pPoint = PathFindExtensionA(szTemp);
2070 if (! *pPoint) return FALSE;
2072 pPoint++;
2073 lstrcpynA(pOut, pPoint, uOutSize);
2074 TRACE("%s\n",pOut);
2076 return TRUE;
2079 /*************************************************************************
2080 * _ILGetFileType
2082 * Given the ItemIdList, get the file type description
2084 * PARAMS
2085 * pidl [I] The ItemIDList (simple)
2086 * pOut [I] The buffer to save the result
2087 * uOutsize [I] The size of the buffer
2089 * RETURNS
2090 * nothing
2092 * NOTES
2093 * This function copies as much as possible into the buffer.
2095 void _ILGetFileType(LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize)
2097 if(_ILIsValue(pidl))
2099 char sTemp[64];
2100 if(uOutSize > 0)
2102 pOut[0] = 0;
2104 if (_ILGetExtension (pidl, sTemp, 64))
2106 if (!( HCR_MapTypeToValueA(sTemp, sTemp, 64, TRUE)
2107 && HCR_MapTypeToValueA(sTemp, pOut, uOutSize, FALSE )))
2109 lstrcpynA (pOut, sTemp, uOutSize - 6);
2110 strcat (pOut, "-file");
2114 else
2116 lstrcpynA(pOut, "Folder", uOutSize);
2120 /*************************************************************************
2121 * _ILGetFileAttributes
2123 * Given the ItemIdList, get the Attrib string format
2125 * PARAMS
2126 * pidl [I] The ItemIDList
2127 * pOut [I] The buffer to save the result
2128 * uOutsize [I] The size of the Buffer
2130 * RETURNS
2131 * Attributes
2133 * FIXME
2134 * return value 0 in case of error is a valid return value
2137 DWORD _ILGetFileAttributes(LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize)
2139 LPPIDLDATA pData = _ILGetDataPointer(pidl);
2140 WORD wAttrib = 0;
2141 int i;
2143 if(! pData) return 0;
2145 switch(pData->type)
2147 case PT_FOLDER:
2148 case PT_VALUE:
2149 wAttrib = pData->u.file.uFileAttribs;
2150 break;
2153 if(uOutSize >= 6)
2155 i=0;
2156 if(wAttrib & FILE_ATTRIBUTE_READONLY)
2158 pOut[i++] = 'R';
2160 if(wAttrib & FILE_ATTRIBUTE_HIDDEN)
2162 pOut[i++] = 'H';
2164 if(wAttrib & FILE_ATTRIBUTE_SYSTEM)
2166 pOut[i++] = 'S';
2168 if(wAttrib & FILE_ATTRIBUTE_ARCHIVE)
2170 pOut[i++] = 'A';
2172 if(wAttrib & FILE_ATTRIBUTE_COMPRESSED)
2174 pOut[i++] = 'C';
2176 pOut[i] = 0x00;
2178 return wAttrib;
2181 /*************************************************************************
2182 * ILFreeaPidl
2184 * free a aPidl struct
2186 void _ILFreeaPidl(LPITEMIDLIST * apidl, UINT cidl)
2188 UINT i;
2190 if (apidl)
2192 for (i = 0; i < cidl; i++) SHFree(apidl[i]);
2193 SHFree(apidl);
2197 /*************************************************************************
2198 * ILCopyaPidl
2200 * copies an aPidl struct
2202 LPITEMIDLIST* _ILCopyaPidl(LPCITEMIDLIST * apidlsrc, UINT cidl)
2204 UINT i;
2205 LPITEMIDLIST * apidldest = (LPITEMIDLIST*)SHAlloc(cidl * sizeof(LPITEMIDLIST));
2206 if(!apidlsrc) return NULL;
2208 for (i = 0; i < cidl; i++)
2209 apidldest[i] = ILClone(apidlsrc[i]);
2211 return apidldest;
2214 /*************************************************************************
2215 * _ILCopyCidaToaPidl
2217 * creates aPidl from CIDA
2219 LPITEMIDLIST* _ILCopyCidaToaPidl(LPITEMIDLIST* pidl, LPIDA cida)
2221 UINT i;
2222 LPITEMIDLIST * dst = (LPITEMIDLIST*)SHAlloc(cida->cidl * sizeof(LPITEMIDLIST));
2224 if(!dst) return NULL;
2226 if (pidl)
2227 *pidl = ILClone((LPITEMIDLIST)(&((LPBYTE)cida)[cida->aoffset[0]]));
2229 for (i = 0; i < cida->cidl; i++)
2230 dst[i] = ILClone((LPITEMIDLIST)(&((LPBYTE)cida)[cida->aoffset[i + 1]]));
2232 return dst;