dlls/shell32/pidl.h

   1 /*
   2  * internal pidl functions
   3  * 1998 <juergen.schmied@metronet.de>
   4  *
   5  * DO NOT use this definitions outside the shell32.dll !
   6  *
   7  * The contents of a pidl should never used from a application
   8  * directly.
   9  *
  10  * This stuff is used from SHGetFileAttributes, ShellFolder
  11  * EnumIDList and ShellView.
  12  */
  13
  14 #ifndef __WINE_PIDL_H
  15 #define __WINE_PIDL_H
  16
  17 #include "shlobj.h"
  18
  19 /*
  20 * the pidl does cache fileattributes to speed up SHGetAttributes when
  21 * displaying a big number of files.
  22 *
  23 * a pidl of NULL means the desktop
  24 *
  25 * The structure of the pidl seems to be a union. The first byte of the
  26 * PIDLDATA desribes the type of pidl.
  27 *
  28 * first byte -  my Computer     0x1F
  29 *               control/printer 0x2E
  30 *               drive           0x23
  31 *               folder          0x31
  32 * drive: the second byte is the start of a string
  33 *         C  :  \
  34 *        43 3A 5C
  35 * file: see the PIDLDATA structure
  36 */
  37
  38 #define PT_DESKTOP      0x00 /* internal */
  39 #define PT_MYCOMP       0x1F
  40 #define PT_SPECIAL      0x2E
  41 #define PT_DRIVE        0x23
  42 #define PT_FOLDER       0x31
  43 #define PT_VALUE        0x32
  44
  45 #pragma pack(1)
  46 typedef BYTE PIDLTYPE;
  47
  48 typedef struct tagPIDLDATA
  49 {       PIDLTYPE type;                  /*00*/
  50         union
  51         { struct
  52           { CHAR szDriveName[4];        /*01*/
  53             /* end of MS compatible*/
  54             DWORD dwSFGAO;              /*05*/
  55             /* the drive seems to be 19 bytes every time */
  56           } drive;
  57           struct
  58           { BYTE dummy;                 /*01 is 0x00 for files or dirs */
  59             DWORD dwFileSize;           /*02*/
  60             WORD uFileDate;             /*06*/
  61             WORD uFileTime;             /*08*/
  62             WORD uFileAttribs;          /*10*/
  63             CHAR szNames[1];            /*12*/
  64             /* Here are comming two strings. The first is the long name.
  65             The second the dos name when needed or just 0x00 */
  66           } file, folder, generic;
  67         }u;
  68 } PIDLDATA, *LPPIDLDATA;
  69 #pragma pack(4)
  70
  71 /*
  72  * getting string values from pidls
  73  *
  74  * return value is strlen()
  75  */
  76 DWORD WINAPI _ILGetDrive(LPCITEMIDLIST,LPSTR,UINT16);
  77 DWORD WINAPI _ILGetItemText(LPCITEMIDLIST,LPSTR,UINT16);
  78 DWORD WINAPI _ILGetFolderText(LPCITEMIDLIST,LPSTR,DWORD);
  79 DWORD WINAPI _ILGetValueText(LPCITEMIDLIST,LPSTR,DWORD);
  80 DWORD WINAPI _ILGetPidlPath(LPCITEMIDLIST,LPSTR,DWORD);
  81
  82 /*
  83  * getting special values from simple pidls
  84  */
  85 BOOL WINAPI _ILGetFileDate (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
  86 BOOL WINAPI _ILGetFileSize (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
  87 BOOL WINAPI _ILGetExtension (LPCITEMIDLIST pidl, LPSTR pOut, UINT uOutSize);
  88
  89
  90 /*
  91  * testing simple pidls
  92  */
  93 BOOL WINAPI _ILIsDesktop(LPCITEMIDLIST);
  94 BOOL WINAPI _ILIsMyComputer(LPCITEMIDLIST);
  95 BOOL WINAPI _ILIsDrive(LPCITEMIDLIST);
  96 BOOL WINAPI _ILIsFolder(LPCITEMIDLIST);
  97 BOOL WINAPI _ILIsValue(LPCITEMIDLIST);
  98
  99 /*
 100  * simple pidls from strings
 101  */
 102 LPITEMIDLIST WINAPI _ILCreateDesktop(void);
 103 LPITEMIDLIST WINAPI _ILCreateMyComputer(void);
 104 LPITEMIDLIST WINAPI _ILCreateDrive(LPCSTR);
 105 LPITEMIDLIST WINAPI _ILCreateFolder(LPCSTR, LPCSTR);
 106 LPITEMIDLIST WINAPI _ILCreateValue(LPCSTR, LPCSTR);
 107
 108 /*
 109  * raw pidl handling (binary)
 110  *
 111  * data is binary / sizes are bytes
 112  */
 113 DWORD WINAPI _ILGetData(PIDLTYPE,LPCITEMIDLIST,LPVOID,UINT);
 114 LPITEMIDLIST WINAPI _ILCreate(PIDLTYPE,LPVOID,UINT16);
 115
 116 /*
 117  * helper functions (getting struct-pointer)
 118  */
 119 LPPIDLDATA WINAPI _ILGetDataPointer(LPCITEMIDLIST);
 120 LPSTR WINAPI _ILGetTextPointer(PIDLTYPE type, LPPIDLDATA pidldata);
 121 LPSTR WINAPI _ILGetSTextPointer(PIDLTYPE type, LPPIDLDATA pidldata);
 122
 123 void pdump (LPCITEMIDLIST pidl);
 124 #endif