SpField Struct Reference

Public Member Functions

SpData sp_field_get_name (SpField const *field)
 
SpData sp_field_get_string_value (SpField const *field)
 
SpData sp_field_get_json_values (SpField const *field)
 
SpData sp_field_get_issue (SpField const *field, uint32_t index)
 
size_t sp_field_get_issues_count (SpField const *field)
 

Detailed Description

Parser result field.

Member Function Documentation

SpData sp_field_get_name ( SpField const *  field)

Returns the name of the given field.

Parameters
fieldThe field. Must not be NULL. The life-time of the string is bound to the life-time of the field. The user has to free the SpData structure using sp_data_free.
SpData sp_field_get_string_value ( SpField const *  field)

Returns the string value of the given field.

Parameters
fieldThe field. Must not be NULL. The life-time of the string is bound to the life-time of the field. The user has to free the SpData structure using sp_data_free.
SpData sp_field_get_json_values ( SpField const *  field)

Returns the json representation of the given field.

Parameters
fieldThe field. Must not be NULL. The life-time of the string is bound to the life-time of the field. The user has to free the SpData structure using sp_data_free.
SpData sp_field_get_issue ( SpField const *  field,
uint32_t  index 
)

Returns issue string at the given index.

Parameters
fieldThe field. The life-time of the vector is bound to the life-time of the field. The user has to free the SpData structure using sp_data_free.
indexThe index. Position of issue string to be returned.
size_t sp_field_get_issues_count ( SpField const *  field)

Returns number of issues for the given field.

Parameters
fieldThe field. The life-time of the vector is bound to the life-time of the field. The user has to free the SpData structure using sp_data_free.

The documentation for this struct was generated from the following file: