Zum Hauptinhalt springen

C16_KeyInfo

C16_KeyInfo(const vPHANDLE aInstHdl, const vINT aFileNo, const vINT aKeyNo, vC16_KeyInfo* aInfoBlock) : vERROR​

Informationen über einen Schlüssel ermitteln

Details

Der Befehl füllt eine Struktur vom Typ vC16_KeyInfo mit Informationen zu einem in der Datenstruktur definierten Schlüssel. Die Struktur ist folgendermaßen definiert:

typedef struct
{
  vINT  InfoSize;
  vINT  KeyFileNumber;
  vINT  KeyNumber;
  vINT  KeyFldCount;
  vBOOL KeyIsUnique;
  vCHAR KeyName[24];
}
vC16_KeyInfo;
  • Komponente: Beschreibung
  • InfoSize: Größe der Struktur
  • KeyFileNumber: Nummer der Datei, in welcher der Schlüssel definiert ist
  • KeyNumber: Nummer des Schlüssels
  • KeyFldCount: Anzahl der Schlüsselfelder
  • KeyIsUnique: 0 = Schlüssel ist nicht eindeutig, 1 = Schlüssel ist eindeutig
  • KeyName[24]: Name des Schlüssels

Im Parameter (aInstHdl) wird der von C16_InitInstance() bereitgestellte Instanz-Handle, der in der Funktion C16_OpenArea() zum Öffnen der Datenbank verwendet wurde, übergeben. In den Parametern (aFileNo) und (aKeyNo) müssen sich die Datei- und die Schlüsselnummer für den Schlüssel befinden, von dem die Informationen abgefragt werden sollen. In (aInfoBlock) wird ein Zeiger auf eine Informationsstruktur vom Typ vC16_KeyInfo übergeben. Die Strukturkomponente InfoSize muss vor der Übergabe mit der Größe der Struktur initialisiert werden (sizeof(vC16_KeyInfo)).

Der Rückgabewert vom Typ vERROR beinhaltet entweder 0 (kein Fehler) oder einen negativen Fehlerwert (siehe Fehlerwerte ).