Isom.Base.String

 ISOM/L-Bibliothek für Serviceautoren: <br />Isom.Base.String

ISOM/L-Bibliothek
für Serviceautoren

Version 9.10.1.0 vom 25 November 2013

Namensraum Isom.Base.String

Beschreibung

Der Typ Isom.Base.String speichert Zeichenketten, die aus Unicode-Zeichen aufgebaut sind. Die maximale Länge wird in der Regel durch den verfügbare Arbeitsspeicher limitiert. Das theoretische Maximum für die Länge sind 2.147.483.647 Unicode-Zeichen.



Funktionen

Isom.Base.String.AddGlobal

Speichert eine Kopie dieses Zeichenkettenobjekts als globale Variable.

Isom.Base.Boolean Isom.Base.String.AddGlobal  ( Isom.Base.String  key,
Isom.Base.String  value  )

Speichert eine Kopie dieses Zeichenkettenobjekts als globale Variable.

Die übergebene Zeichenkette ist der Schlüssel, mit dem die gespeicherte Variable danach mit .GetGlobal() abgerufen werden kann. Existiert bereits eine globale Variable mit dem Schlüssel, wird der vorher gesicherte Wert ersetzt.

 String.AddGlobal("A", "1"); 
Parameter:
key  Schlüssel, mit dem die Zeichenkette als globale Variable gespeichert wird.
value  Zeichenkette, die gespeichert wird.
Rückgabe:
'true', falls die Zeichenkette als globale Variable gespeichert werden konnte, 'false' sonst (z.B. bei einem ungültigen Objekt für Schlüssel oder Wert).
Isom.Base.String.Append

Hängt die übergebene Zeichenkette an diese Zeichenkette an.

objectbound Isom.Base.String Isom.Base.String.Append  ( Isom.Base.String  part  ) 

Hängt die übergebene Zeichenkette an diese Zeichenkette an.

Das aktuelle Zeichenkettenobjekt übernimmt das Ergebnis als neuen Wert, außer es ist ungültig

 String s = "ab"; 
 s.Append("c");                   // s ist "abc" 
Parameter:
part  Zeichenkette, die angehängt werden soll.
Rückgabe:
Die aktuelle Zeichenkette
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die zweite Zeichenkette das Void-Objekt ist.
Isom.Base.String.Clone

Erzeugt eine identische Kopie dieses Objekts.

objectbound Isom.Base.String Isom.Base.String.Clone  (  ) 

Erzeugt eine identische Kopie dieses Objekts.

Rückgabe:
Kopie dieses Objekts.
Isom.Base.String.Equals

Prüft diese und die übergebene Zeichenkette auf Gleichheit.

objectbound Isom.Base.Boolean Isom.Base.String.Equals  ( Isom.Base.String  other  ) 

Prüft diese und die übergebene Zeichenkette auf Gleichheit.

Bei diesem Vergleich wird auf Groß-/Kleinschreibung geachtet.

 String s = "abc"; 
 Boolean a = s.Equals("ABC");                   // a ist false 
 Boolean a = s.Equals("abc");                   // a ist true 
Parameter:
other  Vergleichszeichenkette.
Rückgabe:
'true', falls diese Zeichenkette mit der Suchzeichenkette übereinstimmt 'false' sonst (auch wenn die Vergleichszeichenkette das Void-Objekt ist).
Isom.Base.String.EqualsIgnoreCase

Vergleicht diese Zeichenkette mit einer weiteren Zeichenkette.

objectbound Isom.Base.Boolean Isom.Base.String.EqualsIgnoreCase  ( Isom.Base.String  other  ) 

Vergleicht diese Zeichenkette mit einer weiteren Zeichenkette.

Bei diesem Vergleich wird nicht auf Groß-/Kleinschreibung geachtet.

 String s = "abc"; 
 Boolean a = s.EqualsIgnoreCase("ABC");                   // a ist true 
 Boolean a = s.EqualsIgnoreCase("abc");                   // a ist true 
 Boolean a = s.EqualsIgnoreCase("cba");                   // a ist false 
