cniGetAttributeName2

Esta função retorna o nome de um atributo de nó especificado por um índice. Ela é chamada pelo intermediário de mensagem quando o intermediário requer os nomes de atributos suportados por uma instância específica de um nó. A função deve garantir o retorno dos atributos em uma ordem conhecida, definida e o retorno do nome do atributo representado pelo parâmetro de índice.

Se cniGetAttributeName e cniGetAttributeName2 forem implementados, cniDefineNodeClass falhará com CCI_INV_IMPL_FUNCTION.

Definido em Tipo Membro
CNI_VFT Opcional iFpGetAttributeName2

Sintaxe

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

Parâmetros

context
O endereço do contexto para a instância do nó, conforme criado pelo nó e retornado pela função cniCreateNodeContext (entrada).
returnCode (saída)
Ponteiro para um int. No retorno, o nó deve assegurar que este int armazene um valor que descreve o status de conclusão. Os possíveis códigos de retorno são:
  • CCI_SUCCESS
  • CCI_ATTRIBUTE_UNKNOWN
  • CCI_BUFFER_TOO_SMALL
index
Especifica o índice do nome do atributo (entrada). O índice dos atributos começa de zero.
buffer
O endereço de um buffer no qual o nome do atributo é copiado (saída).
bufsize
O comprimento, em CciChars, do buffer especificado no parâmetro buffer (entrada).

Valores de Retorno

  • Se bem-sucedido, o nome do atributo será copiado para o buffer fornecido e o número de caracteres CciChar copiados será retornado.
  • Se o buffer não for grande o suficiente para conter o nome do atributo, returnCode será configurado como CCI_BUFFER_TOO_SMALL e o número de CciChars requeridos será retornado.
  • Se for alcançado o final da lista de atributos e o nome do atributo não for localizado, returnCode será configurado como CCI_ATTRIBUTE_UNKNOWN. Por exemplo, quando index é maior que n-1, em que n é o número de atributos para este nó.
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback
Direitos Autorais IBM Corporation 1999, 2006 Última Atualização: 1 Sep 2006
as24699_