prg_file_parse_block_entry_get()
Abstract
Fills in string buffers with the key and value text from a specific parsed block entry.
Syntax
prg_file_parse_block_entry_get (handle, entry_index, name_buf, value_buf)
| Argument | Type | Description |
|---|---|---|
handle |
PrgT_File_Parse_Block_Handle |
Handle to a file block obtained by a call to prg_file_parse_block_handle_get(). |
entry_index |
int |
Which entry within the block is to be obtained. Should be between 0 and 1 less than the value returned by prg_file_parse_block_entry_count_get(). |
name_buf |
char * |
Buffer to get the key portion of the parse entry. |
value_buf |
char * |
Buffer to get the value portion of the parse entry. |
Return Type
PrgT_Compcode
Success/failure status of the entry get call.
Header
prg_file_funcs.h
Details
Fills in name and value buffers with the contents of a key/value pair in a block. The block handle identifies the block being processed and the entry_index identifies which entry within the block is to be obtained. The caller must ensure that the target buffers have already been allocated and are large enough to store the strings found in the parsed file.