IWAVEBASE 1.0
Functions

Output to stream

PARARRAY: Creation and destruction

Functions

int ps_printall (PARARRAY parr, FILE *stream)
 Write contents of PARARRAY to stream.
int ps_createfp (PARARRAY *parr, FILE *fp)
 Creates parameter array (STORAGE ALLOCATION) from by reading from file pointer.
int ps_createfile_fproto (PARARRAY *parr, FILE **stream, const char *proto, const char *filename)
 Creates parameter array (STORAGE ALLOCATION) from file.
int ps_createfile (PARARRAY *parr, const char *filename)
 Creates parameter array (STORAGE ALLOCATION) from file.
int ps_createargs (PARARRAY *parr, int argc, char **argv)
 Creates parameter array (STORAGE ALLOCATION) from command-line argument list NOTE: if "par" is amongst keys, create additional parameters (key=value pairs) from file whose name is value for "par".
int ps_copy (PARARRAY **tgt, PARARRAY src)
 Full copy function: lhs = rhs (STORAGE (RE)ALLOCATED)

Function Documentation

int ps_printall ( PARARRAY  parr,
FILE *  stream 
)

Write contents of PARARRAY to stream.

Parameters:
[in]parr(PARARRAY) - input param array
[out]stream(FILE *) - output stream
Returns:
(int) 0 if successful, else nonzero error code.
int ps_createfp ( PARARRAY parr,
FILE *  fp 
)

Creates parameter array (STORAGE ALLOCATION) from by reading from file pointer.

Parameters:
[out]parr(PARARRAY *) - param array created on successful return
[in]fp(FILE *) - file pointer
Returns:
(int) 0 if successful, else nonzero error code.
int ps_createfile_fproto ( PARARRAY parr,
FILE **  stream,
const char *  proto,
const char *  filename 
)

Creates parameter array (STORAGE ALLOCATION) from file.

Returns control of file pointer, which may be allocated via iwave_fopen (or simply returned, if file is already open). Includes optional specification of file prototype.

Parameters:
[out]parr- param array created on successful return
in/out]stream - pointer to FILE pointer, which may be alloc
[in]proto- optional prototype filename for use by iwave_fopen, or NULL
[in]filename- name of parfile containing key=value info
Returns:
(int) 0 if successful, else nonzero error code.
int ps_createfile ( PARARRAY parr,
const char *  filename 
)

Creates parameter array (STORAGE ALLOCATION) from file.

Parameters:
[out]parr(PARARRAY *) - param array created on successful return
[in]filename(char *) - name of parfile containing key=value info
Returns:
(int) 0 if successful, else nonzero error code.
int ps_createargs ( PARARRAY parr,
int  argc,
char **  argv 
)

Creates parameter array (STORAGE ALLOCATION) from command-line argument list NOTE: if "par" is amongst keys, create additional parameters (key=value pairs) from file whose name is value for "par".

Parameters:
[out]parr(PARARRAY *) - param array created on successful return
[in]argc(int) - arg count
[in]argv(char**) - arg array
Returns:
(int) 0 if successful, else nonzero error code.
int ps_copy ( PARARRAY **  tgt,
PARARRAY  src 
)

Full copy function: lhs = rhs (STORAGE (RE)ALLOCATED)

Parameters:
lhs(PARARRAY **) - target parameter array
rhs(PARARRAY) - source parameter array (const)
Returns:
(int) 0 if successful, else nonzero error code.
 All Classes Namespaces Files Functions Variables Typedefs Defines