prg_file_parse_block_handle_get()
Abstract
Returns a handle to a parse block that can be examined for entries.
Syntax
prg_file_parse_block_handle_get (parse_ptr, block_type_str, block_index)
| Argument | Type | Description |
|---|---|---|
parse_ptr |
PrgT_File_Parse * |
Parse data structure returned by prg_file_parse() or prg_tfile_parse() |
block_type_str |
const char * |
The name of a specific block type or NULL. |
block_index |
int |
Which block of a specific type this handle is to identify. This block index should be in the range 0 to 1 less than the value returned by prg_file_parse_block_count_get(). |
Return Type
PrgT_File_Parse_Block_Handle
Handle to parsed block.
Header
prg_file_funcs.h
Details
Returns a block handle identifying a specific block in a parsed configuration file. The block handle is used by other prg_file_parse… functions to examine its entries.