cpiParserType

Purpose

Optional function to return whether the parser is an implementation of a standard parser. Such a parser expects that the Format field of the preceding header will contain the name of the parser class that follows. Non-standard parsers expect that the Domain field will contain the parser class name. If the cpiParserType implementation function is not provided, the message broker assumes that the parser is of the standard type.

Defined In Type Member
CPI_VFT Optional iFpParserType

Syntax

CciBool cpiParserType(
  CciParser*   parser,
  CciContext*  context);

Parameters

parser
The address of the parser object (input).
context
The address of the context owned by the parser object (input).

Return values

If the implementation is of a standard parser, zero is returned. Otherwise, the implementation is assumed to be that of a non-standard parser and a non-zero value is returned.

Related concepts
User-defined parsers
User-defined extensions
Related tasks
Creating a parser in C
Related reference
C parser implementation functions