BGC.Utility.ReservedFiles Class Reference

Collaboration diagram for BGC.Utility.ReservedFiles:

Static Public Member Functions
static bool	ReserveFile (string path)
	Reserve a file so other processes won't use them More...
static bool	UnReserveFile (string path)
	UnReserve a file if found More...
static bool	IsFileReserved (string path)
	Returns if the path is currently reserved More...

Static Private Attributes
static HashSet< string >	files = new HashSet<string>()

Detailed Description

Definition at line 6 of file ReservedFiles.cs.

Member Function Documentation

IsFileReserved()

static bool BGC.Utility.ReservedFiles.IsFileReserved ( string  path )

inlinestatic

Returns if the path is currently reserved

Parameters

path

Returns

True if the file is reserved, false if not

Definition at line 47 of file ReservedFiles.cs.

        {
            return files.Contains(path);
        }

ReserveFile()

static bool BGC.Utility.ReservedFiles.ReserveFile ( string  path )

inlinestatic

Reserve a file so other processes won't use them

Parameters

path

Returns

True if the file was succesfully reserved

Definition at line 15 of file ReservedFiles.cs.

        {
            if (files.Contains(path) == false)
            {
                files.Add(path);
                return true;
            }

            return false;
        }

UnReserveFile()

static bool BGC.Utility.ReservedFiles.UnReserveFile ( string  path )

inlinestatic

UnReserve a file if found

Parameters

path

Returns

True if hte file was found and removed

Definition at line 31 of file ReservedFiles.cs.

        {
            if (files.Contains(path))
            {
                files.Remove(path);
                return true;
            }

            return false;
        }

Field Documentation

files

HashSet<string> BGC.Utility.ReservedFiles.files = new HashSet<string>()

staticprivate

Definition at line 8 of file ReservedFiles.cs.

---

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

• Utility/ReservedFiles.cs