Main Page   Related Pages  

Usage

Here is the output provided by SFP when run with the --help option argument:

Usage: SpecialFolderPath.exe [options] | [--nocreate] <symbol> 
where
<symbol> is one from the symbol named reported by --names (see below).

Note that specifying the "CSIDL_"-prefix is optional.
This tool prints the current contents of one of the Windows
special shell folder paths.
Use it from within your batch scripts in order to retrieve the various
system special folder paths of the current Windows installation.
If a folder path cannot be retrieved for any runtime reason, an empty
string is returned.

Options:
/?, -h, --help: display this help
--nocreate: suppress creating the folder if it does not exist already
            This flag only an effect when a symbol is also specified.
-d, --default: Use the default paths rather than the current paths.
               This is only signigicant for paths that the user has
               been allowed to move or rename.
-n, --names: Display the names of all supported CSIDL symbols.
-q, --query: Display the current contents of all currently existing
             system folders.
-v, --verbose: When used in combination with --names or --query, includes
               a description what each folder path should be used for.
--not2oem: Omit the conversion of the paths into the OEM charset.

Usage example for a batch file running under Windows 2000 or later:

FOR /F "usebackq delims=" %%A
IN (`SpecialFolderPath CSIDL_LOCAL_APPDATA`) DO @SET DATADIR=%%A

This (merge both lines into a single line please) uses the new
backquote-feature of the shell to set environment variable
%DATADIR% to the path of the user's local application data directory.

Version 1.0.1.28
Copyright (C) 2003 Guenther Brunthaler

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

Next: License


Generated on Mon Jul 21 11:11:35 2003 for SpecialFolderPath by doxygen 1.3.1