cniElementName

Obtém o valor do atributo name para o elemento de sintaxe especificado. O nome do elemento de sintaxe terá sido definido anteriormente utilizando cniSetElementName ou cpiSetElementName.

Sintaxe

CciSize cniElementName(
  int*            returnCode,
  CciElement*     targetElement,
  const CciChar*  value,
  Ccisize         length);

Parâmetros

returnCode
O código de retorno da função (saída).
Os possíveis códigos de retorno são:
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_ELEMENT_OBJECT
  • CCI_INV_DATA_POINTER
  • CCI_INV_DATA_BUFLEN
  • CCI_INV_BUFFER_TOO_SMALL
targetElement
O endereço do objeto do elemento de sintaxe de destino (entrada).
value
O endereço de um buffer no qual o nome do elemento é copiado (entrada).
length
O comprimento, em caracteres, especificado pelo parâmetro value (entrada).

Valores de Retorno

  • Se bem-sucedida, o nome do elemento é copiado para o buffer fornecido e o número de caracteres CciChar copiado é 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.
  • Para qualquer outra falha, CCI_FAILURE é retornado e returnCode indica a razão do erro.
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback
Direitos Autorais IBM Corporation 1999, 2006 Última Atualização: 1 Sep 2006
as07890_