Grupo cniSearchElement

Use uma ou mais das funções neste grupo para procurar irmãos anteriores do elemento especificado para um elemento que corresponde aos critérios especificados.

A pesquisa é executada iniciando no elemento de sintaxe especificado no parâmetro targetElement, e cada uma das quatro funções fornece uma pesquisa em uma direção diferente da árvore:
  • cniSearchFirstChild pesquisa os elementos filhos imediatos do elemento inicial a partir do primeiro filho, até que seja encontrada uma correspondência ou que o final da cadeia de elementos filhos seja alcançado.
  • cniSearchLastChild pesquisa os elementos filhos imediatos do elemento inicial a partir do último filho, até que seja encontrada uma correspondência ou que o final da cadeia de elementos filhos seja alcançado.
  • cniSearchNextSibling pesquisa a partir do elemento inicial até os próximos irmãos, até que seja encontrada uma correspondência ou que o final da cadeia de irmãos seja alcançado.
  • cniSearchPreviousSibling pesquisa a partir do elemento inicial até os irmãos anteriores, até que seja encontrada uma correspondência ou que o início da cadeia de irmãos seja alcançado.

Se você usar este comando para procurar um elemento dentro de uma mensagem que pertence a um domínio ciente do espaço de nomes, a procura será executada apenas naqueles elementos cujo espaço de nomes é uma cadeia vazia. Se desejar executar uma procura por elementos em todos os espaços de nomes, use uma das funções cniSearchElementNamespace.

Sintaxe

CciElement* cniSearchFirstChild(
  int*            returnCode,
  CciElement*     targetElement,
  CciCompareMode* mode,
  CciElementType  type,
  CciChar         name);
CciElement* cniSearchLastChild(
  int*            returnCode,
  CciElement*     targetElement,
  CciCompareMode* mode,
  CciElementType  type,
  CciChar         name);
CciElement* cniSearchNextSibling(
  int*            returnCode,
  CciElement*     targetElement,
  CciCompareMode* mode,
  CciElementType  type,
  CciChar         name);
CciElement*
cniSearchPreviousSibling(
  int*            returnCode,
  CciElement*     targetElement,
  CciCompareMode* mode,
  CciElementType  type,
  CciChar         name);

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
targetElement
O endereço do objeto de elemento de sintaxe do qual a pesquisa começa (entrada).
mode
O modo de pesquisa a utilizar (entrada). Este parâmetro indica qual combinação de tipo de elemento e nome de elemento deve ser procurada. Os valores possíveis são:
  • CCI_COMPARE_MODE_FULL
  • CCI_COMPARE_MODE_FULL_TYPE
  • CCI_COMPARE_MODE_GENERIC_TYPE
  • CCI_COMPARE_MODE_SPECIFIC_TYPE
  • CCI_COMPARE_MODE_NAME
  • CCI_COMPARE_MODE_NAME_SPECIFIC_TYPE
  • CCI_COMPARE_MODE_NAME_GENERIC_TYPE
  • CCI_COMPARE_MODE_NAME_FULL_TYPE
  • CCI_COMPARE_MODE_NULL
tipo
O tipo de elemento a pesquisar (entrada). Use este parâmetro apenas se o modo de procura envolver uma correspondência no tipo.
name
O nome de elemento a pesquisar (entrada). Use este parâmetro apenas se o modo de procura envolver uma correspondência no nome.

Exemplo

  int                rc;
  CciElement* firstChild = cniSearchFirstChild(
                                              &rc, 
                                               inRootElement, 
                                               CCI_COMPARE_MODE_NAME, 
                                               elementName, 
                                               0);

Valores de Retorno

  • Se bem-sucedida, o endereço do objeto de elemento de sintaxe pedido é retornado.
  • Se não houver um elemento correspondente, zero é retornado.
  • Se um erro ocorrer, zero (CCI_NULL_ADDR) é retornado e o parâmetro returnCode indica a razão do erro.
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:53


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