Parameter:
other  Vergleichszeichenkette.
Rückgabe:
'true', falls diese Zeichenkette mit der Suchzeichenkette übereinstimmt, 'false' sonst (auch wenn die Suchzeichenkette das Void-Objekt ist).
Isom.Base.String.FindFirst

Sucht nach ersten Auftreten der Suchzeichenkette innerhalb dieser Zeichenkette.

objectbound Isom.Base.Number Isom.Base.String.FindFirst  ( Isom.Base.String  searchstring  ) 

Sucht nach ersten Auftreten der Suchzeichenkette innerhalb dieser Zeichenkette.

Bei dem Vergleich wird auf Groß-/Kleinschreibung (case) geachtet.

 String s = "abcb"; 
 Number pos = s.FindFirst("b");                   // pos ist 1 
Parameter:
searchstring  Suchzeichenkette.
Rückgabe:
0-basierter Index, an dem die Zeichenkette gefunden wurde.
Isom.Base.String.FromBytes

Generiert aus einer Zeichenkette, die eine Folge von Byte-Werten enthält, eine menschenlesbare Zeichenkette.

Isom.Base.String Isom.Base.String.FromBytes  ( Isom.Base.String  data,
Isom.Base.String  format,
Isom.Base.String  encoding,
Isom.Base.String  separators  )

Generiert aus einer Zeichenkette, die eine Folge von Byte-Werten enthält, eine menschenlesbare Zeichenkette.

Parameter:
data  Byte-Folge, die gemäß den anderen Parametern formatiert ist
format  Gibt an, ob die einzelnen Byte-Werte dezimal oder hexadezimal dargestellt sind. Bei hexadezimaler Darstellung darf das Präfix "0x" oder "0X" vorangestellt sein, wenn Trennzeichen zwischen den einzelnen Byte-Werten vorhanden sind. Wird das Void-Objekt übergeben, wird als Vorgabewert hexadezimale Darstellung angenommen. Groß- und Kleinschreibung wird bei diesem Parameter nicht unterschieden. Mögliche Werte sind:
encoding  Gibt die Byte- und Zeichenkodierung an, die zur Dekodierung verwendet werden soll. Es gibt 2 Gruppen von Parametern, von denen jeweils höchstens einer angegeben wird. Die beiden Bestandteile werden durch einen Doppelpunkt getrennt. Die erste Gruppe enthält mögliche Kodierungen einzelner Bytes (BCD-P, BCD, Base64, Base32, unverändert), die zweite Gruppe enthält unterstützte Zeichensätze (ASCII, ISO-8859-x, UTF-8). Ist kein Wert aus Gruppe 1 angegeben, wird "unverändert" angenommen. Ist kein Wert aus Gruppe 2 angegeben, wird "ASCII" angenommen. Wird das Void-Objekt übergeben, werden die Vorgabewerte aus beiden Gruppen verwendet. Groß- und Kleinschreibung wird bei diesem Parameter nicht unterschieden. Mögliche Werte sind z.B.:
separators  Zeichenkette, die alle Zeichen enthält, die als Trennzeichen erkannt werden sollen. Wird das Void-Objekt oder die leere Zeichenkette angegeben, wird kein Trennzeichen verwendet. Stattdessen wird erwartet, dass data genau 2 hexadezimale Ziffern zur Darstellung eines Bytes enthält.

Das folgende Beispiel zeigt die Dekodierung, wobei für alle Parameter außer data mit Vorgabewerten gearbeitet wird.

   String input = "414243"; 
   String output = String.FromBytes(input, String.Void(), String.Void(), String.Void()); 
   // Ergebnis: "ABC" 

Das folgende Beispiel zeigt die Dekodierung mit Verwendung des Leerzeichens als Trennzeichen:

   String input = "41 42 43"; // Alternativ: "0x41 0x42 0x43" 
   String output = String.FromBytes(input, String.Void(), String.Void(), " "); 
   // Ergebnis: "ABC" 

Das folgende Beispiel zeigt die Dekodierung einer Byte-Folge, die BCD-P-kodiert ist, d.h. die oberen und die unteren 4 Bits jedes Bytes enthalten eine Dezimalziffer:

   String input = "0x41 0x42 0x43"; 
   String output = String.FromBytes(input, String.Void(), "BCD-P", " "); 
   // Ergebnis: "414243" 

