Recall objects from directories


Functions

int hpd_rcl_int (char *name, long long *val)
 Recalls a DOINT RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_uint (char *name, unsigned long long *val)
 Recalls a DOHXS RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_real (char *name, double *val)
 Recalls a DOREAL RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_complex (char *name, complex_t *val)
 Recalls a DOCMP RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_str (char *name, char **val)
 Recalls a DOCSTR RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_list (char *name, list_t **val)
 Recalls a DOLIST RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_array (char *name, array_t **val)
 Recalls a DOMATRIX or DOARRY RPL object from the current or an upper directory, and puts its value into the variable passed as argument.
int hpd_rcl_symb (char *name, entry_t **val)
 Recalls a DOSYMB RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

Function Documentation

int hpd_rcl_array char *  name,
array_t **  val
 

Recalls a DOMATRIX or DOARRY RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches.

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_complex char *  name,
complex_t val
 

Recalls a DOCMP RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches.

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_int char *  name,
long long *  val
 

Recalls a DOINT RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches, or if the convert flag is set (see hps_convert) and the type is convertable. The authorized conversions are described below : DOHXS (unsigned long long) -> DOINT (long long) DOREAL (double) -> DOINT (long long)

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_list char *  name,
list_t **  val
 

Recalls a DOLIST RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches.

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_real char *  name,
double *  val
 

Recalls a DOREAL RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type match, or if the convert flag is set (see hps_convert) and the type is convertable. The authorized conversions are described below : DOHXS (unsigned long long) -> DOREAL (double) DOINT (long long) -> DOREAL (double) DOCMP (complex_t) -> DOREAL (double) if imaginary part is null

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_str char *  name,
char **  val
 

Recalls a DOCSTR RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches.

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_symb char *  name,
entry_t **  val
 

Recalls a DOSYMB RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches.

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise

int hpd_rcl_uint char *  name,
unsigned long long *  val
 

Recalls a DOHXS RPL object from the current or an upper directory, and puts its value into the variable passed as argument.

This function searches for the variable in the current or upper directory. The value is read if the type matches.

Parameters:
name The name of the object
val The pointer to the read value
Returns:
HPD_ERROR_NOT_FOUND if the variable was not found, HPD_ERROR_TYPE if the type of the object is incompatible, HPD_OK otherwise


Generated on Sat Sep 16 18:23:57 2006 for HPStack by  doxygen 1.4.5