Interface IFileAccess

Namespace: SuperOffice.IO.Files
Assembly: SoCore.dll
Syntax
public interface IFileAccess

Properties

ArchivePath

Declaration
string ArchivePath { get; }
Property Value
Type Description
String

TemplatesPath

Declaration
string TemplatesPath { get; }
Property Value
Type Description
String

TemporaryPath

Declaration
string TemporaryPath { get; }
Property Value
Type Description
String

Methods

CreateDirectoryIfNotExists(String)

Declaration
void CreateDirectoryIfNotExists(string path)
Parameters
Type Name Description
String path

CreateForWrite(String)

Declaration
Stream CreateForWrite(string path)
Parameters
Type Name Description
String path
Returns
Type Description
Stream

DirectoryExists(String)

Declaration
bool DirectoryExists(string path)
Parameters
Type Name Description
String path
Returns
Type Description
Boolean

DirectoryGetFileInfos(String)

Declaration
SoFileInfo[] DirectoryGetFileInfos(string path)
Parameters
Type Name Description
String path
Returns
Type Description
SoFileInfo[]

DirectoryGetFiles(String, String, Boolean)

Declaration
string[] DirectoryGetFiles(string path, string searchPattern, bool searchInSubdirectories = false)
Parameters
Type Name Description
String path
String searchPattern
Boolean searchInSubdirectories
Returns
Type Description
String[]

EnsureAccess(Action)

Impersonation for Windows Disk File Access. For Azure File Access this is a noop.

Declaration
void EnsureAccess(Action action)
Parameters
Type Name Description
Action action

EnsureAccess<T>(Func<T>)

Impersonation for Windows Disk File Access. For Azure File Access this is a noop.

Declaration
T EnsureAccess<T>(Func<T> func)
Parameters
Type Name Description
Func<T> func
Returns
Type Description
T
Type Parameters
Name Description
T

FileDelete(String)

Declaration
void FileDelete(string path)
Parameters
Type Name Description
String path

FileExists(String)

Declaration
bool FileExists(string path)
Parameters
Type Name Description
String path
Returns
Type Description
Boolean

GetDirectoryName(String)

Declaration
string GetDirectoryName(string path)
Parameters
Type Name Description
String path
Returns
Type Description
String

GetFileName(String)

Declaration
string GetFileName(string path)
Parameters
Type Name Description
String path
Returns
Type Description
String

GetFileNameWithoutExtension(String)

Declaration
string GetFileNameWithoutExtension(string path)
Parameters
Type Name Description
String path
Returns
Type Description
String

OpenReadOnlyNoLock(String)

Open a file/blob for reading

Declaration
Stream OpenReadOnlyNoLock(string path)
Parameters
Type Name Description
String path
Returns
Type Description
Stream
Remarks

Will call System.IO.File.Open() or Azure.Storage.Blobs.BlobClient.OpenRead()

Exceptions
Type Condition
SoFileNotFoundException

Wraps System.IO.FileNotFoundException and Azure.RequestFailedException when Status is 404. Check for SoFileNotFoundException instead of doing FileExists before call to this method.

PathCombine(String[])

Declaration
string PathCombine(params string[] paths)
Parameters
Type Name Description
String[] paths
Returns
Type Description
String

PathGetExtension(String)

Declaration
string PathGetExtension(string path)
Parameters
Type Name Description
String path
Returns
Type Description
String

PathGetFileName(String)

Declaration
string PathGetFileName(string path)
Parameters
Type Name Description
String path
Returns
Type Description
String

PathGetInvalidFileNameChars()

Declaration
char[] PathGetInvalidFileNameChars()
Returns
Type Description
Char[]

SaveStreamToFile(Stream, String)

Save a stream to file/blob

Declaration
void SaveStreamToFile(Stream stream, string path)
Parameters
Type Name Description
Stream stream
String path
Remarks

Will call System.IO.File.Create() or Azure.Storage.Blobs.BlobClient.Upload(), both implementations will overwrite any existing file/blob.

Extension Methods

EnumUtil.MapEnums<From, To>(From)