AllAPI Network - The KPD-Team

 
Allapi Network
 API-Guide
 ApiViewer

 API List

 
API Resources
 Tips & Tricks
 VB Tutorials
 Error Lookup
 
Misc Stuff
 VB examples
 VB Tools
 VB Links
 Top Downloads
 
This Site
 Search Engine
 Contact Form
 

Donate to AllAPI.net

SHGetSpecialFolderLocation

Retrieves the location of a special folder.

VB4-32,5,6
Declare Function SHGetSpecialFolderLocation Lib "shell32.dll" (ByVal hwndOwner As Long, ByVal nFolder As Long, pidl As ITEMIDLIST) As Long

Operating Systems Supported
Requires Windows NT 4.0 or later; Requires Windows 95 or later

Library
Shell32

Parameter Information
∑ hwndOwner
Handle of the owner window that the client should specify if it displays a dialog box or message box.

∑ nFolder
Value specifying the folder to retrieve the location of. This parameter can be one of the following values:
CSIDL_BITBUCKET
Recycle bin ĺ file system directory containing file objects in the userís recycle bin. The location of this directory is not in the registry; it is marked with the hidden and system attributes to prevent the user from moving or deleting it.
CSIDL_COMMON_DESKTOP
File system directory that contains files and folders that appear on the desktop for all users.
CSIDL_COMMON_PROGRAMS
File system directory that contains the directories for the common program groups that appear on the Start menu for all users.
CSIDL_COMMON_STARTMENU
File system directory that contains the programs and folders that appear on the Start menu for all users.
CSIDL_COMMON_STARTUP
File system directory that contains the programs that appear in the Startup folder for all users. The system starts these programs whenever any user logs on to Windows NT or starts up Windows 95.
CSIDL_CONTROLS
Control Panel ĺ virtual folder containing icons for the control panel applications.
CSIDL_DESKTOP
Windows desktop ĺ virtual folder at the root of the name space.
CSIDL_DESKTOPDIRECTORY
File system directory used to physically store file objects on the desktop (not to be confused with the desktop folder itself).
CSIDL_DRIVES
My Computer ĺ virtual folder containing everything on the local computer: storage devices, printers, and Control Panel. The folder may also contain mapped network drives.
CSIDL_FONTS
Virtual folder containing fonts.
CSIDL_NETHOOD
File system directory containing objects that appear in the network neighborhood.
CSIDL_NETWORK
Network Neighborhood ĺ virtual folder representing the top level of the network hierarchy.
CSIDL_PERSONAL
File system directory that serves as a common respository for documents.
CSIDL_PRINTERS
Printers folder ĺ virtual folder containing installed printers.
CSIDL_PROGRAMS
File system directory that contains the userís program groups (which are also file system directories).
CSIDL_RECENT
File system directory that contains the userís most recently used documents.
CSIDL_SENDTO
File system directory that contains Send To menu items.
CSIDL_STARTMENU
File system directory containing Start menu items.
CSIDL_STARTUP
File system directory that corresponds to the userís Startup program group.
CSIDL_TEMPLATES
File system directory that serves as a common repository for document templates.

∑ ppidl
Address that receives a pointer to an item identifier list specifying the folderís location relative to the root of the name space (the desktop).

Return Values
Returns NOERROR if successful or an OLE-defined error result otherwise.

Examples

Related Functions

 

 


Copyright © 1998-2007, The Mentalis.org Team - Privacy statement
Did you find a bug on this page? Tell us!
This site is located at http://allapi.mentalis.org/