cniGetAttributeName2

Esta función devuelve el nombre de un atributo de nodo especificado por un índice. El intermediario de mensajes invoca esta función cuando necesita los nombres de los atributos soportados por una instancia determinada de un nodo. La función debe garantizar que devolverá los atributos en un orden definido conocido y que devolverá el nombre de atributo representado por el parámetro de índice.

Si se implementan cniGetAttributeName y cniGetAttributeName2, cniDefineNodeClass falla con CCI_INV_IMPL_FUNCTION.

Definida en Tipo Miembro
CNI_VFT Opcional iFpGetAttributeName2

Sintaxis

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

Parámetros

context
Dirección del contexto para la instancia del nodo, creado por el nodo y devuelto por la función cniCreateNodeContext (entrada).
returnCode (salida)
Puntero a un valor int. Por su parte, el nodo debe asegurar que este int almacena un valor que describe el estado de finalización. Los códigos de retorno posibles son:
  • CCI_SUCCESS
  • CCI_ATTRIBUTE_UNKNOWN
  • CCI_BUFFER_TOO_SMALL
index
Especifica el índice del nombre de atributo (entrada). El índice de los atributos empieza desde cero.
buffer
Dirección de un almacenamiento intermedio en el que se copia el nombre de atributo (salida).
bufsize
Longitud, en CciChars, del almacenamiento intermedio especificado en el parámetro buffer (entrada).

Valores de retorno

  • Si la ejecución se realiza satisfactoriamente, el nombre de atributo se copia en el almacenamiento intermedio proporcionado y se devuelve el número de caracteres CciChar copiados.
  • Si el tamaño del almacenamiento intermedio no es suficientemente grande para contener el nombre del atributo, returnCode se establece en CCI_BUFFER_TOO_SMALL y se devuelve el número de CciChars necesarios.
  • Si se alcanza el final de la lista de atributos y no se encuentra el nombre de atributo, returnCode se establece en CCI_ATTRIBUTE_UNKNOWN. Por ejemplo, cuando index es mayor que n-1, donde n es el número de atributos para este nodo.
Avisos | Marcas registradas | Descargas | Biblioteca | Soporte | Su opinión
Copyright IBM Corporation 1999, 2006 Última actualización: 22/08/2006
as24699_