Hide

SftDirectory 3.5 - ActiveX File/Folder Control

Display
Print

SftDirectory.GetItemIDListFromCSIDL Method

Determines the file/folder's ITEMIDLIST given a file/folder's system-independent CSIDL.

Syntax

VB.NETabsoluteIDL = object.GetItemIDListFromCSIDL(ByVal FolderSpecial As SftDirectorySpecialFolderConstants) As String
VBabsoluteIDL = object.GetItemIDListFromCSIDL(ByVal FolderSpecial As SftDirectorySpecialFolderConstants) As String
C#.NETstring absoluteIDL = object.GetItemIDListFromCSIDL(SftDirectorySpecialFolderConstants FolderSpecial);
VC++_bstr_t absoluteIDL = object->GetItemIDListFromCSIDL(enum SftDirectorySpecialFolderConstants FolderSpecial);
CHRESULT object->raw_GetItemIDListFromCSIDL(enum SftDirectorySpecialFolderConstants FolderSpecial, BSTR* absoluteIDL);

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:

FolderSpecialValueDescription
specialSftDirectoryNone-1None
specialSftDirectoryAdminTools48AdminTools (*)
specialSftDirectoryAltStartup29AltStartup
specialSftDirectoryAppData26AppData (*)
specialSftDirectoryRecycleBin10RecycleBin
specialSftDirectoryCDBurnArea59CDBurnArea (6.0)
specialSftDirectoryCommonAdminTools47Common AdminTools (*)
specialSftDirectoryCommonAltStartup30Common AltStartup
specialSftDirectoryCommonAppData35Common AppData (*)
specialSftDirectoryCommonDesktop25Common Desktop
specialSftDirectoryCommonDocuments46Common Documents (*)
specialSftDirectoryCommonFavorites31Common Favorites
specialSftDirectoryCommonMusic53Common Music (6.0)
specialSftDirectoryCommonPictures54Common Pictures (6.0)
specialSftDirectoryCommonPrograms23Common Programs
specialSftDirectoryCommonStartMenu22Common StartMenu
specialSftDirectoryCommonStartUp24Common StartUp
specialSftDirectoryCommonTemplates45Common Templates
specialSftDirectoryCommonVideo55Common Video (6.0)
specialSftDirectoryControlPanel3ControlPanel
specialSftDirectoryCookies33Cookies (*)
specialSftDirectoryDesktop0Desktop
specialSftDirectoryDesktopDirectory16DesktopDirectory
specialSftDirectoryMyComputer17My Computer
specialSftDirectoryFavorites6Favorites
specialSftDirectoryFonts20Fonts
specialSftDirectoryHistory34History (*)
specialSftDirectoryInternet1Internet
specialSftDirectoryInternetCache32InternetCache (*)
specialSftDirectoryLocalAppData28Local AppData (*)
specialSftDirectoryMyDocumentsDesktop12My Documents Desktop Item (6.0)
specialSftDirectoryMyMusic13My Music
specialSftDirectoryMyPictures39My Pictures (*)
specialSftDirectoryMyVideos14My Videos (6.0)
specialSftDirectoryMyNetworkNeighborhood19My Network Neighborhood
specialSftDirectoryNetworkNeighborhood18Network Neighborhood
specialSftDirectoryMyDocuments5My Documents (*)
specialSftDirectoryPrinters4Printers
specialSftDirectoryPrintHood27PrintHood
specialSftDirectoryProfile40Profile (5.0)
specialSftDirectoryProfiles62Profiles (6.0)
specialSftDirectoryProgramFiles38Program Files (*)
specialSftDirectoryCommonProgramFiles43Common Program Files (*)
specialSftDirectoryPrograms2Programs
specialSftDirectoryRecent8Recent
specialSftDirectorySendTo9SendTo
specialSftDirectoryStartMenu11StartMenu
specialSftDirectoryStartup7Startup
specialSftDirectorySystem37System (*)
specialSftDirectoryTemplates21Templates
specialSftDirectoryWindows36Windows (*)
specialSftDirectoryConnections49Connections (6.0)
specialSftDirectoryComputersNearMe61Computers Near Me (6.0)
specialSftDirectoryPhotoAlbums69PhotoAlbums (Vista+)
specialSftDirectoryPlayLists63PlayLists (Vista+)
specialSftDirectoryResources56Resources (Vista+)
specialSftDirectorySampleMusic64Sample Music (Vista+)
specialSftDirectorySamplePictures66Sample Pictures (Vista+)
specialSftDirectorySamplePlayLists65Sample PlayLists (Vista+)
specialSftDirectorySampleVideos67Sample Videos (Vista+)
specialSftDirectoryEmpty999Empty

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.

See Also SftDirectory Object | Object Hierarchy


Last Updated 08/13/2020 - (email)
© 2024 Softel vdm, Inc.