Das folgende Beispiel zeigt die Dekodierung einer Byte-Folge, die BCD-P-kodiert ist, wobei die Eingabewerte dezimal dargestellt sind:

   String input = "65 66 67"; 
   String output = String.FromBytes(input, "DEC", "BCD-P", " "); 
   // Ergebnis: "414243" 
Ausnahmebehandlung:
Wenn data das Void-Objekt ist
Wenn data nicht mit den angegebenen Parametern dekodiert werden kann, z.B.
  • data enthält Zeichen, die im angegebenen Format nicht zulässig sind, z.B. Hexadezimalziffern a-f, wenn dezimale Kodierung angegeben wird
  • Es wird BCD- oder BCD-P-Kodierung angegeben, aber data enthält nicht nur Ziffern
  • Es wird UTF-8-Kodierung angegeben, aber data stellt keine gültige UTF-8-Bytefolge dar
Wenn sich angegebene Parameter gegenseitig ausschließen: Wird angegeben, dass kein Trennzeichen verwendet wird, dann muss die Darstellung einzelner Bytes hexadezimal erfolgen.
Rückgabe:
Die aus data generierte, menschenlesbare Zeichenkette
Isom.Base.String.GetExistingGlobals

Ruft eine Liste der Schlüssel aller globalen Variablen des Typs 'String' ab

Isom.Base.StringList Isom.Base.String.GetExistingGlobals  (  ) 

Ruft eine Liste der Schlüssel aller globalen Variablen des Typs 'String' ab

   String.AddGlobal("A", "1"); 
   String.AddGlobal("B", "2"); 
   StringList keys = String.GetExistingGlobals(); // enthält "A" und "B" 
Rückgabe:
Liste der Schlüssel aller globalen Variablen des Typs 'String'
Isom.Base.String.GetGlobal

Ruft die Zeichenkette ab, die unter dem übergebenen Schlüssel als globale Variable gesichert wurde.

Isom.Base.String Isom.Base.String.GetGlobal  ( Isom.Base.String  key  ) 

Ruft die Zeichenkette ab, die unter dem übergebenen Schlüssel als globale Variable gesichert wurde.

 String value = String.GetGlobal("A"); 
Parameter:
key  Schlüssel der gesuchten globalen Variable.
Rückgabe:
Kopie des gefundenen Variablenwerts. Änderungen an diesem Rückgabewert ändern den Wert der gesicherten globalen Variable nicht. Um Änderungen in die globale Variable zu übernehmen, muss der geänderte Wert mit .AddGlobal() wieder gesichert werden.
Ausnahmebehandlung:
Die Funktion liefert ein Void-Objekt, falls innerhalb dieser Sitzung noch keine Variable unter dem Schlüssel abgespeichert wurde oder der Schlüssel ein ungültiges Objekt ist.
Isom.Base.String.GetTextCategory

Ermittelt die Text-Kategorie des Strings

objectbound Isom.Base.String Isom.Base.String.GetTextCategory  (  ) 

Ermittelt die Text-Kategorie des Strings

 String a = ... 
 String textId = a.GetTextCategory(); 

Rückgabe:
Text-Kategorie des Strings, falls diese gesetzt ist. Ansonsten wird das Void-Objekt zurückgegeben.
Isom.Base.String.GetTextId

Ermittelt die Text-Id des Strings

objectbound Isom.Base.String Isom.Base.String.GetTextId  (  ) 

Ermittelt die Text-Id des Strings

 String a = "Test"; 
 //... 
 String textId = a.GetTextId(); 

Rückgabe:
Text-Id des Strings, falls diese gesetzt ist. Ansonsten wird das Void-Objekt zurückgegeben.
Isom.Base.String.IsVoid

Bestimmt, ob es sich um das Void-Objekt handelt.

objectbound Isom.Base.Boolean Isom.Base.String.IsVoid  (  ) 

Bestimmt, ob es sich um das Void-Objekt handelt.

