Parameter access - first occurence
[PARARRAY: Creation and destruction]

Gets value defined in the first occurence of the key. More...

Functions

int ps_ffcstring (PARARRAY parr, const char *key, char **p)
int ps_ffchar (PARARRAY parr, const char *key, char *p)
int ps_ffshort (PARARRAY parr, const char *key, short *p)
int ps_ffint (PARARRAY parr, const char *key, int *p)
int ps_fflong (PARARRAY parr, const char *key, long *p)
int ps_ffushort (PARARRAY parr, const char *key, unsigned short *p)
int ps_ffuint (PARARRAY parr, const char *key, unsigned int *p)
int ps_ffulong (PARARRAY parr, const char *key, unsigned long *p)
int ps_fffloat (PARARRAY parr, const char *key, float *p)
int ps_ffdouble (PARARRAY parr, const char *key, double *p)
int ps_ffreal (PARARRAY parr, const char *key, ireal *p)

Detailed Description

Gets value defined in the first occurence of the key.

Parameters:
[in] parr (PARARRAY) - parameter array.
[in] key (char *) - key (null-terminated string).
[out] p (type *) - pointer to value of indicated type.
Returns:
(int) 0 if successful, else nonzero error code.
Note: the string case allocates memory, which must be managed by the calling unit; in other cases the last arg points to memory already allocated by the calling unit.

Function Documentation

int ps_ffcstring ( PARARRAY  parr,
const char *  key,
char **  p 
)

int ps_ffchar ( PARARRAY  parr,
const char *  key,
char *  p 
)

int ps_ffshort ( PARARRAY  parr,
const char *  key,
short *  p 
)

int ps_ffint ( PARARRAY  parr,
const char *  key,
int *  p 
)

int ps_fflong ( PARARRAY  parr,
const char *  key,
long *  p 
)

int ps_ffushort ( PARARRAY  parr,
const char *  key,
unsigned short *  p 
)

int ps_ffuint ( PARARRAY  parr,
const char *  key,
unsigned int *  p 
)

int ps_ffulong ( PARARRAY  parr,
const char *  key,
unsigned long *  p 
)

int ps_fffloat ( PARARRAY  parr,
const char *  key,
float *  p 
)

int ps_ffdouble ( PARARRAY  parr,
const char *  key,
double *  p 
)

int ps_ffreal ( PARARRAY  parr,
const char *  key,
ireal *  p 
)


Generated on 5 Jan 2017 for IWAVEBASE by  doxygen 1.4.7