Bin und Debug

This commit is contained in:
Developer01
2025-09-19 13:06:44 +02:00
parent 3901fdc3a5
commit 2332f64748
853 changed files with 2817295 additions and 0 deletions

Binary file not shown.

View File

@@ -0,0 +1,361 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Base
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Base.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Base.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.Base.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.Base.BaseClass">
<summary>
BaseClass that sets up a Logger.
</summary>
</member>
<member name="T:DigitalData.Modules.Base.Encryption">
<summary>
https://stackoverflow.com/questions/10168240/encrypting-decrypting-a-string-in-c-sharp
</summary>
</member>
<member name="M:DigitalData.Modules.Base.DatabaseEx.NotNull``1(System.Data.DataRow,System.String,``0)">
<summary>
TODO: Deprecate
Checks a Row value for three different `null` values,
Nothing, Empty String, DBNull
Returns the original value if the value is not null, or `defaultValue`
</summary>
<typeparam name="T">The type of the value</typeparam>
<param name="pRow">The DataRow that contains the value</param>
<param name="pColumn">The column name</param>
<param name="pDefaultValue">The default value</param>
<returns>The original value or the default value</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.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.Base.FilesystemEx.GetVersionedFilename(System.String)">
<summary>
Adds file version string to given filename `Destination` if that file already exists.
</summary>
<param name="pFilePath">Filepath to check</param>
<returns>Versioned string</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedFilenameWithFilecheck(System.String,System.Func{System.String,System.Boolean})">
<summary>
Adds file version string to given filename `Destination` if that file already exists.
</summary>
<param name="pFilePath">Filepath to check</param>
<param name="pFileExistsAction">Custom action to check for file existence</param>
<returns>Versioned string</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedString(System.String)">
<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>
<returns>Tuple of string and version</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.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.Base.FilesystemEx.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.Base.FilesystemEx.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.Base.FilesystemEx.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.Base.FilesystemEx.TestFileSizeIsLessThanMaxFileSize(System.String,System.Int32)">
<summary>
Checks the size of the supplied file.
</summary>
<param name="pFilePath"></param>
<param name="pMaxFileSizeInMegaBytes"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.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.Base.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.Base.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.Base.FileWatcherFilters.TempFileFilter">
<summary>
Simple Filter that filters changes made on temporary files
</summary>
</member>
<member name="T:DigitalData.Modules.Base.FileWatcherFilters.OfficeFileFilter">
<summary>
Filter to detect changes on Office files
</summary>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.Truncate(System.String,System.Int32)">
<summary>
Truncates a string to the specified length if it exceeds that length.
</summary>
<param name="pString">The string</param>
<param name="pLength">The maximum string length</param>
<returns>The truncated string</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.EscapeForSQL(System.String)">
<summary>
Replaces single quotes in text for SQL Commands.
</summary>
<param name="pString">The string</param>
<returns>The escaped string.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.ToBoolean(System.String)">
<summary>
Converts a string to boolean. Accepts true and 1 as truthy values
</summary>
<param name="pString">The input string</param>
<returns>True if input is true or 1, otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.IsNullOrEmpty(System.String)">
<summary>
Checks if a string is null or empty
</summary>
<param name="pString">The input string</param>
<returns>True string is null or empty, otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.IsNotNullOrEmpty(System.String)">
<summary>
Checks if a string is NOT null or empty
</summary>
<param name="pString">The input string</param>
<returns>True string is null or empty, otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.GetChecksumFromFileContents(System.String)">
<summary>
Reads the file at `FilePath` and computes a SHA256 Hash from its contents
</summary>
<param name="pFilePath"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.GetDateDirectory(System.String,System.DateTime)">
<summary>
Returns a Dictionary path in the form of [Base]\[Year]\[Month]\[Day]
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<param name="pDate">The date to be used</param>
<returns>The final directory path</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.GetDateDirectory(System.String)">
<summary>
Returns a Dictionary path in the form of [Base]\[Year]\[Month]\[Day] based on the current date
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<returns>The final directory path</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.CreateDateDirectory(System.String,System.DateTime)">
<summary>
Creates a Dictionary in the form of [Base]\[Year]\[Month]\[Day]
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<param name="pDate">The date to be used</param>
<returns>The created path. If the directory cannot be created, Nothing.</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.CreateDateDirectory(System.String)">
<summary>
Creates a Dictionary in the form of [Base]\[Year]\[Month]\[Day] based on the current date
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<returns>The created path. If the directory cannot be created, Nothing.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.NotNull``1(``0,``0)">
<summary>
Checks a value for three different `null` values,
Nothing, Empty String, DBNull
Returns the original value if the value is not null, or `defaultValue`
</summary>
<typeparam name="T">The type of the value</typeparam>
<param name="value">The value</param>
<param name="defaultValue">The default Value</param>
<returns>The original value or the default value</returns>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.ToEnum``1(System.String)">
<summary>
Converts a String value to the given Enum
</summary>
<typeparam name="T">The Enum Type</typeparam>
<param name="value">The string value to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.ToEnum``1(System.Int32)">
<summary>
Converts an Integer value to the given Enum
</summary>
<typeparam name="T">The Enum Type</typeparam>
<param name="value">The integer value to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.ToEnum``1(System.Int64)">
<summary>
Converts a Long value to the given Enum
</summary>
<typeparam name="T">The Enum Type</typeparam>
<param name="value">The long value to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.GraphicsEx.GetBrightness(System.Drawing.Color)">
<summary>
Returns the brightness of a color as a number between 0 and 1
</summary>
<param name="pColor">The color to check</param>
<returns>Low values for dark colors, high values for bright colors.</returns>
</member>
<member name="M:DigitalData.Modules.Base.GraphicsEx.GetContrastedColor(System.Drawing.Color)">
<summary>
Returns a foreground/text color of either black or white, depending on the brightness of `pOtherColor`
</summary>
<param name="pOtherColor">The Background color whose brightness is determined</param>
<returns>A text color which is either white or black</returns>
</member>
<member name="T:DigitalData.Modules.Base.LanguageEx">
<summary>
Functions relating to i18n, Cultures, Translations
</summary>
</member>
<member name="M:DigitalData.Modules.Base.LanguageEx.SetApplicationLanguage(DigitalData.Modules.Logging.Logger,System.String,System.String)">
<summary>
Sets the Language of the current thread by setting CurrentCulture and CurrentUICulture
</summary>
<param name="pLogger">A Logger instance</param>
<param name="pUserLanguage">A language code in the form of 'de-DE'</param>
<param name="pUserDateFormat">A custom date pattern</param>
</member>
<member name="M:DigitalData.Modules.Base.LanguageEx.LogApplicationLanguage(DigitalData.Modules.Logging.Logger)">
<summary>
Logs the culture settings of the current thread
</summary>
<param name="pLogger">A Logger instance</param>
</member>
<member name="M:DigitalData.Modules.Base.ScreenEx.IsVisibleOnAnyScreen(System.Drawing.Point)">
<summary>
Checks if a point is Visible on any screen
</summary>
</member>
<member name="M:DigitalData.Modules.Base.ScreenEx.SizeIsVisible(System.Drawing.Size)">
<summary>
Checks if Size is not negative
</summary>
</member>
<member name="M:DigitalData.Modules.Base.ScreenEx.LocationIsVisible(System.Drawing.Point)">
<summary>
Checks if Location is not negative
</summary>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.ConvertTextToSlug(System.String)">
<summary>
Creates a "slug" from text that can be used as part of a valid URL.
Invalid characters are converted to hyphens. Punctuation that Is
perfect valid in a URL Is also converted to hyphens to keep the
result mostly text. Steps are taken to prevent leading, trailing,
And consecutive hyphens.
</summary>
<param name="s">The string to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.RemoveInvalidCharacters(System.String)">
<summary>
Removes Invalid characters from a string, suitable for file and path names
Removed characters are:
* Illegal File-characters
* Illegal Path-characters
* Unicode characters that classify as Emoji
* All characters above codepoint U+10000
See:
https://stackoverflow.com/questions/46905176/detecting-all-emojis
https://stackoverflow.com/questions/28023682/how-do-i-remove-emoji-characters-from-a-string
</summary>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.GetShortGUID">
<summary>
Generates a random short (8 characters) guid
</summary>
<returns>The generated guid as a String</returns>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.TestContainsInvalidCharacters(System.String)">
<summary>
Checks if string contains invalid characters
</summary>
<param name="pString"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.GetChecksum(System.String)">
<summary>
Creates a hash using the SHA256 algorithm and returns it
</summary>
<param name="pStringToCheck">Any string</param>
<returns></returns>
</member>
</members>
</doc>