Rückgabe:
'true', falls dies das Void-Objekt ist, 'false' sonst.
Isom.Base.String.Length

Liefert die Anzahl der einzelnen Zeichen in der Zeichenkette.

objectbound Isom.Base.Number Isom.Base.String.Length  (  ) 

Liefert die Anzahl der einzelnen Zeichen in der Zeichenkette.

 String s = "ab"; 
 Number n = s.Length();                   // n ist 2 
Rückgabe:
Länge der Zeichenkette.
Isom.Base.String.ParseHexNumber

Interpretiert diese Zeichenkette als Hexadezimalzahl.

objectbound Isom.Base.Number Isom.Base.String.ParseHexNumber  (  ) 

Interpretiert diese Zeichenkette als Hexadezimalzahl.

Die Zeichenkette darf nicht mit '0x' beginnen.

 String s = "FF"; 
 Number n = s.ParseNumber();                    // n ist 255 (in dezimaler Schreibweise) 
Rückgabe:
Zahl, die der Zeichenkette entspricht.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Zeichenkette nicht in eine gültige Zahl konvertiert werden kann.
Isom.Base.String.ParseNumber

Interpretiert diese Zeichenkette als Dezimalzahl.

objectbound Isom.Base.Number Isom.Base.String.ParseNumber  (  ) 

Interpretiert diese Zeichenkette als Dezimalzahl.

 String s = "5.1"; 
 Number n = s.ParseNumber();                    // n ist 5.1 
Rückgabe:
Zahl, die der Zeichenkette entspricht.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Zeichenkette nicht in eine Dezimalzahl konvertiert werden kann.
Isom.Base.String.RemoveGlobal

Entfernt eine globale Zeichenkettenvariable, die unter dem übergebenen Schlüssel gespeichert wurde.

Isom.Base.Boolean Isom.Base.String.RemoveGlobal  ( Isom.Base.String  key  ) 

Entfernt eine globale Zeichenkettenvariable, die unter dem übergebenen Schlüssel gespeichert wurde.

Parameter:
key  Schlüssel, unter dem die globale Variable abgelegt wurde
Rückgabe:
'true', falls die globale Variable mit dem Schlüssel gelöscht wurde 'false, falls unter dem Schlüssel keine globale Variable abgelegt war.
Isom.Base.String.Replace

Ersetzt innerhalb dieser Zeichenkette alle Vorkommen der Suchzeichenkette durch den Ersetzungstext.

objectbound Isom.Base.String Isom.Base.String.Replace  ( Isom.Base.String  searchstring,
Isom.Base.String  replacement  )

Ersetzt innerhalb dieser Zeichenkette alle Vorkommen der Suchzeichenkette durch den Ersetzungstext.

Das aktuelle Zeichenkettenobjekt übernimmt das Ergebnis als neuen Wert, außer es ist ungültig

 String s = "ab"; 
 s.Replace("b", "bc");                    // s ist "abc" 
Parameter:
searchstring  Suchzeichenkette.
replacement  Ersetzungstext.
Rückgabe:
Die aktuelle Zeichenkette
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben falls die Suchzeichenkette oder der Ersetzungstext das Void-Objekt ist.
Siehe auch:
Isom.Base.String.ReplaceFirst() um nur ein Vorkommen zu ersetzen.
Isom.Base.String.ReplaceFirst

Ersetzt innerhalb dieser Zeichenkette das erste Vorkommen der Suchzeichenkette durch den Ersetzungstext.

objectbound Isom.Base.String Isom.Base.String.ReplaceFirst  ( Isom.Base.String  searchstring,
Isom.Base.String  replacement  )

Ersetzt innerhalb dieser Zeichenkette das erste Vorkommen der Suchzeichenkette durch den Ersetzungstext.

