DBreturnTextString

Top  Previous  Next

Den Text eines Textelements ermitteln.

Zu dem Handle eines Textelements wird dessen Textinhalt ermittelt. Der Inhalt wird kopiert, eine Änderung in dem zurückgegebenen Textstring wirkt sich nicht auf den Inhalt der Datenbank aus. Da die Länge des Textes nicht begrenzt ist, wird über den Parameter len beim Aufruf von DBreturnTextString die Maximallänge des Textes (inklusive 0-Zeichens als Abschluss) an die Prozedur übergeben. Bei Rückkehr aus der Prozedur enthält das Feld die reale Länge des Textes, falls dieser kürzer als der Maximalwert ist oder den Maximalwert, wenn er länger ist. In diesem Fall wird der zurückgegebene Text gekürzt. Wird len mit 0 initialisiert, wird statt dessen in len die Länge des Textes geschrieben und der Text wird nicht zurückgegeben.

Parameter

element (PTEXT_ELEMENT)                   [IN]

Das Handle des Textes, von dem der Textinhalt ermittelt werden soll. Hier darf auch nur ein Text-Handle übergeben werden, alles andere mag das System nicht. Eine Überprüfung findet statt, wenn die Debugversion verwendet wird.

len (int *)                                              [IN/OUT]

Wenn bei Aufruf hier der Wert 0 steht, so wird nur in len die reale Länge des Strings eingetragen. Ein Wert ungleich 0 beschreibt die maximale Länge des Textes bei der Rückgabe. Ist der Text länger als dieser Wert, so wird er abgeschnitten. Gemeint ist jeweils die Länge inklusive der abschließenden 0.

textString (char *)                               [IN/OUT]

Dies ist ein Zeiger auf einen Bereich von mindestens len Zeichen. In diesen Bereich wird der Textinhalt kopiert. Wenn bei Aufruf in len 0 steht, wird dieser Zeiger nicht benutzt, kann also jeden Wert besitzen.

Ergebnis

(T_ERROR)                                            [OUT]

Wenn die Prozedur fehlerfrei ausgeführt werden konnte, dann liefert sie ERROR_OK, sonst eine der Fehlermeldungen aus error.h.

Deklaration

#include "database.h"

 

T_ERROR DLLENTRY DBreturnTextString (

     PTEXT_ELEMENT     element,

     int *          len,

     char *            textString

);

Verwandte Prozeduren

DBreturnExpandedText