cpiCreateContext

Finalidade

Cria um contexto de extensão definido pelo usuário associado a um objeto do analisador. É chamada pelo intermediário de mensagens quando uma instância de um objeto do analisador é construída ou alocada. Isso ocorre quando um fluxo de mensagens faz com que os dados da mensagem sejam analisados; o intermediário constrói ou aloca um objeto de analisador para adquirir a seção apropriada dos dados da mensagem. Antes que essa função seja chamada, o intermediário terá criado um elemento de nome como o elemento raiz efetivo para o analisador. Entretanto, esse elemento não é nomeado. O analisador deve nomear esse elemento na função cpiSetElementName.

As responsabilidades da extensão são:
  1. Alocar quaisquer áreas de dados específicas da instância do analisador (como o contexto) que possam ser necessárias.
  2. Executar qualquer aquisição ou inicialização de recursos adicionais que possam ser necessárias.
  3. Retornar o endereço do contexto para a função responsável pela chamada. Sempre que uma função de implementação para esta instância do analisador for chamada, o contexto apropriado será transmitido como um argumento para essa função. Isso significa que um analisador definido pelo usuário, desenvolvido em C não precisa manter seus próprios ponteiros estáticos para áreas de dados por instância.
Definido em Tipo Membro
CPI_VFT Obrigatório iFpCreateContext

Sintaxe

void cpiCreateContext(
    CciParser*  parser);

Parâmetros

parser
O endereço do objeto analisador (entrada).

Valores de Retorno

Se for bem-sucedido, o endereço do contexto da extensão definida pelo usuário será retornado. Caso contrário, um valor de zero é retornado.

Conceitos relacionados
Analisadores Definidos pelo Usuário
Extensões Definidas pelo Usuário
Referências relacionadas
Funções de Implementação do Analisador C
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback
Direitos Autorais IBM Corporation 1999, 2006 Última Atualização: 1 Sep 2006
as08095_