Das aktuelle Zeichenkettenobjekt übernimmt das Ergebnis als neuen Wert, außer es ist ungültig.

 String s = "abcb"; 
 s.ReplaceFirst("b", dd");                    // s ist "addcb" 
Parameter:
searchstring  Suchzeichenkette.
replacement  Ersetzungstext.
Rückgabe:
Die aktuelle Zeichenkette
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben falls die Suchzeichenkette oder der Ersetzungstext das Void-Objekt oder der Leerstring ist.
Siehe auch:
Isom.Base.String.Replace() um alle Vorkommen zu ersetzen.
Isom.Base.String.Search

Sucht nach der Suchzeichenkette innerhalb dieser Zeichenkette.

objectbound Isom.Base.Boolean Isom.Base.String.Search  ( Isom.Base.String  searchstring  ) 

Sucht nach der Suchzeichenkette innerhalb dieser Zeichenkette.

Bei dem Vergleich wird auf Groß-/Kleinschreibung geachtet.

 String s = "ab"; 
 Boolean a = s.Search("ba");                  // a ist false 
 Boolean a = s.Search("a");                   // a ist true 
Parameter:
searchstring  Suchzeichenkette.
Rückgabe:
'true', falls die Suchzeichenkette Teil dieser Zeichenkette ist, 'false' sonst (auch wenn die Suchzeichenkette das Void-Objekt ist).
Siehe auch:
Isom.Base.String.FindFirst() für die Positionsbestimmung.
Isom.Base.String.SetTextCategory

Setzt die Text-Kategorie des Strings.

objectbound Isom.Base.Boolean Isom.Base.String.SetTextCategory  ( Isom.Base.String  category  ) 

Setzt die Text-Kategorie des Strings.

Das Setzen einer leeren Text-Kategor führt zum Zurücksetzen der Text-Kategorie.

 String a = "Beispieltext für einen Fehler"; 
 a.SetTextCategory("MESSAGE"); 

Rückgabe:
'true', falls das Setzen erfolgreich war
Isom.Base.String.SetTextId

Setzt die Text-Id des Strings.

objectbound Isom.Base.Boolean Isom.Base.String.SetTextId  ( Isom.Base.String  textId  ) 

Setzt die Text-Id des Strings.

Anhand der Text-Id kann ein Klient die Übersetzung des Texts in eine andere Sprache suchen.

Das Setzen einer leeren Text-Id führt zum Zurücksetzen der Text-Id.

 String a = "Beispielfür einen übersetzbaren Text"; 
 a.SetTextId("IFS.Taurus.ErrorText.Error1000"); 

Rückgabe:
'true', falls das Setzen erfolgreich war
Isom.Base.String.Split

Teilt eine Zeichenkette anhand übergebener Separatoren und liefert eine Liste von Teilzeichenketten, die durch die Separatoren getrennt werden.

objectbound Isom.Base.StringList Isom.Base.String.Split  ( Isom.Base.String  separators  ) 

Teilt eine Zeichenkette anhand übergebener Separatoren und liefert eine Liste von Teilzeichenketten, die durch die Separatoren getrennt werden.

Die Separatorzeichen werden als Zeichenkette übergeben. Jedes Zeichen dieser Zeichenkette wird als mögliches Separatorzeichen verwendet.

 String s = "a,b,c,d"; 
 StringList list = s.Split(",");              // list besteht aus "a", "b", "c" und "d" 
 while( list.HasNext() ) 
 { 
    String part = list.Next(); 
    ... 
 } 
Parameter:
separators  Separatorzeichen.
Rückgabe:
Liste der Teilzeichenketten. Die Liste enthält mindestens ein Element.
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls die Separatorzeichenkette das Void-Objekt ist.
Isom.Base.String.Substring

Liefert einen Ausschnitt aus dieser Zeichenkette.

objectbound Isom.Base.String Isom.Base.String.Substring  ( Isom.Base.Number  startIndex,
Isom.Base.Number  length  )

Liefert einen Ausschnitt aus dieser Zeichenkette.

 String s = "abc"; 
 String subString = s.Substring(0, 1);                    // subString ist "a" 
 String subString = s.Substring(1, 1);                    // subString ist "b" 
 String subString = s.Substring(1, 2);                    // subString ist "bc" 
Parameter:
startIndex  Index, ab dem die Teilzeichenkette bestimmt werden soll. Die Zählung beginnt bei 0 für das erste Zeichen.
length  Länge der Teilzeichenkette ab der Anfangsposition. Wenn der Parameter '-1' ist, wird die Teilzeichen- kette ab der Anfangsposition bis zum Ende geliefert.
Rückgabe:
Ausschnitt aus dieser Zeichenkette
Ausnahmebehandlung:
Es wird das Void-Objekt zurückgegeben, falls ein Parameter das Void-Objekt ist oder die Parameter außerhalb des zulässigen Bereichs liegen (negativ oder größer/gleich der Länge der Zeichenkette). Die Ausnahme ist die Länge '-1'.
Isom.Base.String.ToBytes

Generiert aus einer (menschenlesbaren) Zeichenkette eine Darstellung als Byte-Folge.

Isom.Base.String Isom.Base.String.ToBytes  ( Isom.Base.String  data,
Isom.Base.String  format,
Isom.Base.String  encoding,
Isom.Base.String  separator  )

Generiert aus einer (menschenlesbaren) Zeichenkette eine Darstellung als Byte-Folge.

Wird hexadezimale Darstellung verwendet, erfolgt die Ausgabe mit genau 2 Ziffern pro Byte ohne Präfix "0x".

Diese Funktion ist die Umkehrfunktion von FromBytes().

Parameter:
data  Zeichenkette, aus der eine Darstellung als Byte-Folge erzeugt werden soll
format  Gibt an, ob die einzelnen Byte-Werte dezimal oder hexadezimal dargestellt werden. Die möglichen Werte sind die gleichen wie in FromBytes().
encoding  Gibt die Byte- und Zeichenkodierung an, die zur Kodierung verwendet werden soll. Die möglichen Werte sind die gleichen wie in FromBytes().
separator  Zeichen oder Zeichenkette, mit der zwei aufeinanderfolgende Byte-Werte getrennt werden

Das folgende Beispiel zeigt die Kodierung einer Byte-Folge mit BCD-P-Kodierung, wobei die Ausgabewerte dezimal dargestellt werden:

   String input = "414243"; 
   String output = String.ToBytes(input, "DEC", "BCD-P", " "); 
   // Ergebnis: "65 66 67" 
Ausnahmebehandlung:
Wenn data das Void-Objekt ist
Wenn die in data angegebene Zeichenkette in der angegebenen Zeichen- oder Byte-Kodierung nicht darstellbar ist, z.B.:
  • BCD- oder BCD-P-Kodierung für eine Zeichenkette, die nicht nur Ziffern enthält
  • ISO-8859-1-Kodierung für eine Zeichenkette mit nichtwesteuropäischen Schriftzeichen
Rückgabe:
Darstellung von data als Byte-Folge
Isom.Base.String.ToLower

Wandelt alle Zeichen der Zeichenkette in Kleinschreibung um.

objectbound Isom.Base.String Isom.Base.String.ToLower  (  ) 

Wandelt alle Zeichen der Zeichenkette in Kleinschreibung um.

Das aktuelle Zeichenkettenobjekt übernimmt das Ergebnis als neuen Wert, außer es ist ungültig.

 String s = "aB"; 
 s.ToLower();                     // s ist danach "ab" 
Rückgabe:
Die aktuelle Zeichenkette in Kleinschreibung.
Isom.Base.String.ToUpper

Wandelt alle Zeichen der Zeichenkette in Großschreibung um.

objectbound Isom.Base.String Isom.Base.String.ToUpper  (  ) 

Wandelt alle Zeichen der Zeichenkette in Großschreibung um.

Das aktuelle Zeichenkettenobjekt übernimmt das Ergebnis als neuen Wert, außer es ist ungültig.

 String s = "aB"; 
 s.ToUpper();                     // s ist danach "AB" 
Rückgabe:
Die aktuelle Zeichenkette in Großschreibung.
Isom.Base.String.Void

Erzeugt ein Void-Objekt.

Isom.Base.String Isom.Base.String.Void  (  ) 

Erzeugt ein Void-Objekt.

Das erzeugte Void-Objekt kann z. B. in Funktionen zurückgegeben werden, um einen Fehler anzuzeigen.

Rückgabe:
Void-Objekt

Version 9.10.1.0 vom 25 November 2013