BrawlLib.BrawlManagerLib.FileOperations Class Reference

A modification of David Amenta's RecycleBin code More...

Public Types
enum	FileOperationFlags : ushort
	Possible flags for the SHFileOperation method. More...
enum	FileOperationType : uint
	File Operation Function Type for SHFileOperation More...

Static Public Member Functions
static bool	Copy (string path1, string path2, bool deleteFirst=false, bool confirmOverwrite=true)
static bool	Rename (string path1, string path2)
static bool	Delete (string path, FileOperationFlags flags)
	Send file to recycle bin More...
static bool	Delete (string path)
	Send file to recycle bin; display warning if files are too big to fit (FOF_WANTNUKEWARNING) More...
static string	SanitizeFilename (string filename)

Detailed Description

A modification of David Amenta's RecycleBin code

Member Enumeration Documentation

FileOperationFlags

enum BrawlLib.BrawlManagerLib.FileOperations.FileOperationFlags : ushort

Possible flags for the SHFileOperation method.

        {
            FOF_ALLOWUNDO = 0x0040,
 
            FOF_FILESONLY = 0x0080,
 
            FOF_NOCONFIRMATION = 0x0010,
 
            FOF_NOCONFIRMMKDIR = 0x0200,
 
            FOF_NO_CONNECTED_ELEMENTS = 0x2000,
 
            FOF_NOCOPYSECURITYATTRIBS = 0x0800,
 
            FOF_NOERRORUI = 0x0400,
 
            FOF_NORECURSION = 0x1000,
 
            FOF_RENAMEONCOLLISION = 0x0008,
 
            FOF_SILENT = 0x0004,
 
            FOF_WANTNUKEWARNING = 0x4000
 
            /*            /// <summary>
                        FOFX_ADDUNDORECORD = 0x20000000,
                        FOFX_NOSKIPJUNCTIONS = 0x00010000,
                        FOFX_PREFERHARDLINK = 0x00020000,
                        FOFX_SHOWELEVATIONPROMPT = 0x00040000,
                        FOFX_EARLYFAILURE = 0x00100000,
                        FOFX_PRESERVEFILEEXTENSIONS = 0x00200000,
                        FOFX_KEEPNEWERFILE = 0x00400000,
                        FOFX_NOCOPYHOOKS = 0x00800000,
                        FOFX_NOMINIMIZEBOX = 0x01000000,
                        FOFX_MOVEACLSACROSSVOLUMES = 0x02000000,
                        FOFX_DONTDISPLAYSOURCEPATH = 0x04000000,
                        FOFX_DONTDISPLAYDESTPATH = 0x08000000,
                        FOFX_RECYCLEONDELETE = 0x00080000,
                        FOFX_REQUIREELEVATION = 0x10000000,
                        FOFX_COPYASDOWNLOAD = 0x40000000,
                        FOFX_DONTDISPLAYLOCATIONS = 0x80000000,*/
        }

FileOperationType

enum BrawlLib.BrawlManagerLib.FileOperations.FileOperationType : uint

File Operation Function Type for SHFileOperation

        {
            FO_MOVE = 0x0001,
 
            FO_COPY = 0x0002,
 
            FO_DELETE = 0x0003,
 
            FO_RENAME = 0x0004
        }

Member Function Documentation

Copy()

static bool BrawlLib.BrawlManagerLib.FileOperations.Copy ( string  path1, string  path2, bool  deleteFirst = false, bool  confirmOverwrite = true  )

inlinestatic

        {
            if (File.Exists(path2) && confirmOverwrite)
            {
                using (CopyDialog dialog = new CopyDialog(path2, path1) {Text = "Copy"})
                {
                    DialogResult r = dialog.ShowDialog();
                    if (r != DialogResult.Yes)
                    {
                        return false;
                    }
                }
            }
 
            string dir = Path.GetDirectoryName(path2);
            if (!Directory.Exists(dir))
            {
                Directory.CreateDirectory(dir);
            }
 
            if (deleteFirst)
            {
                File.Delete(path2);
            }
 
            File.Copy(path1, path2, true);
            return true;
        }

Delete() [1/2]

static bool BrawlLib.BrawlManagerLib.FileOperations.Delete ( string  path )

inlinestatic

Send file to recycle bin; display warning if files are too big to fit (FOF_WANTNUKEWARNING)

Parameters

path	Location of directory or file to recycle

        {
            return Delete(path, FileOperationFlags.FOF_WANTNUKEWARNING);
        }

Delete() [2/2]

static bool BrawlLib.BrawlManagerLib.FileOperations.Delete ( string  path, FileOperationFlags  flags  )

inlinestatic

Send file to recycle bin

Parameters

path	Location of directory or file to recycle
flags	FileOperationFlags to add in addition to FOF_ALLOWUNDO

        {
            try
            {
                if (IsWOW64Process())
                {
                    SHFILEOPSTRUCT_x64 fs = new SHFILEOPSTRUCT_x64();
                    fs.wFunc = FileOperationType.FO_DELETE;
                    // important to double-terminate the string.
                    fs.pFrom = path + '\0' + '\0';
                    fs.fFlags = FileOperationFlags.FOF_ALLOWUNDO | flags;
                    SHFileOperation_x64(ref fs);
                }
                else
                {
                    SHFILEOPSTRUCT_x86 fs = new SHFILEOPSTRUCT_x86();
                    fs.wFunc = FileOperationType.FO_DELETE;
                    // important to double-terminate the string.
                    fs.pFrom = path + '\0' + '\0';
                    fs.fFlags = FileOperationFlags.FOF_ALLOWUNDO | flags;
                    SHFileOperation_x86(ref fs);
                }
 
                return true;
            }
            catch
            {
                return false;
            }
        }

Rename()

static bool BrawlLib.BrawlManagerLib.FileOperations.Rename ( string  path1, string  path2  )

inlinestatic

        {
            if (string.Equals(path1, path2, StringComparison.InvariantCultureIgnoreCase))
            {
                return true;
            }
 
            if (File.Exists(path2))
            {
                using (CopyDialog dialog = new CopyDialog(path2, path1) {Text = "Move"})
                {
                    DialogResult r = dialog.ShowDialog();
                    if (r == DialogResult.Yes)
                    {
                        File.Delete(path2);
                    }
                    else
                    {
                        return false;
                    }
                }
            }
 
            File.Move(path1, path2);
            return true;
        }

SanitizeFilename()

static string BrawlLib.BrawlManagerLib.FileOperations.SanitizeFilename ( string  filename )

inlinestatic

        {
            string invalidChars =
                System.Text.RegularExpressions.Regex.Escape(new string(Path.GetInvalidFileNameChars()));
            string invalidRegStr = string.Format(@"([{0}]*\.+$)|([{0}]+)", invalidChars);
 
            return System.Text.RegularExpressions.Regex.Replace(filename, invalidRegStr, "_");
        }

---

The documentation for this class was generated from the following file:

• BrawlLib/BrawlManagerLib/FileOperations.cs