SftDirectory.GetItemIDListFromCSIDL Method
|
|
|
|
|
|
SftDirectory.GetItemIDListFromCSIDL Method |
Determines the file/folder's ITEMIDLIST given a file/folder's system-independent CSIDL.
Syntax
|
VB.NET |
absoluteIDL = object.GetItemIDListFromCSIDL(ByVal FolderSpecial As SftDirectorySpecialFolderConstants) As String |
||
|
VB |
absoluteIDL = object.GetItemIDListFromCSIDL(ByVal FolderSpecial As SftDirectorySpecialFolderConstants) As String |
||
|
C#.NET |
string absoluteIDL = object.GetItemIDListFromCSIDL(SftDirectorySpecialFolderConstants FolderSpecial); |
||
|
VC++ |
_bstr_t absoluteIDL = object->GetItemIDListFromCSIDL(enum SftDirectorySpecialFolderConstants FolderSpecial); |
||
|
C |
HRESULT object->raw_GetItemIDListFromCSIDL(enum SftDirectorySpecialFolderConstants FolderSpecial, BSTR* absoluteIDL); |
||
|
Delphi |
absoluteIDL := object.GetItemIDListFromCSIDL(FolderSpecial : TOleEnum) : WideString; |
object
A SftDirectory object.
FolderSpecial
A CSIDL value describing a special folder. CSIDL values provide a system-independent method to identify special folders. SftDirectorySpecialFolderConstants describes all available CSIDL values:
|
FolderSpecial |
Value |
Description |
|
specialSftDirectoryNone |
-1 |
None |
|
specialSftDirectoryAdminTools |
48 |
AdminTools (*) |
|
specialSftDirectoryAltStartup |
29 |
AltStartup |
|
specialSftDirectoryAppData |
26 |
AppData (*) |
|
specialSftDirectoryRecycleBin |
10 |
RecycleBin |
|
specialSftDirectoryCDBurnArea |
59 |
CDBurnArea (6.0) |
|
specialSftDirectoryCommonAdminTools |
47 |
Common AdminTools (*) |
|
specialSftDirectoryCommonAltStartup |
30 |
Common AltStartup |
|
specialSftDirectoryCommonAppData |
35 |
Common AppData (*) |
|
specialSftDirectoryCommonDesktop |
25 |
Common Desktop |
|
specialSftDirectoryCommonDocuments |
46 |
Common Documents (*) |
|
specialSftDirectoryCommonFavorites |
31 |
Common Favorites |
|
specialSftDirectoryCommonMusic |
53 |
Common Music (6.0) |
|
specialSftDirectoryCommonPictures |
54 |
Common Pictures (6.0) |
|
specialSftDirectoryCommonPrograms |
23 |
Common Programs |
|
specialSftDirectoryCommonStartMenu |
22 |
Common StartMenu |
|
specialSftDirectoryCommonStartUp |
24 |
Common StartUp |
|
specialSftDirectoryCommonTemplates |
45 |
Common Templates |
|
specialSftDirectoryCommonVideo |
55 |
Common Video (6.0) |
|
specialSftDirectoryControlPanel |
3 |
ControlPanel |
|
specialSftDirectoryCookies |
33 |
Cookies (*) |
|
specialSftDirectoryDesktop |
0 |
Desktop |
|
specialSftDirectoryDesktopDirectory |
16 |
DesktopDirectory |
|
specialSftDirectoryMyComputer |
17 |
My Computer |
|
specialSftDirectoryFavorites |
6 |
Favorites |
|
specialSftDirectoryFonts |
20 |
Fonts |
|
specialSftDirectoryHistory |
34 |
History (*) |
|
specialSftDirectoryInternet |
1 |
Internet |
|
specialSftDirectoryInternetCache |
32 |
InternetCache (*) |
|
specialSftDirectoryLocalAppData |
28 |
Local AppData (*) |
|
specialSftDirectoryMyDocumentsDesktop |
12 |
My Documents Desktop Item (6.0) |
|
specialSftDirectoryMyMusic |
13 |
My Music |
|
specialSftDirectoryMyPictures |
39 |
My Pictures (*) |
|
specialSftDirectoryMyVideos |
14 |
My Videos (6.0) |
|
specialSftDirectoryMyNetworkNeighborhood |
19 |
My Network Neighborhood |
|
specialSftDirectoryNetworkNeighborhood |
18 |
Network Neighborhood |
|
specialSftDirectoryMyDocuments |
5 |
My Documents (*) |
|
specialSftDirectoryPrinters |
4 |
Printers |
|
specialSftDirectoryPrintHood |
27 |
PrintHood |
|
specialSftDirectoryProfile |
40 |
Profile (5.0) |
|
specialSftDirectoryProfiles |
62 |
Profiles (6.0) |
|
specialSftDirectoryProgramFiles |
38 |
Program Files (*) |
|
specialSftDirectoryCommonProgramFiles |
43 |
Common Program Files (*) |
|
specialSftDirectoryPrograms |
2 |
Programs |
|
specialSftDirectoryRecent |
8 |
Recent |
|
specialSftDirectorySendTo |
9 |
SendTo |
|
specialSftDirectoryStartMenu |
11 |
StartMenu |
|
specialSftDirectoryStartup |
7 |
Startup |
|
specialSftDirectorySystem |
37 |
System (*) |
|
specialSftDirectoryTemplates |
21 |
Templates |
|
specialSftDirectoryWindows |
36 |
Windows (*) |
|
specialSftDirectoryConnections |
49 |
Connections (6.0) |
|
specialSftDirectoryComputersNearMe |
61 |
Computers Near Me (6.0) |
|
specialSftDirectoryPhotoAlbums |
69 |
PhotoAlbums (Vista+) |
|
specialSftDirectoryPlayLists |
63 |
PlayLists (Vista+) |
|
specialSftDirectoryResources |
56 |
Resources (Vista+) |
|
specialSftDirectorySampleMusic |
64 |
Sample Music (Vista+) |
|
specialSftDirectorySamplePictures |
66 |
Sample Pictures (Vista+) |
|
specialSftDirectorySamplePlayLists |
65 |
Sample PlayLists (Vista+) |
|
specialSftDirectorySampleVideos |
67 |
Sample Videos (Vista+) |
|
specialSftDirectoryEmpty |
999 |
Empty |
absoluteIDL
Determines the file/folder's ITEMIDLIST given a file/folder's system-independent CSIDL.
Comments
The GetItemIDListFromCSIDL method determines the file/folder's ITEMIDLIST given a file/folder's system-independent CSIDL.
ITEMIDLIST structures are typically used when communicating with the Windows Shell. For detailed information about the ITEMIDLIST structure and its use, please see Microsoft's Windows documentation.
A CSIDL is used in conjunction with Windows Shell functions such as SHGetFolderLocation, SHGetFolderPath, SHGetSpecialFolderLocation, and SHGetSpecialFolderPath, to retrieve a special folder's pathname or ITEMIDLIST.
The GetPathFromCSIDL method can be used to retrieve the actual path given a file/folder's system-independent CSIDL.
The GetPathFromItemIDList method can be used to retrieve the file/folder's path name given an absolute ITEMIDLIST.