Feed parser functions


Functions

AFP_RETCODE AFP_AllocFeedParser (AFP_HFEEDPARSER *phFeedParser, AFP_ErrorInfo *pErrorInfo)
 Allocates and initializes a new AFP parser object.
AFP_RETCODE AFP_FreeFeedParser (AFP_HFEEDPARSER hFeedParser, AFP_ErrorInfo *pErrorInfo)
 Frees an AFP feed parser object.
AFP_RETCODE AFP_SetFeedParserOption (AFP_HFEEDPARSER hFeedParser, AFP_CONFIGOPTION configOption, void *pOptionVal, AFP_ErrorInfo *pErrorInfo)
 Configures an AFP parser object.

Function Documentation

AFP_RETCODE AFP_AllocFeedParser AFP_HFEEDPARSER phFeedParser,
AFP_ErrorInfo pErrorInfo
 

Allocates and initializes a new AFP parser object.

Parameters:
phFeedParser Will be filled in with a handle for the new parser object.
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK A new parser object was successfully allocated.
See also:
AFP_FreeFeedParser()

AFP_RETCODE AFP_FreeFeedParser AFP_HFEEDPARSER  hFeedParser,
AFP_ErrorInfo pErrorInfo
 

Frees an AFP feed parser object.

Parameters:
hFeedParser Handle to the feed parser object.
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The parser object was successfully freed.
See also:
AFP_AllocFeedParser()

AFP_RETCODE AFP_SetFeedParserOption AFP_HFEEDPARSER  hFeedParser,
AFP_CONFIGOPTION  configOption,
void *  pOptionVal,
AFP_ErrorInfo pErrorInfo
 

Configures an AFP parser object.

Parameters:
hFeedParser Handle to the feed parser object.
configOption Config option to set.
pOptionVal New config option value. Refer to the documentation for each config option for details about what value to pass in here.
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The config option was set successfully.