====== Modul Common ======
Enthält viele Mathematische Funktionen für Berechnungen.\\
Datei ''Reitec.Confit.Module.Common.dll''

===== Konfiguration =====
==== Projekt ====
^ ^^Offline^Online^
|MODULES|| | |
| |COMMONFUNCTIONS|Reitec.Confit.Module.Common|Reitec.Confit.Module.Common|
Siehe auch Abschnitt [[de:confit:usage#projekteinstellungen|Bedienung - Projekteinstellungen]]

===== String Funktionen =====

==== CheckLength ====
Prüft ob die Länge der Zeichnfolge kleiner der angegebenen Länge ist\\
  CheckLength (Value As ICFTLocalValue, Length As Integer) As Boolean

^Parameter^Datentyp^Beschreibung^
|Value|Parameter, Attribut| Parameter oder Attribut vom Typ String|
|Length|Integer| Länge|
|Rückgabe|Boolean| Inhalt von Parameter oder Attribut < Länge|

==== CheckLength2 ====
Prüft ob die Länge der Zeichnfolge kleiner der angegebenen Länge ist\\
  CheckLength (Value As String, Length As Integer) As Boolean

^Parameter^Datentyp^Beschreibung^
|Value|String| Zeichnfolge |
|Length|Integer| Länge|
|Rückgabe|Boolean| Länge der Zeichnfolge < Länge|

==== CheckLengthEquals ====
Prüft ob die Länge der Zeichnfolge gleich der angegebenen Länge ist\\
  CheckLengthEquals (Value As String, Length As Integer) As Boolean

^Parameter^Datentyp^Beschreibung^
|Value|String| Zeichnfolge |
|Length|Integer| Länge|
|Rückgabe|Boolean| Länge der Zeichnfolge = Länge|


==== CopyToClipboard ====
Kopiert eine Zeichnfolge in die Zwischenablage\\
  CopyToClipboard(Value As String)

^Parameter^Datentyp^Beschreibung^
|Value|String| Zeichnfolge |

==== Debug ====
Schreibt eine Zeichnfolge in die Debugausgabe\\
  Debug(Value As String)

^Parameter^Datentyp^Beschreibung^
|Value|String| Zeichnfolge |


==== FormatStr ====
Formatiert eine Fließkommazahl mit dem angegebenen Format\\
  FormatStr(LocalValue As Double, ByVal FormatString As String) As String

^Parameter^Datentyp^Beschreibung^
|LocalValue |Double| Fließkommazahl |
|FormatString |String| Zahlenformat (vgl. Formatierung von Zahlen in .NET)|
|Rückgabe|String| Zeichnfolge der Fließkommazahl|

==== IsNumeric ====
Prüft ob sich die angegebene Zeichenfolge in eine Zahl verwandeln lässt\\
  IsNumeric(Text As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|Text|String| Zeichnfolge |
|Rückgabe|Boolean| Zeichnfolge lässt sich in Zahl umwandeln|

==== StartSplit ====
Zerlegt die gegebene Zeichenfolge anahnd des angegebenen Trennzeichens\\
  StartSplit(Text As String, Separator As String)

^Parameter^Datentyp^Beschreibung^
|Text |String| Zeichnfolge die Zerlegt werden soll|
|Separator |String| Trennzeichen zum Zerlegen der Zeichenfolge|

==== SplitCount ====
Gibt die Anzahl der Zeichenteile nach der Zerlegung mit StartSplit zurück\\
  SplitCount() As Integer

^Parameter^Datentyp^Beschreibung^
|Rückgabe|String| Anzahl der Zeichenteile |

==== SplitByIndex ====
Gibt den Zeichenteil der Zerlegung mit StartSplit für den angegebenen Index zurück\\
  SplitByIndex(Index As Integer) As String

^Parameter^Datentyp^Beschreibung^
|Index|Integer| Indes des Zeichenteils beginnend mit 1|
|Rückgabe|String| Zeichenteil für den angegeben Index oder eine leere Zeichenfolge, wenn kein Zeichenteil am Index vorhanden|

==== SplitLast====
Gibt den letzten Zeichenteil der Zerlegung mit StartSplit zurück\\
  SplitLast() As String

^Parameter^Datentyp^Beschreibung^
|Rückgabe|String| Letzter Zeichenteil oder eine leere Zeichenfolge, wenn keine Zeichenteil vorhandenn sind|

==== SplitStartsWith ====
Gibt den ersten Zeichenteil der Zerlegung mit StartSplit zurück, der mit einer bestimmten Zeichenfolge beginnt. Die Suche kann durch die Angabe eienes Startindex eingeschränkt werden\\
  SplitStartsWith(Pattern As String, StartIndex As Integer) As String

^Parameter^Datentyp^Beschreibung^
|Pattern|String| Zeichenfolge mit dem der Zeichenteil beginnen soll (Case-Sensitive!)|
|StartIndex|Integer| Start Index des Zeichenteils beginnend mit 1 von dem an gesucht werden soll|
|Rückgabe|String| Zeichenteil doder eine leere Zeichenfolge, wenn kein Zeichenteil vorhanden ist, der den Bedingungen entspricht|


==== StartsWith ====
Prüft ob die angegebene Zeichenfolge mit einer bestimmten Zeichenfolge beginnt\\
  StartsWith(Input As String, Pattern As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|Input |String| Zeichnfolge |
|Pattern |String| Zeichnfolge mit dem die Input Zeichenfolge beginnen soll (Case-Insensitive!) |
|Rückgabe|Boolean| Zeichnfolge beginnt mit Pattern|

==== SubString ====
Gibt den Zeichenteil der Zeichenfolge beginnend mit dem Startindex und mit der angegebenen Länge zurück\\
  SubString(Text As String, Start As Integer, Length As Integer) As String

^Parameter^Datentyp^Beschreibung^
|Text |String| Zeichenfolge|
|Start |Integer| Start Index des Zeichenteils beginnend mit 1|
|Length |Integer| Längedes Zeichenteils|
|Rückgabe|String| Zeichenteil oder die gesamte Zeichenfolge, wenn Start + Länge gößer wie die Länge der Zeichenfolge ist|


==== SubstStr====
Ersetzt eienen Zeichenteil der Zeichenfolge mit einem anderen Zeichenteil\\
  SubstStr(ByVal Input As String, ByVal Pattern As String, ByVal Replacement As String) As String

^Parameter^Datentyp^Beschreibung^
|Input |String| Zeichenfolge|
|Pattern |String| Zeichenteil der ersetzt werden soll (Case-Sensitive!)|
|Replacement |String| Zeichenteil mit dem der Zeichenteil Pattern ersetzt wedeb soll|
|Rückgabe|String| Zeichenfolge mit dem ersetzten Zeichenteil|

==== SubstStr2 ====
Ersetzt eienen Zeichenteil der Zeichenfolge mit einem anderen Zeichenteil\\
  SubstStr2(Input As String, Pattern As String, Replacement As String, CaseSensitve As Boolean) As String

^Parameter^Datentyp^Beschreibung^
|Input |String| Zeichenfolge|
|Pattern |String| Zeichenteil der ersetzt werden soll|
|Replacement |String| Zeichenteil mit dem der Zeichenteil Pattern ersetzt wedeb soll|
|CaseSensitve |Boolean| Wenn True, dann wird Groß- und Kleinschreibung unterschieden|
|Rückgabe|String| Zeichenfolge mit dem ersetzten Zeichenteil|

==== SubstStr3 ====
Ersetzt eienen Zeichenteil der Zeichenfolge, welcher durch einen regulären Ausdruck ermittelt wird,  mit einem anderen Zeichenteil\\
  SubstStr3(Input As String, Pattern As String, Replacement As String, CaseSensitve As Boolean) As String

^Parameter^Datentyp^Beschreibung^
|Input |String| Zeichenfolge|
|Pattern |String| Regulären Ausdruck mit dem der Zeichenteil gefunden wird (.vgl. Reguläre Ausdrüche in .NET)|
|Replacement |String| Zeichenteil mit dem der Zeichenteil Pattern ersetzt wedeb soll|
|CaseSensitve |Boolean| Wenn True, dann wird Groß- und Kleinschreibung unterschieden|
|Rückgabe|String| Zeichenfolge mit dem ersetzten Zeichenteil|

==== ToUpper ====
Wandelt eine Zeichenfolge in Großbuchstaben\\
  ToUpper(Input As String) As String
  
^Parameter^Datentyp^Beschreibung^
|Input |String| Zeichenfolge|
|Rückgabe|String| Zeichenfolge in Großbuchstaben|

===== Mathematische Funktionen =====

==== ACosinus ====
Berechnet den Arcus Cosinus\\
  ACosinus(Value As Double) As Double

^Parameter^Datentyp^Beschreibung^
|Value|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung ACos(Wert)|

==== ASinus ====
Berechnet den Arcus Sinus\\
  ASinus(Value As Double) As Double

^Parameter^Datentyp^Beschreibung^
|Value|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung ASin(Wert)|


==== ATangens ====
Berechnet den Arcus Tangens\\
  ATangens(Value As Double) As Double

^Parameter^Datentyp^Beschreibung^
|Value|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung ATan(Wert)|

==== Cosinus ====
Berechnet den Cosinus\\
  Cosinus (Value As Double) As Double

^Parameter^Datentyp^Beschreibung^
|Value|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung Cos(Wert)|

==== Exp ====
Berechnet die e Funktion zum Wert y (e^y)\\
  Exp (y As Double) As Double

^Parameter^Datentyp^Beschreibung^
|y|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung Exp(y)|


==== Lg ====
Berechnet den Logarithmus(Basis 10) zum Wert y (log10 y)\\
  Lg (y As Double) As Double

^Parameter^Datentyp^Beschreibung^
|y|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung Log10(y)|


==== Ln ====
Berechnet den Logarithmus(naturalis, Basis e) zum Wert y (ln y)\\
  Ln (y As Double) As Double

^Parameter^Datentyp^Beschreibung^
|y|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung Log(y)|

==== Pow ====
Berechnet den Wert von x^y (x hoch y)\\
  Pow(x As Double, y As Double) As Double

^Parameter^Datentyp^Beschreibung^
|x|Double| Wert zur Berechnung|
|y|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung (x hoch y)|

==== Round ====
Rundet den Parameter oder Attributwert (Schreibt gerundeten Wert in den Parameter oder das Attribut zurück)\\
  Round(Value As ICFTLocalValue, Digits As Integer)

^Parameter^Datentyp^Beschreibung^
|Value |Parameter oder Attribut| Wert zum Runden|
|Digits|Integer| Anzahl der Nachkommastellen|

==== Round2 ====
Rundet den Wert\\
  Round2(Value As Double, Digits As Integer) As Double

^Parameter^Datentyp^Beschreibung^
|Value |Parameter oder Attribut| Wert zum Runden|
|Digits|Integer| Anzahl der Nachkommastellen|
|Rückgabe|Double| Gerundeter Wert|

==== RoundWithOption ====
Rundet den Wert mit Optionen\\
  RoundWithOption(Value As Double, Digits As Integer, RoundToEven As Boolean) As Double

^Parameter^Datentyp^Beschreibung^
|Value |Parameter oder Attribut| Wert zum Runden|
|Digits|Integer| Anzahl der Nachkommastellen|
|RoundToEven |Boolean| True, wenn der Wert 0.5 abgerundet werden soll|
|Rückgabe|Double| Gerundeter Wert|

==== Sinus ====
Berechnet den Sinus \\
  Sinus (Value As Double) As Double

^Parameter^Datentyp^Beschreibung^
|Value|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung Sin(Wert)|

==== Tangens ====
Berechnet den Tangens \\
  Tangens (Value As Double) As Double

^Parameter^Datentyp^Beschreibung^
|Value|Double| Wert zur Berechnung|
|Rückgabe|Double| Ergebnis der Berechnung Tan(Wert)|

===== Konfigurations Funktionen =====

==== DeleteConfiguration ====
Löscht die angegebene Konfiguration aus der Datenbank \\
  DeleteConfiguration(ByRef ConfigID As ICFTLocalValue)

^Parameter^Datentyp^Beschreibung^
|ConfigID |Parameter oder Attribut| Parameter oder Attribut welches die Id der entsprechenden Konfiguration enthällt|

==== LoadConfigFromFile ====
Lädt die Konfiguration aus einer XML Datei \\
  LoadConfigFromFile(ByVal FileName As String) As String

^Parameter^Datentyp^Beschreibung^
|FileName |String| Dateiname der Konfigurationsdatei|
|Rückgabe|String| Konfigurationsschlüssel der Datei|

==== LoadConfigFromFile2 ====
Öffnet einen Dateiauswahldialog und lädt die Konfiguration aus einer XML Datei \\
  LoadConfigFromFile2() As String

^Parameter^Datentyp^Beschreibung^
|Rückgabe|String| Konfigurationsschlüssel der Datei|

==== LoadConfiguration ====
Lädt eine Konfiguration aus der Datenbank \\
  LoadConfiguration(ByVal ConfigID As String) As String

^Parameter^Datentyp^Beschreibung^
|ConfigID |String| Id der entsprechenden Konfiguration|
|Rückgabe|String| Konfigurationsschlüssel der Datei|

==== NewConfiguration1 ====
Initialisiert einen neue Konfiguration und legt deren Id fest\\
  NewConfiguration1(ByVal ConfigType As String, ByRef ConfigID As ICFTLocalValue)

^Parameter^Datentyp^Beschreibung^
|ConfigType |String| Typ (Konfigurationsschlüssel ) der entsprechenden Konfiguration|
|ConfigID |Parameter oder Attribut| Parameter oder Attribut welches die Id der entsprechenden Konfiguration enthällt|

==== SaveConfigToFile ====
Speichert die aktuelle (Mit NewConfiguration initialisierte, oder geladene) Konfiguration in die entsprechende XML-Datei\\
  SaveConfigToFile(ByVal FileName As String)

^Parameter^Datentyp^Beschreibung^
|FileName |String|  Dateiname der Konfigurationsdatei|

==== SaveConfigToFile2 ====
Speichert die aktuelle (Mit NewConfiguration initialisierte, oder geladene) Konfiguration mit den entsprechenden Persitence Attributen in die Datebnank, erzeugt einen Dateinamen und speichert die XML-Date\\
  SaveConfigToFile2(PersistenceObject As String) As String

^Parameter^Datentyp^Beschreibung^
|PersistenceObject |String|  Name des Objektes das die Persistenzinformationen enthällt|
|Rückgabe|String| Dateiname der erzeugten XML-Datei|

==== SaveConfiguration1 ====
Speichert die Konfiguration mit dem angegebenen konfigurationsschlüssel in die Datenbank\\
  SaveConfiguration1(ByVal ConfigKey As String)

^Parameter^Datentyp^Beschreibung^
|ConfigKey |String| Konfigurationsschlüssel der |

==== SaveConfiguration2 ====
Speichert die Konfiguration mit dem angegebenen Konfigurationsschlüssel in die Datenbank\\
  SaveConfiguration2(ByRef ConfigID As ICFTLocalValue)

^Parameter^Datentyp^Beschreibung^
|ConfigID |Parameter oder Attribut| Parameter oder Attribut welches die Id der entsprechenden Konfiguration enthällt|

==== SaveConfiguration2 ====
Speichert die Konfiguration mit dem angegebenen Konfigurationsschlüssel in die Datenbank\\
  SaveConfigurations(ByRef Configurations As ICFTLocalValue)

^Parameter^Datentyp^Beschreibung^
|Configurations |Parameter (Liste)| Parameter vom Typ Stringliste welches die Ids der entsprechenden Konfiguration enthällt|

===== Datei Funktionen =====

==== CopyFile ====
Kopiert eine Datei mit Dialog \\
  CopyFile(SourceFileName As String, TargetFileName As String, Filter As String) As Integer

^Parameter^Datentyp^Beschreibung^
|SourceFileName |String| Pfad und Dateiname der Quelldatei|
|TargetFileName |String| Vorschlag für Pfad und Dateiname der Zieldatei|
|Filter |String| Mögliche Dateieindungen vgl. .NET SaveFileDialog|
|Rückgabe|Integer| 0 = Fehler, 1=OK|

==== CopyFile2 ====
Kopiert eine Datei \\
  CopyFile2(SourceFileName As String, TargetFileName As String, Overwrite As Boolean)

^Parameter^Datentyp^Beschreibung^
|SourceFileName |String| Pfad und Dateiname der Quelldatei|
|TargetFileName |String| Pfad und Dateiname der Zieldatei|
|Overwrite |Boolean| True wenn die Datei überschrieben werden kann|

==== CutFileType ====
Schneited die Dateieindung von einem Dateinamen ab\\
  CutFileType(ByVal FileName As String) As String

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Rückgabe|String| Pfad und Dateiname ohne Dateiendung|

==== DeleteFile ====
Löscht eine Datei \\
   DeleteFile(FileName As String)

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname der zu löschenden Datei|


==== ExistsDirectory ====
Gibt an, ob ein Verzeichniss existiert \\
   ExistsDirectory(FolderName As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|FolderName |String| Pfad der überprüft wird|
|Rückgabe|Boolean| Verzeichniss existiert |

==== ExistsFile ====
Gibt an, ob eine Datei existiert \\
   ExistsFile(ByVal FileName As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname der überprüft wird|
|Rückgabe|Boolean| Datei existiert |

==== ExistsFile ====
Gibt an, ob eine Datei existiert \\
   ExistsFile(ByVal FileName As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname der überprüft wird|
|Rückgabe|Boolean| Datei existiert |

==== GetFileName ====
Liefert den Dateinamen\\
  GetFileName(FileName As String) As String

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Rückgabe|String| Dateiname |


==== GetFileNameWithoutExtension ====
Liefert den Dateinamen ohne Dateiendung\\
  GetFileNameWithoutExtension(ByVal FileName As String) As String

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Rückgabe|String| Dateiname ohne Dateiendung |

==== NewTextFile ====
Erstellt eine neue Textdatei\\
  NewTextFile(ByVal FileName As String, ByVal Overwrite As Boolean) As Integer

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Overwrite |Boolean| True wenn die Datei überschrieben werden kann|
|Rückgabe|String| Dateiname ohne Dateiendung |
|Rückgabe|Integer| 0 = Fehler, 1=OK|

==== OpenFile ====
Öffnet eine Datei mit Dateiauswahldialog, Zum Öffnen wird die für den Dateityp hinterlegte Applikation verwendet.\\
  OpenFile(FileName As String, Filter As String, InitialFolder As String, Copy As Boolean)

^Parameter^Datentyp^Beschreibung^
|FileName |String| Dateiname, wenn leer oder die Datei nicht exisitiert, kommt ein Dialog zur Auswahl|
|Filter |String| Mögliche Dateieindungen vgl. .NET SaveFileDialog|
|InitialFolder |String| Pfad mit dem der Dialog initial angezeigt werden soll|
|Copy |Boolean| True wenn die Datei temporär lokal kopiert werden soll|

==== ShellExecute ====
Führt eine Applikation aus.\\
  ShellExecute(FileName As String, Args As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Args |String| Startargumente|
|Rückgabe |Boolean| Start der Applikation war erfolgreich|

==== ShellExecute2 ====
Führt eine Applikation aus.\\
  ShellExecute2(FileName As String, Args As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Args |String| Startargumente|
|Rückgabe |Boolean| Start der Applikation war erfolgreich|

==== ShellExecute2 ====
Führt eine Applikation aus.\\
  ShellExecute2(FileName As String, Args As String) As Boolean

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Args |String| Startargumente|
|Rückgabe |Boolean| Start der Applikation war erfolgreich|


==== Write ====
Schreibt eine Zeichenfolge in eine Textdatei.\\
  Write(FileName As String, Value As String) As Integer

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Value |String| Zeichenfolge |
|Rückgabe |Integer| 0 = Fehler, 1=OK|

==== WriteLine ====
Schreibt eine Zeichenfolge als Zeile in eine Textdatei.\\
  WriteLine(FileName As String, Line As String) As Integer

^Parameter^Datentyp^Beschreibung^
|FileName |String| Pfad und Dateiname|
|Value |String|  Zeichenfolge der Zeile |
|Rückgabe |Integer| 0 = Fehler, 1=OK|