compile insert PS_FileSystem_Equates
/* 
   ** Copyright (C) 2013-2017 Revelation Software Inc. All Rights Reserved **
   
   Author   : Wile C Coyote - Super Genius
   Date     : May 2013
   Purpose  : Constants for working with the PS FILESYSTEM object 
   
   
   Comments
   ========
   
   
   Amended  Date       Reason
   =======  ====       ======
   Mr C     18 Oct 17  Added FILEOPRESULT error codes
   Mr C     13 Jun 17  Completed equates for all methods
   Mr C     01 Jun 17  Added COPYDIR, FILEOPRESULT equates
   Mr C     01 Feb 16  Added CHOOSEDIR equates
*/
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#ifndef _PS_FILESYSTEM_EQUATES_
#define _PS_FILESYSTEM_EQUATES_
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // GETSPECIALDIR method equates.  These are based on the CSIDL value used
   // with the SHGetSpecialFolderPath API function.
   // 
   //   http://msdn.microsoft.com/en-us/library/windows/desktop/bb762203(v=vs.85).aspx
   //   http://msdn.microsoft.com/en-us/library/windows/desktop/bb762494(v=vs.85).aspx
   
   equ PS_GSD_ADMINTOOLS$                to "ADMINTOOLS"
   equ PS_GSD_ALTSTARTUP$                to "ALTSTARTUP"
   equ PS_GSD_APPDATA$                   to "APPDATA"
   equ PS_GSD_COMMON_DESKTOPDIRECTORY$   to "COMMON_DESKTOPDIRECTORY"
   equ PS_GSD_COMMON_DOCUMENTS$          to "COMMON_DOCUMENTS"
   equ PS_GSD_COMMON_FAVORITES$          to "COMMON_FAVORITES"
   equ PS_GSD_COMMON_PROGRAMS$           to "COMMON_PROGRAMS"
   equ PS_GSD_COMMON_STARTMENU$          to "COMMON_STARTMENU"
   equ PS_GSD_COMMON_STARTUP$            to "COMMON_STARTUP"
   equ PS_GSD_COMMON_TEMPLATES$          to "COMMON_TEMPLATES"
   equ PS_GSD_COOKIES$                   to "COOKIES"
   equ PS_GSD_DESKTOPDIRECTORY$          to "DESKTOPDIRECTORY"
   equ PS_GSD_FAVORITES$                 to "FAVORITES"
   equ PS_GSD_FONTS$                     to "FONTS"
   equ PS_GSD_HISTORY$                   to "HISTORY"
   equ PS_GSD_INTERNET_CACHE$            to "INTERNET_CACHE"
   equ PS_GSD_LOCAL_APPDATA$             to "LOCAL_APPDATA"
   equ PS_GSD_MYMUSIC$                   to "MYMUSIC"
   equ PS_GSD_MYPICTURES$                to "MYPICTURES"
   equ PS_GSD_NETHOOD$                   to "NETHOOD"
   equ PS_GSD_PERSONAL$                  to "PERSONAL"                   ; * // "My Documents"
   equ PS_GSD_PRINTHOOD$                 to "PRINTHOOD"
   equ PS_GSD_PROFILE$                   to "PROFILE"
   equ PS_GSD_PROGRAM_FILES$             to "PROGRAM_FILES"
   equ PS_GSD_PROGRAM_FILES_COMMON$      to "PROGRAM_FILES_COMMON"
   equ PS_GSD_PROGRAMS$                  to "PROGRAMS"
   equ PS_GSD_RECENT$                    to "RECENT"
   equ PS_GSD_SENDTO$                    to "SENDTO"
   equ PS_GSD_STARTMENU$                 to "STARTMENU"
   equ PS_GSD_STARTUP$                   to "STARTUP"
   equ PS_GSD_SYSTEM$                    to "SYSTEM"
   equ PS_GSD_TEMPLATES$                 to "TEMPLATES"
   equ PS_GSD_WINDOWS$                   to "WINDOWS"
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // CHOOSEDIR method equates
   //
   //   folder = exec_Method( "FILESYSTEM", "CHOOSEDIR", ownerWindow, params )
   // 
   //   params<1> == Title
   //   params<2> == InitialDir
   //   params<3> == Hide New Folder button (1/0)
   //   params<4> == Show Files (1/0)
   
   equ PS_CHD_TITLE$                    to 1
   equ PS_CHD_INITIALDIR$               to 2
   equ PS_CHD_HIDENEWFOLDER$            to 3
   equ PS_CHD_SHOWFILES$                to 4
    
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // COPYDIR method equates
   //
   //    bCopied = exec_Method( "FILESYSTEM", "COPYDIR", dirFrom, dirTo, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_CPD_ALLOWUNDO$                to 1
   equ PS_CPD_ALLOWUI$                  to 2
   equ PS_CPD_PARENTWINDOW$             to 3
   equ PS_CPD_PROGRESSTITLE$            to 4
   equ PS_CPD_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // COPYFILES method equates
   //
   //    bCopied = exec_Method( "FILESYSTEM", "COPYFILES", filesFrom, filesTo, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_CPF_ALLOWUNDO$                to 1
   equ PS_CPF_ALLOWUI$                  to 2
   equ PS_CPF_PARENTWINDOW$             to 3
   equ PS_CPF_PROGRESSTITLE$            to 4
   equ PS_CPF_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // DELETEFILES method equates
   //
   //    bDeleted = exec_Method( "FILESYSTEM", "DELETEFILES", fileList, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_DLF_ALLOWUNDO$                to 1
   equ PS_DLF_ALLOWUI$                  to 2
   equ PS_DLF_PARENTWINDOW$             to 3
   equ PS_DLF_PROGRESSTITLE$            to 4
   equ PS_DLF_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // MOVEDIR method equates
   //
   //    bMoved = exec_Method( "FILESYSTEM", "MOVEDIR", dirFrom, dirTo, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_MVD_ALLOWUNDO$                to 1
   equ PS_MVD_ALLOWUI$                  to 2
   equ PS_MVD_PARENTWINDOW$             to 3
   equ PS_MVD_PROGRESSTITLE$            to 4
   equ PS_MVD_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // MOVEFILES method equates
   //
   //    bMoved = exec_Method( "FILESYSTEM", "MOVEFILES", filesFrom, filesTo, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_MVF_ALLOWUNDO$                to 1
   equ PS_MVF_ALLOWUI$                  to 2
   equ PS_MVF_PARENTWINDOW$             to 3
   equ PS_MVF_PROGRESSTITLE$            to 4
   equ PS_MVF_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // REMOVEDIR method equates
   //
   //    bRemoved = exec_Method( "FILESYSTEM", "REMOVEDIR", dirName, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_RMD_ALLOWUNDO$                to 1
   equ PS_RMD_ALLOWUI$                  to 2
   equ PS_RMD_PARENTWINDOW$             to 3
   equ PS_RMD_PROGRESSTITLE$            to 4
   equ PS_RMD_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // RENAMEDIR method equates
   //
   //    bRenamed = exec_Method( "FILESYSTEM", "RENAMEDIR", dirOldName, dirNewName, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_RND_ALLOWUNDO$                to 1
   equ PS_RND_ALLOWUI$                  to 2
   equ PS_RND_PARENTWINDOW$             to 3
   equ PS_RND_PROGRESSTITLE$            to 4
   equ PS_RND_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // RENAMEFILE method equates
   //
   //    bRenamed = exec_Method( "FILESYSTEM", "RENAMEFILE", fileOldName, fileNewName, params )
   //
   //    params<1> == Allow Undo (1/0)
   //    params<2> == Allow UI   (1/0)
   //    params<3> == ID of anchor window for UI
   //    params<4> == Progress Dialog title
   //    params<5> == Allow confirmations (only is AllowUI is set) (1/0)
   
   equ PS_RNF_ALLOWUNDO$                to 1
   equ PS_RNF_ALLOWUI$                  to 2
   equ PS_RNF_PARENTWINDOW$             to 3
   equ PS_RNF_PROGRESSTITLE$            to 4
   equ PS_RNF_ALLOWCONFIRM$             to 5
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

   // FILEOPRESULT property equates
   //
   //    <1> ErrorCode
   //    <2> ErrorText
   
   equ PS_FOR_ERRORCODE$                to 1
   equ PS_FOR_ERRORTEXT$                to 2
   
   // FILEOPRESULT error codes
   equ DE_SAMEFILE$           to 0x71;    // The source and destination files are the same file.
   equ DE_MANYSRC1DEST$       to 0x72;    // Multiple file paths were specified in the source buffer, but only one destination file path.
   equ DE_DIFFDIR$            to 0x73;    // Rename operation was specified but the destination path is a different directory. Use the move operation instead.
   equ DE_ROOTDIR$            to 0x74;    // The source is a root directory, which cannot be moved or renamed.
   equ DE_OPCANCELLED$        to 0x75;    // The operation was canceled by the user, or silently canceled if the appropriate flags were supplied.
   equ DE_DESTSUBTREE$        to 0x76;    // The destination is a subtree of the source.
   equ DE_ACCESSDENIEDSRC$    to 0x78;    // Security settings denied access to the source.
   equ DE_PATHTOODEEP$        to 0x79;    // The source or destination path exceeded or would exceed MAX_PATH.
   equ DE_MANYDEST$           to 0x7A;    // The operation involved multiple destination paths, which can fail in the case of a move operation.
   equ DE_INVALIDFILES$       to 0x7C;    // The path in the source or destination or both was invalid.
   equ DE_DESTSAMETREE$       to 0x7D;    // The source and destination have the same parent folder.
   equ DE_FLDDESTISFILE$      to 0x7E;    // The destination path is an existing file.
   equ DE_FILEDESTISFLD$      to 0x80;    // The destination path is an existing folder.
   equ DE_FILENAMETOOLONG$    to 0x81;    // The name of the file exceeds MAX_PATH.
   equ DE_DEST_IS_CDROM$      to 0x82;    // The destination is a read-only CD-ROM, possibly unformatted.
   equ DE_DEST_IS_DVD$        to 0x83;    // The destination is a read-only DVD, possibly unformatted. 
   equ DE_DEST_IS_CDRECORD$   to 0x84;    // The destination is a writable CD-ROM, possibly unformatted. 
   equ DE_FILE_TOO_LARGE$     to 0x85;    // The file involved in the operation is too large for the destination media or file system.
   equ DE_SRC_IS_CDROM$       to 0x86;    // The source is a read-only CD-ROM, possibly unformatted.
   equ DE_SRC_IS_DVD$         to 0x87;    // The source is a read-only DVD, possibly unformatted.
   equ DE_SRC_IS_CDRECORD$    to 0x88;    // The source is a writable CD-ROM, possibly unformatted.
   equ DE_ERROR_MAX$          to 0xB7;    // MAX_PATH was exceeded during the operation.
   equ DE_UNKNOWN_ERROR$      to 0x402;   // An unknown error occurred. This is typically due to an invalid path in the source or destination.
   equ DE_ERRORONDEST$        to 0x10000; // strError = _T( "An unspecified error occurred on the destination.
   equ DE_ROOTDIR_ERRORDEST$  to 0x10074; // Destination is a root directory and cannot be renamed.
   
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
#endif
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
