Zum Hauptinhalt springen

C16_TextRead

C16_TextRead(const vPHANDLE aTextHdl, const vCHAR* aTextName, const vFLAGS aFlags, vC16_TextInfo* aTextInfo) : vERROR​

Informationen über einen Text ermitteln

Details

Der Befehl liest Textinformationen in eine Struktur vom Typ vC16_TextInfo ein. Die Struktur ist folgendermaßen definiert:

typedef struct
{
  vINT   InfoSize;
  vCHAR  TextName[24];
  vCHAR  TextPrivUser[24];
  vCHAR  TextCreateUser[24];
  vCHAR  TextModifiedUser[24];
  vDATE  TextCreateDate;
  vTIME  TextCreateTime;
  vDATE  TextModifiedDate;
  vTIME  TextModifiedTime;
  vLONG  TextSize;
  vLONG  TextLines;
  vCHAR  TextGroup[24];
  vINT   TextReadPL;
  vINT   TextWritePL;
  vBOOL  TextPrivate;
  vBOOL  TextEncrypted;
}
vC16_TextInfo;
  • Komponente: Beschreibung
  • InfoSize: Größe der Struktur
  • Folgende Elemente können nicht verändert werden:
  • TextName: Name des Textes
  • TextPrivUser: Privater Benutzername
  • TextCreateUser: Benutzer bei der Erstellung
  • TextModifiedUser: Benutzer bei der letzten Änderung
  • TextCreateDate: Datum der Erstellung
  • TextCreateTime: Uhrzeit der Erstellung
  • TextModifiedDate: Datum der letzten Änderung
  • TextModifiedTime: Uhrzeit der letzten Änderung
  • TextSize: Größe des Textes in Bytes
  • TextLines: Anzahl der Zeilen
  • Folgende Elemente können verändert werden:
  • TextGroup: Name der Textgruppe
  • TextReadPL: Mindest-Leseberechtigung
  • TextWritePL: Mindest-Schreibberechtigung
  • TextPrivate: Privater Text
  • TextEncrypted: Verschlüsselte Speicherung

Mit dem Parameter (aTextHdl) oder (aTextName) wird der Text, zu dem die Informationen ermittelt werden sollen, identifiziert. In (aTextHdl) wird entweder ein mit C16_TextOpen() erzeugter Text-Handle oder NULL übergeben. Wurde NULL übergeben, muss in (aTextName) der Name des Textes angegeben werden. Über den Parameter (aFlags) wird gesteuert, von welchem Text die Informationen ermittelt werden. Folgende symbolische Konstanten stehen zur Verfügung:

  • _TextFirst: Der erste Text wird gelesen.
  • _TextLast: Der letzte Text wird gelesen.
  • _TextPrev: Der Text mit dem nächstkleineren Namen wird gelesen. Sofern kein weiterer Text vorhanden ist, wird als Resultat _rNoRec zurückgeliefert.
  • _TextNext: Der Text mit dem nächstgrößeren Namen wird gelesen. Sofern kein weiterer Text vorhanden ist, wird als Resultat _rNoRec zurückgeliefert.
  • _TextLock: Der Text wird gesperrt. Ist der Text durch einen anderen Benutzer gesperrt, wird als Resultat _rLocked zurückgeliefert.
  • _TextUnlock: Der Text wird entsperrt.

Vor dem Funktionsaufruf muss die Strukturkomponente InfoSize mit der Größe der Informationsstruktur initialisiert werden (sizeof(vC16_TextInfo)). Nach erfolgreicher Ausführung der Funktion stehen die Informationen in der Informationsstruktur (aTextInfo) zur Verfügung.

Folgende Fehlerwerte vom Typ vERROR können zurückgegeben werden:

  • _rOk (0): Der Text wurde gelesen.
  • _rLocked (1): Der Text ist gesperrt.
  • _rNoKey (3): Der Text ist nicht vorhanden. Es wurde der nächst folgende Text gelesen.
  • _rLastRec (4): Der angegebene Text konnte nicht gelesen werden. Es gibt auch keinen nachfolgenden Text.
  • C16ERR_TEXT_HDL_INVALID: (aTextHdl) ist ungültig.
  • C16ERR_TEXT_NAME_INVALID: (aTextName) ist zu lang.
  • C16ERR_INFO_BLOCKSIZE_INVALID: In (aTextInfo) ist der Wert von InfoSize nicht korrekt.
  • C16ERR_TEXT_RIGHTS: Leseberechtigung nicht ausreichend. In diesem Fall steht der Name des Textes im Feld TextName. Alle anderen Felder von (aTextInfo) sind leer.