cniGetAttributeName2

Diese Funktion gibt den Namen eines durch einen Index angegebenen Knotenattributs zurück. Sie wird vom Nachrichtenbroker aufgerufen, wenn der Broker die Namen von Attributen benötigt, die von einer bestimmten Instanz eines Knotens unterstützt werden. Es muss gewährleistet sein, dass die Funktion die Attribute in einer bekannten, definierten Reihenfolge zurückgibt und den Attributnamen durch den Indexparameter dargestellt zurückgibt.

Wenn sowohl cniGetAttributeName als auch cniGetAttributeName2 implementiert werden, schlägt cniDefineNodeClass mit CCI_INV_IMPL_FUNCTION fehl.

Definiert in Typ Mitglied
CNI_VFT Optional iFpGetAttributeName2

Syntax

CciSize cniGetAttributeName2(
  int          returnCode,
  CciContext* context,                
  int          index,
  CciChar*    buffer,
  int          bufsize);

Parameter

context
Die Adresse des Kontextes für die Instanz des Knotens, wie vom Knoten erstellt und von der Funktion cniCreateNodeContext (Eingabe) zurückgegeben.
Rückkehrcode (Ausgabe)
Zeiger auf ein int-Wert (Integer). Bei der Rückgabe soll der Knoten sicherstellen, dass dieser Integer einen Wert speichert, der den Abschlussstatus beschreibt. Mögliche Rückkehrcodes sind:
  • CCI_SUCCESS
  • CCI_ATTRIBUTE_UNKNOWN
  • CCI_BUFFER_TOO_SMALL
index
Gibt den Index des Attributnamens an (Eingabe). Der Index der Attribute fängt bei null an.
buffer
Die Adresse eines Puffers, in den der Attributname kopiert wird (Ausgabe).
bufsize
Die Länge (in CciChar) des Puffers, der im Parameter buffer angegeben wird (Eingabe).

Rückgabewerte

  • Bei erfolgreicher Ausführung wird der Attributname in den angegebenen Puffer kopiert, und die Anzahl der kopierten Zeichen des Typs CciChar wird zurückgegeben.
  • Wenn der Puffer für den Attributnamen nicht groß genug ist, wird als Wert für returnCode CCI_BUFFER_TOO_SMALL festgelegt, und die erforderliche Anzahl der Zeichen (CciChars) wird zurückgegeben.
  • Wenn das Ende der Attributliste erreicht ist und der Attributname nicht gefunden wurde, wird returnCode auf den Wert CCI_ATTRIBUTE_UNKNOWN gesetzt. Zum Beispiel, wenn index größer als n-1 ist, wobei n die Anzahl der Attribute für diesen Knoten ist.
Bemerkungen | Marken | Downloads | Bibliothek | Unterstützung | Rückmeldung
Copyright IBM Corporation 1999, 2006 Letzte Aktualisierung: 23. Aug. 2006
as24699_