Main Page   Modules   Data Structures   File List   Data Fields   Related Pages   Examples  

Utility functions

Perform miscellaneous operations. More...

Functions

const char * sedabl_block_key (sedabl_block *block)
 Retrieve a block's key string.

int sedabl_block_is_list (sedabl_block *block)
 Determine whether a block is a list or a value block.

sedabl_valsedabl_block_value (sedabl_block *block)
 Extract the value in a value block.

sedabl_listsedabl_block_elements (sedabl_block *block)
 Extract the list of element blocks in a list block.


Detailed Description

Perform miscellaneous operations.

Routines to peek inside the guts of SeDaBl blocks. These routines are implemented and documented in util.c


Function Documentation

const char* sedabl_block_key sedabl_block   block
 

Retrieve a block's key string.

Parameters:
block The block whose key to retrieve.
Returns:
The key associated with the given block, or NULL on failure.
Note:
A block may have no key, in which case this function returns NULL. This is not an error condition.

int sedabl_block_is_list sedabl_block   block
 

Determine whether a block is a list or a value block.

Parameters:
block The block to test for type
Returns:
0 if the block is not a list, 1 if it is

sedabl_val* sedabl_block_value sedabl_block   block
 

Extract the value in a value block.

Parameters:
block The value block whose value to extract.
Returns:
A pointer to the byte string as a sedabl_val, or NULL on error.

sedabl_list* sedabl_block_elements sedabl_block   block
 

Extract the list of element blocks in a list block.

Parameters:
block The list block whose elements to extract.
Returns:
A pointer to the array of element blocks, or NULL on error.


Generated on Mon Sep 15 07:27:33 2003 for SeDaBl C API by doxygen1.3-rc3