ScField Struct Reference

Public Member Functions

ScByteArray sc_field_get_name (ScField const *field)
 
ScByteArray sc_field_get_string_value (ScField const *field)
 
ScByteArray sc_field_get_json_values (ScField const *field)
 
ScByteArray sc_field_get_issue (ScField const *field, uint32_t index)
 
size_t sc_field_get_issues_count (ScField const *field)
 

Detailed Description

Parser result field.

Member Function Documentation

ScByteArray sc_field_get_name ( ScField const *  field)

Returns the name of the given field.

Parameters
fieldThe field. Must not be NULL.
Returns
JSON string of the field. The life-time of the string is bound to the life-time of the field. The user has to free the ScByteArray structure using sc_byte_array_free.
ScByteArray sc_field_get_string_value ( ScField const *  field)

Returns the string value of the given field.

Parameters
fieldThe field. Must not be NULL.
Returns
JSON string of the field. The life-time of the string is bound to the life-time of the field. The user has to free the ScByteArray structure using sc_byte_array_free.
ScByteArray sc_field_get_json_values ( ScField const *  field)

Returns the json representation of the given field.

Parameters
fieldThe field. Must not be NULL.
Returns
JSON string of the field. The life-time of the string is bound to the life-time of the field. The user has to free the ScByteArray structure using sc_byte_array_free.
ScByteArray sc_field_get_issue ( ScField const *  field,
uint32_t  index 
)

Returns issue string at the given index.

Parameters
fieldThe field. Must not be NULL.
indexInde position of issue string to be returned.
Returns
JSON string of the field. The life-time of the string is bound to the life-time of the field. The user has to free the ScByteArray structure using sc_byte_array_free.
size_t sc_field_get_issues_count ( ScField const *  field)

Returns number of issues for the given field.

Parameters
fieldThe field. Must not be NULL.
Returns
number of issues.

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