DBreturnObjectKeys

Objektschlüssel eines Objekts ermitteln.

Mit DBreturnObjectKeys lassen sich die Schlüssel eines Objekts bestimmen. Die Prozedur unterstützt das Ermitteln der Schlüsselanzahl, indem sie mit *keyCnt=0 aufgerufen wird. Die Schlüssel werden zurückgeliefert, wenn *keyCnt >0 gilt. Im ersten Fall ist der Wert des Zeigers keys beliebig, im zweiten Fall muss keys auf ein Feld mit mindestens *keyCnt Elementen vom Typ KEY zeigen. Bei erfolgreichem Ausführen von DBreturnObjectKeys gibt diese als Ergebnis ERROR_OK zurück und hat in *keyCnt die real vorhandene Anzahl der Schlüssel geschrieben und die Schlüssel im Feld keys abgelegt. Wenn der Platz in keys nicht ausreicht, wird in keyCnt die tatsächlich zurückgegebene Anzahl der Schlüssel eingetragen.

Parameter

object (POBJECT)                                     [IN]

Dies ist das Handle des Objekts, dessen Schlüssel ermittelt werden sollen.

keyCnt (int *)                                       [IN/OUT]

Beim Aufruf enthält keyCnt entweder den Wert 0, woraufhin die Prozedur die Anzahl der Schlüssel hier hinterlegt. Oder keyCnt enthält einen Wert größer als 0, worauf DBreturnObjectKeys maximal keyCnt Objektschlüssel in das Feld keys überträgt und die real eingetragene Schlüsselzahl in keyCnt ablegt.

keys (KEY *)                                       [IN/OUT]

Dieser Parameter muss auf ein Feld mit keyCnt Elementen vom Typ KEY zeigen. In diesem Feld werden dann die Schlüssel von object abgelegt.

Ergebnis

(T_ERROR)                                            [OUT]

Als Ergebnis liefert die Prozedur im Falle der erfolgreichen Ausführung den Wert ERROR_OK. Sonst können die Fehlermeldungen aus der Datei error.h entnommen werden.

Deklaration

#include "database.h"

T_ERROR DLLENTRY DBreturnObjectKeys (

     POBJECT        object,

     int *       keyCnt,

     KEY *       keys

);