Feed document query functions


Functions

AFP_RETCODE AFP_GetFeedDocField (AFP_HFEEDDOC hFeedDoc, AFP_FIELDID fieldId, const wchar_t **ppFieldVal, AFP_ErrorInfo *pErrorInfo)
 Retrieves a field value from a parsed feed document.
AFP_RETCODE AFP_GetIndexedFeedDocField (AFP_HFEEDDOC hFeedDoc, AFP_FIELDID fieldId, int indexNo, const wchar_t **ppFieldVal, AFP_ErrorInfo *pErrorInfo)
 Retrieves a field value from a parsed feed document.
AFP_RETCODE AFP_GetFeedDocItemCount (AFP_HFEEDDOC hFeedDoc, int *pNItems, AFP_ErrorInfo *pErrorInfo)
 Returns the number of items found in a parsed feed.
AFP_RETCODE AFP_GetFeedItemField (AFP_HFEEDDOC hFeedDoc, int itemNo, AFP_FIELDID fieldId, const wchar_t **ppFieldVal, AFP_ErrorInfo *pErrorInfo)
 Retrieves a field value from a feed item.
AFP_RETCODE AFP_GetIndexedFeedItemField (AFP_HFEEDDOC hFeedDoc, int itemNo, AFP_FIELDID fieldId, int indexNo, const wchar_t **ppFieldVal, AFP_ErrorInfo *pErrorInfo)
 Retrieves a field value from a parsed feed document.

Function Documentation

AFP_RETCODE AFP_GetFeedDocField AFP_HFEEDDOC  hFeedDoc,
AFP_FIELDID  fieldId,
const wchar_t **  ppFieldVal,
AFP_ErrorInfo pErrorInfo
 

Retrieves a field value from a parsed feed document.

The field retrieved is a non-indexed one i.e. there is only one such field per document.

Parameters:
hFeedDoc Handle to an AFP document object.
fieldId The ID of the field to be retrieved.
ppFieldVal Will be filled in with a pointer to the field value (or NULL if the field is not present).
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The field value was returned successfully.
See also:
Feed field ID's (non-indexed) for details about each field.

AFP_RETCODE AFP_GetIndexedFeedDocField AFP_HFEEDDOC  hFeedDoc,
AFP_FIELDID  fieldId,
int  indexNo,
const wchar_t **  ppFieldVal,
AFP_ErrorInfo pErrorInfo
 

Retrieves a field value from a parsed feed document.

The field retrieved is an indexed one i.e. there may be more than one such field per document. Programs will typically call this function in a loop until AFPRC_BADINDEX is returned to retrieve all the fields in the document.

Parameters:
hFeedDoc Handle to an AFP document object.
fieldId The ID of the field to be retrieved.
indexNo Field index number to be retrieved (zero-based).
ppFieldVal Will be filled in with a pointer to the field value (or NULL if the field is not present).
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The field value was returned successfully.
AFPRC_BADINDEX The field index number is invalid.
See also:
Feed field ID's (indexed) for details about each field.

AFP_RETCODE AFP_GetFeedDocItemCount AFP_HFEEDDOC  hFeedDoc,
int *  pNItems,
AFP_ErrorInfo pErrorInfo
 

Returns the number of items found in a parsed feed.

Parameters:
hFeedDoc Handle to an AFP document object.
pNItems Will be filled in with the number of items found in the feed.
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The feed item count was returned successfully.

AFP_RETCODE AFP_GetFeedItemField AFP_HFEEDDOC  hFeedDoc,
int  itemNo,
AFP_FIELDID  fieldId,
const wchar_t **  ppFieldVal,
AFP_ErrorInfo pErrorInfo
 

Retrieves a field value from a feed item.

The field retrieved is a non-indexed one i.e. there is only one such field per feed item.

Parameters:
hFeedDoc Handle to an AFP document object.
itemNo The index of the feed item (zero-based).
fieldId The ID of the field to be retrieved.
ppFieldVal Will be filled in with a pointer to the field value (or NULL if the field is not present).
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The field value was returned successfully.
AFPRC_BADINDEX The field index number is invalid.
See also:
Feed item field ID's (non-indexed) for details about each field.

AFP_RETCODE AFP_GetIndexedFeedItemField AFP_HFEEDDOC  hFeedDoc,
int  itemNo,
AFP_FIELDID  fieldId,
int  indexNo,
const wchar_t **  ppFieldVal,
AFP_ErrorInfo pErrorInfo
 

Retrieves a field value from a parsed feed document.

The field retrieved is an indexed one i.e. there may be more than one such field per document. Programs will typically call this function in a loop until AFPRC_BADINDEX is returned to retrieve all the fields in the feed item.

Parameters:
hFeedDoc Handle to an AFP document object.
itemNo The index of the feed item (zero-based).
fieldId The ID of the field to be retrieved.
indexNo Field index number to be retrieved (zero-based).
ppFieldVal Will be filled in with a pointer to the field value (or NULL if the field is not present).
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The field value was returned successfully.
AFPRC_BADINDEX The field index number is invalid.
See also:
Feed item field ID's (indexed) for details about each field.