NAME

cxParamStrGet - returns parameter value as a string

C SPECIFICATION

#include <cx/DataAccess.h>

char *cxParamStrGet(cxParameter *src)

FORTRAN SPECIFICATION

integer function cxParamStrGet( src, str )
integer src
character*(*) str

PARAMETERS

src
Input data structure.
str
In Fortran, the output string.

FUNCTION RETURN VALUE

In C, the value of src as a string. In Fortran, the length of the string.

DESCRIPTION

Returns a new string containing the value of the parameter src. If src is of type long or double, the value is formatted by sprintf ("%d" and "%lf" formats, respectively). The space for the new string is obtained using malloc(3C,3X).

In Fortran the returned string is padded with blanks to the length of the character variable, or truncated if the character variable is not long enough to hold it. The integer return value is the length of the string in the parameter, which may be longer than the character variable provided by the user, in which case the caller should try again to get the full string.

SEE ALSO

cxParamStrSet(3E)
Last modified: Mon Nov 18 13:51:35 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996