cpiElementName

Propósito

Obtém o nome do elemento de sintaxe de destino. O nome do elemento da sintaxe terá sido definido anteriormente utilizando 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 para o qual o nome do elemento será 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 qualquer outra falha, CCI_FAILURE é retornado e returnCode indica a razão do erro.

Amostra

cpiElementName(&rc;, element, (CciChar*)&elementName;, sizeof(elementName));
Conceitos relacionados
Analisadores Definidos pelo Usuário
Visão Geral de Extensões Definidas pelo Usuário
Tarefas relacionadas
Criando um Analisador Definido pelo Usuário
Referências relacionadas
cpiElementType
Grupo cpiElementValue
cpiElementValueValue
Funções de Utilitários do Analisador C
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
Última atualização : 2009-02-13 16:13:10

as08430_