Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

SHGetSpecialFolderPath (coredll)
 

coredll is for smart devices, not desktop Windows. Therefore, this information only applies to code using the .NET Compact Framework. To see if information for SHGetSpecialFolderPath in other DLLs exists, click on Find References to the right.

.
Summary
This function retrieves the path of a special folder, identified by its CSIDL. (From MSDN)

C# Signature:

[DllImport("coredll.dll")]
static extern int SHGetSpecialFolderPath(IntPtr hwndOwner, StringBuilder lpszPath, int nFolder, int fCreate);

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

None.

Sample Code:

    //Diferent folders to use.
    const int CSIDL_DESKTOP = 0x0000; //Not supported on Smartphone.
    const int CSIDL_FAVORITES = 0x0006; //The file system directory that serves as a common repository for the user's favorite items.
    const int CSIDL_FONTS = 0x0014; //The virtual folder that contains fonts.
    const int CSIDL_PERSONAL = 0x0005; //The file system directory that serves as a common repository for documents.
    const int CSIDL_PROGRAM_FILES = 0x0026; //The program files folder.
    const int CSIDL_PROGRAMS = 0x0002; //The file system directory that contains the user's program groups, which are also file system directories.
    const int CSIDL_STARTUP = 0x0007; //The file system directory that corresponds to the user's Startup program group. The system starts these programs when a device is powered on.
    const int CSIDL_WINDOWS = 0x0024; //The Windows folder.

    private string getPath(int folderCSIDL)
    {
        StringBuilder resultPath = new StringBuilder(255);

        SHGetSpecialFolderPath((IntPtr)0, resultPath, folderCSIDL, 0);
        return resultPath.ToString();
    }

Alternative Managed API:

The Environment.GetFolderPath Method in .NET Compact Framework 2.0, but it's incomplete as for instance the Program Files special folder is not available.

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions