winutils.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Lammertink
 Date:          09-10-2003
 Contents:      Utilities for win32 support
________________________________________________________________________


-*/


#include "basicmod.h"
#include "gendefs.h"

#ifdef __win__
# include "shlobj.h"
#endif

extern "C" 
{
    mGlobal(Basic) const char*  getCleanUnxPath( const char* path );
    mGlobal(Basic) const char*  getCleanWinPath( const char* path );
    mGlobal(Basic) const char*  GetSpecialFolderLocation(int csidl);
}

#ifdef __win__

mGlobal(Basic) bool             winCopy(const char* from,const char* to,
                                        bool isfile,bool ismove=false);
mGlobal(Basic) bool             winRemoveDir(const char* dirnm);


mGlobal(Basic) bool             executeWinProg(const char* comm,
                                               const char* parm,
                                               const char* runin=0);
mGlobal(Basic) bool             execShellCmd(const char* comm,const char* parm,
                                             const char* runin );
mGlobal(Basic) bool             execProc(const char* comm,bool inconsole,
                                         bool inbg,const char* runin);

mGlobal(Basic) unsigned int     getWinVersion();
mGlobal(Basic) const char*      getFullWinVersion();
mGlobal(Basic) const char*      getCygDir();
mGlobal(Basic) bool             getDefaultBrowser(BufferString& cmd,
                                                  BufferString& errmsg);

mGlobal(Basic)  bool            setRegKeyVal(const char* ky, const char* vanrnm,
                                             const char *val);
mGlobal(Basic) bool             removeRegKey(const char*);


/*
For documentation of the CSIDL values, see: 

http://msdn.microsoft.com/library/default.asp?
    url=/library/en-us/shellcc/platform/shell/reference/enums/csidl.asp


                                CSIDL
     _________________________________________________________________

   CSIDL values provide a unique system-independent way to identify
   special folders used frequently by applications, but which may not
   have the same name or location on any given system. For example, the
   system folder may be "C:\Windows" on one system and "C:\Winnt" on
   another.

   Constants

   CSIDL_FLAG_CREATE (0x8000)
          Version 5.0. Combine this CSIDL with any of the following
          CSIDLs to force the creation of the associated folder.

   CSIDL_ADMINTOOLS (0x0030)
          Version 5.0. The file system directory that is used to store
          administrative tools for an individual user. The Microsoft
          Management Console (MMC) will save customized consoles to this
          directory, and it will roam with the user.

   CSIDL_ALTSTARTUP (0x001d)
          The file system directory that corresponds to the user's
          nonlocalized Startup program group.

   CSIDL_APPDATA (0x001a)
          Version 4.71. The file system directory that serves as a common
          repository for application-specific data. A typical path is
          C:\Documents and Settings\username\Application Data. This CSIDL
          is supported by the redistributable Shfolder.dll for systems
          that do not have the Microsoft Internet Explorer 4.0
          integrated Shell installed.

   CSIDL_BITBUCKET (0x000a)
          The virtual folder containing the objects in the user's Recycle
          Bin.

   CSIDL_CDBURN_AREA (0x003b)
          Version 6.0. The file system directory acting as a staging area
          for files waiting to be written to CD. A typical path is
          C:\Documents and Settings\username\Local Settings\Application
          Data\Microsoft\CD Burning.

   CSIDL_COMMON_ADMINTOOLS (0x002f)
          Version 5.0. The file system directory containing
          administrative tools for all users of the computer.

   CSIDL_COMMON_ALTSTARTUP (0x001e)
          The file system directory that corresponds to the nonlocalized
          Startup program group for all users. Valid only for Microsoft
          Windows NT systems.

   CSIDL_COMMON_APPDATA (0x0023)
          Version 5.0. The file system directory containing application
          data for all users. A typical path is C:\Documents and
          Settings\All Users\Application Data.

   CSIDL_COMMON_DESKTOPDIRECTORY (0x0019)
          The file system directory that contains files and folders that
          appear on the desktop for all users. A typical path is
          C:\Documents and Settings\All Users\Desktop. Valid only for
          Windows NT systems.

   CSIDL_COMMON_DOCUMENTS (0x002e)
          The file system directory that contains documents that are
          common to all users. A typical paths is C:\Documents and
          Settings\All Users\Documents. Valid for Windows NT systems and
          Microsoft Windows 95 and Windows 98 systems with Shfolder.dll
          installed.

   CSIDL_COMMON_FAVORITES (0x001f)
          The file system directory that serves as a common repository
          for favorite items common to all users. Valid only for Windows
          NT systems.

   CSIDL_COMMON_MUSIC (0x0035)
          Version 6.0. The file system directory that serves as a
          repository for music files common to all users. A typical path
          is C:\Documents and Settings\All Users\Documents\My Music.

   CSIDL_COMMON_PICTURES (0x0036)
          Version 6.0. The file system directory that serves as a
          repository for image files common to all users. A typical path
          is C:\Documents and Settings\All Users\Documents\My Pictures.

   CSIDL_COMMON_PROGRAMS (0x0017)
          The file system directory that contains the directories for the
          common program groups that appear on the Start menu for all
          users. A typical path is C:\Documents and Settings\All
          Users\Start Menu\Programs. Valid only for Windows NT systems.

   CSIDL_COMMON_STARTMENU (0x0016)
          The file system directory that contains the programs and
          folders that appear on the Start menu for all users. A typical
          path is C:\Documents and Settings\All Users\Start Menu. Valid
          only for Windows NT systems.

   CSIDL_COMMON_STARTUP (0x0018)
          The file system directory that contains the programs that
          appear in the Startup folder for all users. A typical path is
          C:\Documents and Settings\All Users\Start
          Menu\Programs\Startup. Valid only for Windows NT systems.

   CSIDL_COMMON_TEMPLATES (0x002d)
          The file system directory that contains the templates that are
          available to all users. A typical path is C:\Documents and
          Settings\All Users\Templates. Valid only for Windows NT
          systems.

   CSIDL_COMMON_VIDEO (0x0037)
          Version 6.0. The file system directory that serves as a
          repository for video files common to all users. A typical path
          is C:\Documents and Settings\All Users\Documents\My Videos.

   CSIDL_CONTROLS (0x0003)
          The virtual folder containing icons for the Control Panel
          applications.

   CSIDL_COOKIES (0x0021)
          The file system directory that serves as a common repository
          for Internet cookies. A typical path is C:\Documents and
          Settings\username\Cookies.

   CSIDL_DESKTOP (0x0000)
          The virtual folder representing the Windows desktop, the root
          of the namespace.

   CSIDL_DESKTOPDIRECTORY (0x0010)
          The file system directory used to physically store file objects
          on the desktop (not to be confused with the desktop folder
          itself). A typical path is C:\Documents and
          Settings\username\Desktop.

   CSIDL_DRIVES (0x0011)
          The virtual folder representing My Computer, containing
          everything on the local computer: storage devices, printers,
          and Control Panel. The folder may also contain mapped network
          drives.

   CSIDL_FAVORITES (0x0006)
          The file system directory that serves as a common repository
          for the user's favorite items. A typical path is C:\Documents
          and Settings\username\Favorites.

   CSIDL_FONTS (0x0014)
          A virtual folder containing fonts. A typical path is
          C:\Windows\Fonts.

   CSIDL_HISTORY (0x0022)
          The file system directory that serves as a common repository
          for Internet history items.

   CSIDL_INTERNET (0x0001)
          A virtual folder representing the Internet.

   CSIDL_INTERNET_CACHE (0x0020)
          Version 4.72. The file system directory that serves as a common
          repository for temporary Internet files. A typical path is
          C:\Documents and Settings\username\Local Settings\Temporary
          Internet Files.

   CSIDL_LOCAL_APPDATA (0x001c)
          Version 5.0. The file system directory that serves as a data
          repository for local (nonroaming) applications. A typical path
          is C:\Documents and Settings\username\Local
          Settings\Application Data.

   CSIDL_MYDOCUMENTS (0x000c)
          Version 6.0. The virtual folder representing the My Documents
          desktop item.

   CSIDL_MYMUSIC (0x000d)
          The file system directory that serves as a common repository
          for music files. A typical path is C:\Documents and
          Settings\User\My Documents\My Music.

   CSIDL_MYPICTURES (0x0027)
          Version 5.0. The file system directory that serves as a common
          repository for image files. A typical path is C:\Documents and
          Settings\username\My Documents\My Pictures.

   CSIDL_MYVIDEO (0x000e)
          Version 6.0. The file system directory that serves as a common
          repository for video files. A typical path is C:\Documents and
          Settings\username\My Documents\My Videos.

   CSIDL_NETHOOD (0x0013)
          A file system directory containing the link objects that may
          exist in the My Network Places virtual folder. It is not the
          same as CSIDL_NETWORK, which represents the network namespace
          root. A typical path is C:\Documents and
          Settings\username\NetHood.

   CSIDL_NETWORK (0x0012)
          A virtual folder representing Network Neighborhood, the root of
          the network namespace hierarchy.

   CSIDL_PERSONAL (0x0005)
          Version 6.0. The virtual folder representing the My Documents
          desktop item. This is equivalent to CSIDL_MYDOCUMENTS.

          Previous to Version 6.0. The file system directory used to
          physically store a user's common repository of documents. A
          typical path is C:\Documents and Settings\username\My
          Documents. This should be distinguished from the virtual My
          Documents folder in the namespace. To access that virtual
          folder, use SHGetFolderLocation, which returns the ITEMIDLIST
          for the virtual location, or refer to the technique described
          in Managing the File System.

   CSIDL_PRINTERS (0x0004)
          The virtual folder containing installed printers.

   CSIDL_PRINTHOOD (0x001b)
          The file system directory that contains the link objects that
          can exist in the Printers virtual folder. A typical path is
          C:\Documents and Settings\username\PrintHood.

   CSIDL_PROFILE (0x0028)
          Version 5.0. The user's profile folder. A typical path is
          C:\Documents and Settings\username. Applications should not
          create files or folders at this level; they should put their
          data under the locations referred to by CSIDL_APPDATA or
          CSIDL_LOCAL_APPDATA.

   CSIDL_PROFILES (0x003e)
          Version 6.0. The file system directory containing user profile
          folders. A typical path is C:\Documents and Settings.

   CSIDL_PROGRAM_FILES (0x0026)
          Version 5.0. The Program Files folder. A typical path is
          C:\Program Files.

   CSIDL_PROGRAM_FILES_COMMON (0x002b)
          Version 5.0. A folder for components that are shared across
          applications. A typical path is C:\Program Files\Common. Valid
          only for Windows NT, Windows 2000, and Windows XP systems. Not
          valid for Windows Millennium Edition (Windows Me).

   CSIDL_PROGRAMS (0x0002)
          The file system directory that contains the user's program
          groups (which are themselves file system directories). A
          typical path is C:\Documents and Settings\username\Start
          Menu\Programs.

   CSIDL_RECENT (0x0008)
          The file system directory that contains shortcuts to the user's
          most recently used documents. A typical path is C:\Documents
          and Settings\username\My Recent Documents. To create a shortcut
          in this folder, use SHAddToRecentDocs. In addition to creating
          the shortcut, this function updates the Shell's list of recent
          documents and adds the shortcut to the My Recent Documents
          submenu of the Start menu.

   CSIDL_SENDTO (0x0009)
          The file system directory that contains Send To menu items. A
          typical path is C:\Documents and Settings\username\SendTo.

   CSIDL_STARTMENU (0x000b)
          The file system directory containing Start menu items. A
          typical path is C:\Documents and Settings\username\Start Menu.

   CSIDL_STARTUP (0x0007)
          The file system directory that corresponds to the user's
          Startup program group. The system starts these programs
          whenever any user logs onto Windows NT or starts Windows 95. A
          typical path is C:\Documents and Settings\username\Start
          Menu\Programs\Startup.

   CSIDL_SYSTEM (0x0025)
          Version 5.0. The Windows System folder. A typical path is
          C:\Windows\System32.

   CSIDL_TEMPLATES (0x0015)
          The file system directory that serves as a common repository
          for document templates. A typical path is C:\Documents and
          Settings\username\Templates.

   CSIDL_WINDOWS (0x0024)
          Version 5.0. The Windows directory or SYSROOT. This corresponds
          to the %windir% or %SYSTEMROOT% environment variables. A
          typical path is C:\Windows.

   Remarks

     These values supersede the use of environment variables for this
     purpose.

     A CSIDL is used in conjunction with one of four Shell functions,
     SHGetFolderLocation, SHGetFolderPath, SHGetSpecialFolderLocation,
     and SHGetSpecialFolderPath, to retrieve a special folder's path or
     pointer to an item identifier list (PIDL).

     Combine CSIDL_FLAG_CREATE with any of the other CSIDLs to force the
     creation of the associated folder. The remaining CSIDLs correspond
     to either file system folders or virtual folders. Where the CSIDL
     identifies a file system folder, a commonly used path is given as
     an example. Other paths may be used. Some CSIDLs can be mapped to
     an equivalent %VariableName% environment variable. CSIDLs are more
     reliable, however, and should be used if possible.

*/

#endif /* __win__ */