cpiElementName

Esta função obtém o nome do elemento da sintaxe de destino. O nome do elemento da sintaxe deve ser configurado anteriormente usando cniSetElementName ou cpiSetElementName.

Sintaxe

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

Parâmetros

returnCode
Recebe 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
Especifica o endereço do objeto do elemento de sintaxe de destino (entrada).
value
Especifica o endereço de um buffer no qual o nome de 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 nome do elemento, returnCode é definido como CCI_BUFFER_TOO_SMALL e o número de caracteres necessário é retornado. Para todas as outras falhas, CCI_FAILURE é retornado e returnCode indica a razão para o erro.

Amostra

cpiElementName(&rc;, element, (CciChar*)&elementName;, sizeof(elementName));
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback

Copyright IBM Corporation 1999, 2012Copyright IBM Corporation 1999, 2012.

        
        Última atualização
        
        Última atualização : 2012-07-17 10:04:57


Tópico de ReferênciaTópico de Referência | Versão 8.0.0.1 | as08430_