Binary file not shown.

View File

@@ -0,0 +1,200 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Logging
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Logging.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Logging.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.Logging.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.Logging.LogConfig">
<module>LogConfig</module>
<version>0.0.1.0</version>
<date>02.10.2018</date>
<summary>
Module that writes file-logs to different locations:
local application data, the current directory or a custom path.
Files and directories will be automatically created.
</summary>
<dependencies>
NLog, >= 4.5.8
</dependencies>
<example>
Imports DigitalData.Modules.Logging
Class FooProgram
Private Logger as Logger
Private LogConfig as LogConfig
Public Sub New()
LogConfig = new LogConfig(args)
Logger = LogConfig.GetLogger()
End Sub
Public Sub Bar()
Logger.Info("Baz")
End Sub
End Class
Class FooLib
Private Logger as NLog.Logger
Public Sub New(LogConfig as LogConfig)
Logger = LogConfig.GetLogger()
End Sub
Public Sub Bar()
Logger.Info("Baz")
End Sub
End Class
</example>
<remarks>
If logpath can not be written to, falls back to temp folder as defined in:
https://docs.microsoft.com/de-de/dotnet/api/system.io.path.gettemppath?view=netframework-4.7.2
If used in a service, LogPath must be set to CustomPath, otherwise the Log will be written to System32!
For NLog Troubleshooting, set the following Environment variables to write the NLog internal Log:
- NLOG_INTERNAL_LOG_LEVEL: Debug
- NLOG_INTERNAL_LOG_FILE: ex. C:\Temp\Nlog_Internal.log
</remarks>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogFactory">
<summary>
Returns the NLog.LogFactory object that is used to create Loggers
</summary>
<returns>LogFactory object</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogFile">
<summary>
Returns the path to the current default logfile
</summary>
<returns>Filepath to the logfile</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogDirectory">
<summary>
Returns the path to the current log directory
</summary>
<returns>Directory path to the log directory</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.Debug">
<summary>
Determines if a debug log will be written
</summary>
<returns>True, if debug log will be written. False otherwise.</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.Logs">
<summary>
Returns Logs in Memory as List(Of String) if Debug is enabled
Returns an empty list if debug is disabled
</summary>
<returns>A list of log messages</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogOptions)">
<summary>
Initializes a new LogConfig object with the options supplied as a LogOptions object
</summary>
<param name="Options"></param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogConfig.PathType,System.String,System.String,System.String,System.String,System.Int32)">
<summary>
Initializes a new LogConfig object with a logpath and optinally a filename-suffix.
</summary>
<param name="LogPath">The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.</param>
<param name="CustomLogPath">If `logPath` is set to custom, this defines the custom logPath.</param>
<param name="Suffix">If set to anything other than Nothing, extends the logfile name with this suffix.</param>
<param name="CompanyName">CompanyName is used to construct log-path in when LogPath is set to PathType:AppData</param>
<param name="ProductName">ProductName is used to construct log-path in when LogPath is set to PathType:AppData</param>
<param name="FileKeepRangeInDays">Amount of days where files are kept and not deleted.</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ClearOldLogfiles(System.Int32)">
<summary>
Clears old LogFiles from the configured logpath for compliance with the GDPR
</summary>
<param name="FileKeepRange">Days in which logfiles should be kept. All files older than `Now - FileKeepInterval` will be deleted.</param>
<returns>True, if files were deleted as expected or no files were deleted. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger">
<summary>
Returns the Logger for the calling class
</summary>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger(System.String)">
<summary>
Returns the Logger for the specified classname
</summary>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLoggerFor(System.String)">
<summary>
Returns the Logger for the specified module using event-properties
</summary>
<remarks>
https://github.com/NLog/NLog/wiki/EventProperties-Layout-Renderer
https://stackoverflow.com/questions/31337030/separate-log-file-for-specific-class-instance-using-nlog/32065824#32065824
</remarks>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger(System.String,System.String)">
<summary>
Returns the Logger for a class specified by `ClassName`
</summary>
<param name="ClassName">The name of the class the logger belongs to</param>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ClearLogs">
<summary>
Clears the internal log
</summary>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetClassFullName(System.Boolean,System.Int32)">
<summary>
Gets the fully qualified name of the class invoking the calling method,
including the namespace but Not the assembly.
</summary>
<returns>The fully qualified class name</returns>
<remarks>This method is very resource-intensive!</remarks>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetConfig(System.String,System.String)">
<summary>
Returns the initial log configuration
</summary>
<param name="productName">The chosen productname</param>
<param name="logFileSuffix">The chosen suffix</param>
<returns>A NLog.LoggingConfiguration object</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.AddDefaultRules(NLog.Config.LoggingConfiguration@)">
<summary>
Adds the default rules
</summary>
<param name="config">A NLog.LoggingConfiguration object</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetCurrentLogFilePath">
<summary>
Returns the full path of the current default log file.
</summary>
<returns>Full path of the current default log file</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ReloadConfig">
<summary>
Reconfigures and re-adds all loggers, optionally adding the debug rule.
</summary>
</member>
</members>
</doc>

