Bin und Debug
This commit is contained in:
Developer01
182
Filesystem/bin/Debug/DigitalData.Modules.Filesystem.xml
Normal file
182
Filesystem/bin/Debug/DigitalData.Modules.Filesystem.xml
Normal file
@@ -0,0 +1,182 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>
|
||||
DigitalData.Modules.Filesystem
|
||||
</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:DigitalData.Modules.Filesystem.My.Resources.Resources">
|
||||
<summary>
|
||||
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DigitalData.Modules.Filesystem.My.Resources.Resources.ResourceManager">
|
||||
<summary>
|
||||
Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:DigitalData.Modules.Filesystem.My.Resources.Resources.Culture">
|
||||
<summary>
|
||||
Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
|
||||
Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DigitalData.Modules.Filesystem.FileContainer">
|
||||
<module>FileContainer</module>
|
||||
<version>0.0.0.2</version>
|
||||
<date>21.11.2018</date>
|
||||
<summary>
|
||||
File Container for securely saving files
|
||||
</summary>
|
||||
<dependencies>
|
||||
NLog, >= 4.5.8
|
||||
</dependencies>
|
||||
<params>
|
||||
LogConfig, DigitalData.Module.Logging.LogConfig
|
||||
A LogConfig object
|
||||
Password, String
|
||||
The Password to Encrypt
|
||||
Path, String
|
||||
The Path to save/load the container
|
||||
</params>
|
||||
<example>
|
||||
dim oContainer = Container.Create(logConfig, "pass", "E:\some.container")
|
||||
dim oContainer = Container.Load(logConfig, "pass", "E:\some.container")
|
||||
|
||||
dim oContainer = new Container(logConfig, "pass", "E:\some.container")
|
||||
oContainer.Save()
|
||||
|
||||
dim oContainer = new Container(logConfig, "pass", "E:\some.container")
|
||||
oContainer.Contents = oSomeData
|
||||
oContainer.Save()
|
||||
|
||||
dim oContainer = new Container(logConfig, "pass", "E:\some.container")
|
||||
oContainer.Load()
|
||||
dim oContents = oContainer.Contents
|
||||
|
||||
dim oContainer = new Container(logConfig, "pass", "E:\some.container")
|
||||
oContainer.Load()
|
||||
oContainer.Contents = oSomeOtherData
|
||||
oContainer.Save()
|
||||
oContainer.SaveAs("E:\some2.container")
|
||||
</example>
|
||||
</member>
|
||||
<member name="T:DigitalData.Modules.Filesystem.File">
|
||||
<module>File</module>
|
||||
<version>0.0.0.1</version>
|
||||
<date>11.10.2018</date>
|
||||
<summary>
|
||||
Module that provides variouse File operations
|
||||
</summary>
|
||||
<dependencies>
|
||||
NLog, >= 4.5.8
|
||||
</dependencies>
|
||||
<params>
|
||||
LogConfig, DigitalData.Module.Logging.LogConfig
|
||||
A LogConfig object
|
||||
</params>
|
||||
<props>
|
||||
</props>
|
||||
<example>
|
||||
</example>
|
||||
<remarks>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.GetChecksum(System.String)">
|
||||
<summary>
|
||||
Reads the file at `FilePath` and computes a SHA256 Hash from its contents
|
||||
</summary>
|
||||
<param name="FilePath"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.GetVersionedFilename(System.String)">
|
||||
<summary>
|
||||
Adds file version string to given filename `Destination` if that file already exists.
|
||||
</summary>
|
||||
<param name="Destination"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.GetVersionedString(System.String,System.Char)">
|
||||
<summary>
|
||||
Split String at version separator to:
|
||||
check if string is already versioned,
|
||||
get the string version of an already versioned string
|
||||
</summary>
|
||||
<example>
|
||||
Examples:
|
||||
test1.pdf --> test1 --> ['test1'] --> no fileversion
|
||||
test1~2.pdf --> test1~2 --> ['test1', '2'] --> version 2
|
||||
test1~12345~2.pdf --> test1~12345~2 --> ['test1', '12345', '2'] --> still version 2
|
||||
somestring~3 --> somestring~3 --> ['somestring', '3'] --> version 3
|
||||
</example>
|
||||
<param name="pString">The string to versioned</param>
|
||||
<param name="pSeparator">The character to split at</param>
|
||||
<returns>Tuple of string and version</returns>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.RemoveFiles(System.String,System.Int32,System.String,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Removes files in a directory filtered by filename, extension and last write date
|
||||
</summary>
|
||||
<param name="Path">The directory in which files will be deleted</param>
|
||||
<param name="FileKeepTime">Only delete files which are older than x days. Must be between 0 and 1000 days.</param>
|
||||
<param name="FileBaseName">A filename filter which will be checked</param>
|
||||
<param name="FileExtension">A file extension which will be checked</param>
|
||||
<param name="ContinueOnError">Should the function continue with deleting when a file could not be deleted?</param>
|
||||
<returns>True if all files were deleted or if no files were deleted, otherwise false</returns>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.CopyDirectory(System.String,System.String,System.Boolean)">
|
||||
<summary>
|
||||
Copied from https://docs.microsoft.com/en-us/dotnet/standard/io/how-to-copy-directories
|
||||
</summary>
|
||||
<param name="SourceDirName"></param>
|
||||
<param name="DestDirName"></param>
|
||||
<param name="CopySubDirs"></param>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.CreateDirectory(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Tries to create a directory and returns its path.
|
||||
Returns a temp path if `DirectoryPath` can not be created or written to.
|
||||
</summary>
|
||||
<param name="DirectoryPath">The directory to create</param>
|
||||
<param name="TestWriteAccess">Should a write access test be performed?</param>
|
||||
<returns>The used path</returns>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.File.TestFileIsLocked(System.String)">
|
||||
<summary>
|
||||
Checks if a file is locked, ie. in use by another process.
|
||||
</summary>
|
||||
<remarks>
|
||||
https://docs.microsoft.com/en-us/dotnet/standard/io/handling-io-errors
|
||||
https://stackoverflow.com/questions/876473/is-there-a-way-to-check-if-a-file-is-in-use
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:DigitalData.Modules.Filesystem.FileWatcher.HandleFileChanged(System.Object,System.IO.FileSystemEventArgs)">
|
||||
<summary>
|
||||
This may fire twice for a single save operation,
|
||||
see: https://blogs.msdn.microsoft.com/oldnewthing/20140507-00/?p=1053/
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DigitalData.Modules.Filesystem.FileWatcherFilters">
|
||||
<summary>
|
||||
Built-in filters for FileWatcher that are useful for correctly detecting changes on Office documents (currently Office 2016)
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DigitalData.Modules.Filesystem.FileWatcherFilters.BaseFileFilter">
|
||||
<summary>
|
||||
Base Filter that all filters must inherit from
|
||||
Provides two functions that may be overridden and some useful file extension lists
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DigitalData.Modules.Filesystem.FileWatcherFilters.TempFileFilter">
|
||||
<summary>
|
||||
Simple Filter that filters changes made on temporary files
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:DigitalData.Modules.Filesystem.FileWatcherFilters.OfficeFileFilter">
|
||||
<summary>
|
||||
Filter to detect changes on Office files
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user