cniGetAttribute2

Esta função obtém o valor de um atributo em uma instância do nó específica. Ela é chamada pelo intermediário de mensagem após a configuração de todos os atributos implementados pelo usuário. Os resultados são gravados no armazenamento de configuração persistente do intermediário para assegurar que o nó esteja corretamente configurado quando o processo do grupo de execução for parado e iniciado.

As responsabilidades do nó neste ponto são de:
  1. Retornar uma representação de caractere do valor do atributo.
  2. Lançar uma exceção se um erro ocorrer.

Se cniGetAttribute e cniGetAttribute2 forem implementados, cniDefineNodeClass falhará com CCI_INV_IMPL_FUNCTION.

Definido em Tipo Membro
CNI_VFT Opcional iFpGetAttribute2

Sintaxe

CciSize cniGetAttribute2(
  int          returnCode,
  CciContext*  context,
  CciChar*     attrName,
  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
attrName
O nome do atributo para o qual o valor deve ser recuperado (entrada).
buffer
O endereço de um buffer no qual o valor 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 valor de 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 valor de atributo, returnCode será configurado como CCI_BUFFER_TOO_SMALL e o número de CciChars requeridos será retornado.
  • Se o attrName não for conhecido neste nó, returnCode será configurado como CCI_ATTRIBUTE_UNKNOWN.
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback
Direitos Autorais IBM Corporation 1999, 2006 Última Atualização: 1 Sep 2006
as24698_