Binary file not shown.

View File

@@ -0,0 +1,207 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Windream
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Windream.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Windream.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.Windream.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="M:DigitalData.Modules.Windream.ConnectionBuilder.WithSessionReconnect">
<summary>
Sets flag in Windream class to reconnect on lost connection
</summary>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithDriveLetter(System.String)">
<summary>
Sets the drive letter of windream drive, default is "W"
</summary>
<param name="driveLetter">The drive letter to use</param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithWindreamObjects(System.String)">
<summary>
Sets the drive letter to String.Empty, use \\windream\objects as Windream base path
</summary>
<param name="BasePath">The windream base path, eg. \\windream\objects</param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithWindreamObjects">
<summary>
Sets the drive letter to String.Empty, use \\windream\objects as Windream base path
</summary>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.With64BitSupport">
<summary>
Sets flag in Windream class to indicate 64-bit support
</summary>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithServerName(System.String)">
<summary>
Sets the servername in Windream class, overriding the client setting
</summary>
<param name="serverName"></param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithImpersonation(System.String,System.String,System.String)">
<summary>
Sets the username, password and domain in Windream class, overriding the client settings
</summary>
<param name="userName">The username used for the connection</param>
<param name="password">The password used for the connection</param>
<param name="domain">The domain used for the connection</param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.Connect">
<summary>
Creates a connection.
</summary>
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException">If there was an error while establishing the connection</exception>
<returns>A Windream Object</returns>
</member>
<member name="T:DigitalData.Modules.Windream.Windream">
<module>Windream</module>
<version>0.0.0.2</version>
<date>23.10.2018</date>
<summary>
Module that provides methods to access the Windream ECM
</summary>
<dependencies>
NLog, >= 4.5.8
</dependencies>
<params>
LogConfig, DigitalData.Modules.Logging.LogConfig
The LogFactory containing the current log config. Used to instanciate the class logger for this and any dependent class
ClientDriveLetter, String
Drive Letter of the Windream Drive, should default to `W`
ClientSupport64Bit, Boolean
Should this session support 64bit methods/functionality?
SessionReconnect, Boolean
Should the session reconnect automatically when the connection to the server is lost?
SessionServerName, String
Name of the server used in the connection. If this is `Nothing`, the current server defined in the client is used
SessionUserName, String
Name of the user that is used in the connection. If this is `Nothing`, the currently signed in user is used
SessionPassword, String
User-password that is used in the connection. If this is `Nothing`, the currently signed in user is used
SessionDomain, String
User-domain that is used in the connection. If this is `Nothing`, the currently signed in user is used
</params>
<props>
ClientDriveLetter, String (readonly)
ClientSupports64Bit, Boolean (readonly)
Session, IWMSession2 (readonly)
SessionLoggedin, Boolean (readonly)
SessionReconnect, Boolean (readonly)
SessionServername, String (readonly)
Objecttypes, List(Of String) (readonly)
</props>
<example>
_windream = New ConnectionBuilder(LogConfig).
WithDriveLetter("W").
WithSessionReconnect().
With64BitSupport().
WithServerName("sdd-vmx02-aps01").
Connect()
</example>
<remarks>
This class should not be instanciated directly. Instead, ConnectionBuilder should be used.
</remarks>
</member>
<member name="P:DigitalData.Modules.Windream.Windream.ObjectTypes">
<returns>A list of object types that are available</returns>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.#ctor(DigitalData.Modules.Logging.LogConfig,System.Boolean,System.String,System.String,System.Boolean,System.String,System.String,System.String,System.String)">
<summary>
Creates a new Windream object and connects to a server with the provided options and credentials
</summary>
<param name="LogConfig"></param>
<param name="SessionReconnect"></param>
<param name="ClientDriveLetter"></param>
<param name="ClientSupport64Bit"></param>
<param name="SessionServerName"></param>
<param name="SessionUserName"></param>
<param name="SessionPassword"></param>
<param name="SessionDomain"></param>
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException"></exception>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.NewLifecycle_Period(System.String,System.DateTime,System.Double,System.String)">
<summary>
changes the archive end date
</summary>
<param name="wmfilepath">WM Filepath</param>
<param name="date_period">number/count of period (if </param>
<param name="date_unit">date_unity (d,m,y or day(s),month(s),years(s)</param>
<param name="dateFrom_value">dateFrom_value</param>
<returns>Returns true when date was set, false if not</returns>
<remarks></remarks>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.NewLifecycle_PeriodTEST(System.String,System.String)">
<summary>
changes the archive end date
</summary>
<param name="wmfilepath">WM Filepath</param>
<param name="oArchUntil">number/count of period (if </param>
<returns>Returns true when date was set, false if not</returns>
<remarks></remarks>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.SetArchive_Active(WINDREAMLib.WMObject)">
<summary>
Archives windream object immediately
</summary>
<returns>Returns true when archiving was set, false if not</returns>
<remarks></remarks>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.GetSearchDocuments(System.String,System.String)">
<summary>
Returns the result of a search file
</summary>
<param name="SearchFilePath">Path of a search file (*.wdf)</param>
<param name="DocIdIndexName">Index containing the Document-ID</param>
<returns>A datatable of the results with columns PATH and DOCID</returns>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.GetVektorData_Combined(WINDREAMLib.WMObject,System.String,System.Object[],System.Boolean)">
<summary>
Gets an array of the actual vektorvalues of index, collated with the passed values
</summary>
<param name="WindreamObject">windream-file as WMObject</param>
<param name="IndexName">Indexname as String</param>
<param name="NewValues">The new values as Array</param>
<param name="CheckDuplikat">True if duplicates shall be prevented</param>
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException"></exception>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.SetFolderObjecttype(System.String,System.String)">
<summary>
Sets objecttype of a folder
</summary>
<param name="FolderPath"></param>
<param name="Objecttype"></param>
<returns></returns>
</member>
</members>
</doc>

Binary file not shown.

BIN
Windream/bin/Debug/NLog.dll Normal file

Binary file not shown.

28265
Windream/bin/Debug/NLog.xml Normal file

File diff suppressed because it is too large Load Diff

Binary file not shown.

View File

@@ -0,0 +1,361 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Base
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Base.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Base.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.Base.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.Base.BaseClass">
<summary>
BaseClass that sets up a Logger.
</summary>
</member>
<member name="T:DigitalData.Modules.Base.Encryption">
<summary>
https://stackoverflow.com/questions/10168240/encrypting-decrypting-a-string-in-c-sharp
</summary>
</member>
<member name="M:DigitalData.Modules.Base.DatabaseEx.NotNull``1(System.Data.DataRow,System.String,``0)">
<summary>
TODO: Deprecate
Checks a Row value for three different `null` values,
Nothing, Empty String, DBNull
Returns the original value if the value is not null, or `defaultValue`
</summary>
<typeparam name="T">The type of the value</typeparam>
<param name="pRow">The DataRow that contains the value</param>
<param name="pColumn">The column name</param>
<param name="pDefaultValue">The default value</param>
<returns>The original value or the default value</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.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.Base.FilesystemEx.GetVersionedFilename(System.String)">
<summary>
Adds file version string to given filename `Destination` if that file already exists.
</summary>
<param name="pFilePath">Filepath to check</param>
<returns>Versioned string</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedFilenameWithFilecheck(System.String,System.Func{System.String,System.Boolean})">
<summary>
Adds file version string to given filename `Destination` if that file already exists.
</summary>
<param name="pFilePath">Filepath to check</param>
<param name="pFileExistsAction">Custom action to check for file existence</param>
<returns>Versioned string</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedString(System.String)">
<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>
<returns>Tuple of string and version</returns>
</member>
<member name="M:DigitalData.Modules.Base.FilesystemEx.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.Base.FilesystemEx.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.Base.FilesystemEx.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.Base.FilesystemEx.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.Base.FilesystemEx.TestFileSizeIsLessThanMaxFileSize(System.String,System.Int32)">
<summary>
Checks the size of the supplied file.
</summary>
<param name="pFilePath"></param>
<param name="pMaxFileSizeInMegaBytes"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.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.Base.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.Base.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.Base.FileWatcherFilters.TempFileFilter">
<summary>
Simple Filter that filters changes made on temporary files
</summary>
</member>
<member name="T:DigitalData.Modules.Base.FileWatcherFilters.OfficeFileFilter">
<summary>
Filter to detect changes on Office files
</summary>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.Truncate(System.String,System.Int32)">
<summary>
Truncates a string to the specified length if it exceeds that length.
</summary>
<param name="pString">The string</param>
<param name="pLength">The maximum string length</param>
<returns>The truncated string</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.EscapeForSQL(System.String)">
<summary>
Replaces single quotes in text for SQL Commands.
</summary>
<param name="pString">The string</param>
<returns>The escaped string.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.ToBoolean(System.String)">
<summary>
Converts a string to boolean. Accepts true and 1 as truthy values
</summary>
<param name="pString">The input string</param>
<returns>True if input is true or 1, otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.IsNullOrEmpty(System.String)">
<summary>
Checks if a string is null or empty
</summary>
<param name="pString">The input string</param>
<returns>True string is null or empty, otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ModuleExtensions.IsNotNullOrEmpty(System.String)">
<summary>
Checks if a string is NOT null or empty
</summary>
<param name="pString">The input string</param>
<returns>True string is null or empty, otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.GetChecksumFromFileContents(System.String)">
<summary>
Reads the file at `FilePath` and computes a SHA256 Hash from its contents
</summary>
<param name="pFilePath"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.GetDateDirectory(System.String,System.DateTime)">
<summary>
Returns a Dictionary path in the form of [Base]\[Year]\[Month]\[Day]
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<param name="pDate">The date to be used</param>
<returns>The final directory path</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.GetDateDirectory(System.String)">
<summary>
Returns a Dictionary path in the form of [Base]\[Year]\[Month]\[Day] based on the current date
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<returns>The final directory path</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.CreateDateDirectory(System.String,System.DateTime)">
<summary>
Creates a Dictionary in the form of [Base]\[Year]\[Month]\[Day]
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<param name="pDate">The date to be used</param>
<returns>The created path. If the directory cannot be created, Nothing.</returns>
</member>
<member name="M:DigitalData.Modules.Base.FileEx.CreateDateDirectory(System.String)">
<summary>
Creates a Dictionary in the form of [Base]\[Year]\[Month]\[Day] based on the current date
</summary>
<param name="pBaseDirectory">The basedirectory</param>
<returns>The created path. If the directory cannot be created, Nothing.</returns>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.NotNull``1(``0,``0)">
<summary>
Checks a value for three different `null` values,
Nothing, Empty String, DBNull
Returns the original value if the value is not null, or `defaultValue`
</summary>
<typeparam name="T">The type of the value</typeparam>
<param name="value">The value</param>
<param name="defaultValue">The default Value</param>
<returns>The original value or the default value</returns>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.ToEnum``1(System.String)">
<summary>
Converts a String value to the given Enum
</summary>
<typeparam name="T">The Enum Type</typeparam>
<param name="value">The string value to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.ToEnum``1(System.Int32)">
<summary>
Converts an Integer value to the given Enum
</summary>
<typeparam name="T">The Enum Type</typeparam>
<param name="value">The integer value to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.ObjectEx.ToEnum``1(System.Int64)">
<summary>
Converts a Long value to the given Enum
</summary>
<typeparam name="T">The Enum Type</typeparam>
<param name="value">The long value to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.GraphicsEx.GetBrightness(System.Drawing.Color)">
<summary>
Returns the brightness of a color as a number between 0 and 1
</summary>
<param name="pColor">The color to check</param>
<returns>Low values for dark colors, high values for bright colors.</returns>
</member>
<member name="M:DigitalData.Modules.Base.GraphicsEx.GetContrastedColor(System.Drawing.Color)">
<summary>
Returns a foreground/text color of either black or white, depending on the brightness of `pOtherColor`
</summary>
<param name="pOtherColor">The Background color whose brightness is determined</param>
<returns>A text color which is either white or black</returns>
</member>
<member name="T:DigitalData.Modules.Base.LanguageEx">
<summary>
Functions relating to i18n, Cultures, Translations
</summary>
</member>
<member name="M:DigitalData.Modules.Base.LanguageEx.SetApplicationLanguage(DigitalData.Modules.Logging.Logger,System.String,System.String)">
<summary>
Sets the Language of the current thread by setting CurrentCulture and CurrentUICulture
</summary>
<param name="pLogger">A Logger instance</param>
<param name="pUserLanguage">A language code in the form of 'de-DE'</param>
<param name="pUserDateFormat">A custom date pattern</param>
</member>
<member name="M:DigitalData.Modules.Base.LanguageEx.LogApplicationLanguage(DigitalData.Modules.Logging.Logger)">
<summary>
Logs the culture settings of the current thread
</summary>
<param name="pLogger">A Logger instance</param>
</member>
<member name="M:DigitalData.Modules.Base.ScreenEx.IsVisibleOnAnyScreen(System.Drawing.Point)">
<summary>
Checks if a point is Visible on any screen
</summary>
</member>
<member name="M:DigitalData.Modules.Base.ScreenEx.SizeIsVisible(System.Drawing.Size)">
<summary>
Checks if Size is not negative
</summary>
</member>
<member name="M:DigitalData.Modules.Base.ScreenEx.LocationIsVisible(System.Drawing.Point)">
<summary>
Checks if Location is not negative
</summary>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.ConvertTextToSlug(System.String)">
<summary>
Creates a "slug" from text that can be used as part of a valid URL.
Invalid characters are converted to hyphens. Punctuation that Is
perfect valid in a URL Is also converted to hyphens to keep the
result mostly text. Steps are taken to prevent leading, trailing,
And consecutive hyphens.
</summary>
<param name="s">The string to convert</param>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.RemoveInvalidCharacters(System.String)">
<summary>
Removes Invalid characters from a string, suitable for file and path names
Removed characters are:
* Illegal File-characters
* Illegal Path-characters
* Unicode characters that classify as Emoji
* All characters above codepoint U+10000
See:
https://stackoverflow.com/questions/46905176/detecting-all-emojis
https://stackoverflow.com/questions/28023682/how-do-i-remove-emoji-characters-from-a-string
</summary>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.GetShortGUID">
<summary>
Generates a random short (8 characters) guid
</summary>
<returns>The generated guid as a String</returns>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.TestContainsInvalidCharacters(System.String)">
<summary>
Checks if string contains invalid characters
</summary>
<param name="pString"></param>
<returns></returns>
</member>
<member name="M:DigitalData.Modules.Base.StringEx.GetChecksum(System.String)">
<summary>
Creates a hash using the SHA256 algorithm and returns it
</summary>
<param name="pStringToCheck">Any string</param>
<returns></returns>
</member>
</members>
</doc>

Binary file not shown.

View File

@@ -0,0 +1,200 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Logging
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Logging.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Logging.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.Logging.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.Logging.LogConfig">
<module>LogConfig</module>
<version>0.0.1.0</version>
<date>02.10.2018</date>
<summary>
Module that writes file-logs to different locations:
local application data, the current directory or a custom path.
Files and directories will be automatically created.
</summary>
<dependencies>
NLog, >= 4.5.8
</dependencies>
<example>
Imports DigitalData.Modules.Logging
Class FooProgram
Private Logger as Logger
Private LogConfig as LogConfig
Public Sub New()
LogConfig = new LogConfig(args)
Logger = LogConfig.GetLogger()
End Sub
Public Sub Bar()
Logger.Info("Baz")
End Sub
End Class
Class FooLib
Private Logger as NLog.Logger
Public Sub New(LogConfig as LogConfig)
Logger = LogConfig.GetLogger()
End Sub
Public Sub Bar()
Logger.Info("Baz")
End Sub
End Class
</example>
<remarks>
If logpath can not be written to, falls back to temp folder as defined in:
https://docs.microsoft.com/de-de/dotnet/api/system.io.path.gettemppath?view=netframework-4.7.2
If used in a service, LogPath must be set to CustomPath, otherwise the Log will be written to System32!
For NLog Troubleshooting, set the following Environment variables to write the NLog internal Log:
- NLOG_INTERNAL_LOG_LEVEL: Debug
- NLOG_INTERNAL_LOG_FILE: ex. C:\Temp\Nlog_Internal.log
</remarks>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogFactory">
<summary>
Returns the NLog.LogFactory object that is used to create Loggers
</summary>
<returns>LogFactory object</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogFile">
<summary>
Returns the path to the current default logfile
</summary>
<returns>Filepath to the logfile</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.LogDirectory">
<summary>
Returns the path to the current log directory
</summary>
<returns>Directory path to the log directory</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.Debug">
<summary>
Determines if a debug log will be written
</summary>
<returns>True, if debug log will be written. False otherwise.</returns>
</member>
<member name="P:DigitalData.Modules.Logging.LogConfig.Logs">
<summary>
Returns Logs in Memory as List(Of String) if Debug is enabled
Returns an empty list if debug is disabled
</summary>
<returns>A list of log messages</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogOptions)">
<summary>
Initializes a new LogConfig object with the options supplied as a LogOptions object
</summary>
<param name="Options"></param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogConfig.PathType,System.String,System.String,System.String,System.String,System.Int32)">
<summary>
Initializes a new LogConfig object with a logpath and optinally a filename-suffix.
</summary>
<param name="LogPath">The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.</param>
<param name="CustomLogPath">If `logPath` is set to custom, this defines the custom logPath.</param>
<param name="Suffix">If set to anything other than Nothing, extends the logfile name with this suffix.</param>
<param name="CompanyName">CompanyName is used to construct log-path in when LogPath is set to PathType:AppData</param>
<param name="ProductName">ProductName is used to construct log-path in when LogPath is set to PathType:AppData</param>
<param name="FileKeepRangeInDays">Amount of days where files are kept and not deleted.</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ClearOldLogfiles(System.Int32)">
<summary>
Clears old LogFiles from the configured logpath for compliance with the GDPR
</summary>
<param name="FileKeepRange">Days in which logfiles should be kept. All files older than `Now - FileKeepInterval` will be deleted.</param>
<returns>True, if files were deleted as expected or no files were deleted. Otherwise false.</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger">
<summary>
Returns the Logger for the calling class
</summary>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger(System.String)">
<summary>
Returns the Logger for the specified classname
</summary>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLoggerFor(System.String)">
<summary>
Returns the Logger for the specified module using event-properties
</summary>
<remarks>
https://github.com/NLog/NLog/wiki/EventProperties-Layout-Renderer
https://stackoverflow.com/questions/31337030/separate-log-file-for-specific-class-instance-using-nlog/32065824#32065824
</remarks>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger(System.String,System.String)">
<summary>
Returns the Logger for a class specified by `ClassName`
</summary>
<param name="ClassName">The name of the class the logger belongs to</param>
<returns>An object of Logging.Logger</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ClearLogs">
<summary>
Clears the internal log
</summary>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetClassFullName(System.Boolean,System.Int32)">
<summary>
Gets the fully qualified name of the class invoking the calling method,
including the namespace but Not the assembly.
</summary>
<returns>The fully qualified class name</returns>
<remarks>This method is very resource-intensive!</remarks>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetConfig(System.String,System.String)">
<summary>
Returns the initial log configuration
</summary>
<param name="productName">The chosen productname</param>
<param name="logFileSuffix">The chosen suffix</param>
<returns>A NLog.LoggingConfiguration object</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.AddDefaultRules(NLog.Config.LoggingConfiguration@)">
<summary>
Adds the default rules
</summary>
<param name="config">A NLog.LoggingConfiguration object</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetCurrentLogFilePath">
<summary>
Returns the full path of the current default log file.
</summary>
<returns>Full path of the current default log file</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.ReloadConfig">
<summary>
Reconfigures and re-adds all loggers, optionally adding the debug rule.
</summary>
</member>
</members>
</doc>

Binary file not shown.

View File

@@ -0,0 +1,207 @@
<?xml version="1.0"?>
<doc>
<assembly>
<name>
DigitalData.Modules.Windream
</name>
</assembly>
<members>
<member name="T:DigitalData.Modules.Windream.My.Resources.Resources">
<summary>
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
</summary>
</member>
<member name="P:DigitalData.Modules.Windream.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.Windream.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="M:DigitalData.Modules.Windream.ConnectionBuilder.WithSessionReconnect">
<summary>
Sets flag in Windream class to reconnect on lost connection
</summary>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithDriveLetter(System.String)">
<summary>
Sets the drive letter of windream drive, default is "W"
</summary>
<param name="driveLetter">The drive letter to use</param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithWindreamObjects(System.String)">
<summary>
Sets the drive letter to String.Empty, use \\windream\objects as Windream base path
</summary>
<param name="BasePath">The windream base path, eg. \\windream\objects</param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithWindreamObjects">
<summary>
Sets the drive letter to String.Empty, use \\windream\objects as Windream base path
</summary>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.With64BitSupport">
<summary>
Sets flag in Windream class to indicate 64-bit support
</summary>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithServerName(System.String)">
<summary>
Sets the servername in Windream class, overriding the client setting
</summary>
<param name="serverName"></param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.WithImpersonation(System.String,System.String,System.String)">
<summary>
Sets the username, password and domain in Windream class, overriding the client settings
</summary>
<param name="userName">The username used for the connection</param>
<param name="password">The password used for the connection</param>
<param name="domain">The domain used for the connection</param>
<returns>A IConnectionBuilder instance to allow for chaining</returns>
</member>
<member name="M:DigitalData.Modules.Windream.ConnectionBuilder.Connect">
<summary>
Creates a connection.
</summary>
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException">If there was an error while establishing the connection</exception>
<returns>A Windream Object</returns>
</member>
<member name="T:DigitalData.Modules.Windream.Windream">
<module>Windream</module>
<version>0.0.0.2</version>
<date>23.10.2018</date>
<summary>
Module that provides methods to access the Windream ECM
</summary>
<dependencies>
NLog, >= 4.5.8
</dependencies>
<params>
LogConfig, DigitalData.Modules.Logging.LogConfig
The LogFactory containing the current log config. Used to instanciate the class logger for this and any dependent class
ClientDriveLetter, String
Drive Letter of the Windream Drive, should default to `W`
ClientSupport64Bit, Boolean
Should this session support 64bit methods/functionality?
SessionReconnect, Boolean
Should the session reconnect automatically when the connection to the server is lost?
SessionServerName, String
Name of the server used in the connection. If this is `Nothing`, the current server defined in the client is used
SessionUserName, String
Name of the user that is used in the connection. If this is `Nothing`, the currently signed in user is used
SessionPassword, String
User-password that is used in the connection. If this is `Nothing`, the currently signed in user is used
SessionDomain, String
User-domain that is used in the connection. If this is `Nothing`, the currently signed in user is used
</params>
<props>
ClientDriveLetter, String (readonly)
ClientSupports64Bit, Boolean (readonly)
Session, IWMSession2 (readonly)
SessionLoggedin, Boolean (readonly)
SessionReconnect, Boolean (readonly)
SessionServername, String (readonly)
Objecttypes, List(Of String) (readonly)
</props>
<example>
_windream = New ConnectionBuilder(LogConfig).
WithDriveLetter("W").
WithSessionReconnect().
With64BitSupport().
WithServerName("sdd-vmx02-aps01").
Connect()
</example>
<remarks>
This class should not be instanciated directly. Instead, ConnectionBuilder should be used.
</remarks>
</member>
<member name="P:DigitalData.Modules.Windream.Windream.ObjectTypes">
<returns>A list of object types that are available</returns>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.#ctor(DigitalData.Modules.Logging.LogConfig,System.Boolean,System.String,System.String,System.Boolean,System.String,System.String,System.String,System.String)">
<summary>
Creates a new Windream object and connects to a server with the provided options and credentials
</summary>
<param name="LogConfig"></param>
<param name="SessionReconnect"></param>
<param name="ClientDriveLetter"></param>
<param name="ClientSupport64Bit"></param>
<param name="SessionServerName"></param>
<param name="SessionUserName"></param>
<param name="SessionPassword"></param>
<param name="SessionDomain"></param>
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException"></exception>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.NewLifecycle_Period(System.String,System.DateTime,System.Double,System.String)">
<summary>
changes the archive end date
</summary>
<param name="wmfilepath">WM Filepath</param>
<param name="date_period">number/count of period (if </param>
<param name="date_unit">date_unity (d,m,y or day(s),month(s),years(s)</param>
<param name="dateFrom_value">dateFrom_value</param>
<returns>Returns true when date was set, false if not</returns>
<remarks></remarks>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.NewLifecycle_PeriodTEST(System.String,System.String)">
<summary>
changes the archive end date
</summary>
<param name="wmfilepath">WM Filepath</param>
<param name="oArchUntil">number/count of period (if </param>
<returns>Returns true when date was set, false if not</returns>
<remarks></remarks>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.SetArchive_Active(WINDREAMLib.WMObject)">
<summary>
Archives windream object immediately
</summary>
<returns>Returns true when archiving was set, false if not</returns>
<remarks></remarks>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.GetSearchDocuments(System.String,System.String)">
<summary>
Returns the result of a search file
</summary>
<param name="SearchFilePath">Path of a search file (*.wdf)</param>
<param name="DocIdIndexName">Index containing the Document-ID</param>
<returns>A datatable of the results with columns PATH and DOCID</returns>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.GetVektorData_Combined(WINDREAMLib.WMObject,System.String,System.Object[],System.Boolean)">
<summary>
Gets an array of the actual vektorvalues of index, collated with the passed values
</summary>
<param name="WindreamObject">windream-file as WMObject</param>
<param name="IndexName">Indexname as String</param>
<param name="NewValues">The new values as Array</param>
<param name="CheckDuplikat">True if duplicates shall be prevented</param>
<exception cref="T:DigitalData.Modules.Windream.Exceptions.SessionException"></exception>
</member>
<member name="M:DigitalData.Modules.Windream.Windream.SetFolderObjecttype(System.String,System.String)">
<summary>
Sets objecttype of a folder
</summary>
<param name="FolderPath"></param>
<param name="Objecttype"></param>
<returns></returns>
</member>
</members>
</doc>

Binary file not shown.

Binary file not shown.

28265
Windream/bin/Release/NLog.xml Normal file

File diff suppressed because it is too large Load Diff