hpdir.h File Reference

#include <saturn.h>
#include <satdir.h>

Go to the source code of this file.

Defines

#define HPD_OK   0
 Return code OK.
#define HPD_ERROR_PAR   1
 Incorrect parameter passed to the function (e.g. NULL when a pointer is expected).
#define HPD_ERROR_TYPE   2
 The object in the dir is not of the type asked for.
#define HPD_ERROR_NOT_FOUND   3
 The object was not found.
#define HPD_ERROR_NOT_IMPLEMENTED   99
 The type of the RPL object under processing is currently not supported by HPDir.

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_ident (char *name, char **val)
 Recalls a DOIDENT 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.
char * hpd_error (int error)
 Returns a string associated with an error code.


Detailed Description

Wrappers to new saturn functions that allow to get variables from the RPL directories.

Definition in file hpdir.h.


Generated on Tue Mar 4 17:43:20 2014 for HPStack by  doxygen 1.5.0