Availability:C-language interface function
atom_t
(see current_prolog_flag/2).
type specifies the kind of value to be retrieved, it is one
of the values below. value is a pointer to a location where
to store the value. The user is responsible for making sure this memory
location is of the appropriate size/type (see the returned types below
to determine the size/type). The function returns TRUE
on
success and FALSE
on failure.
PL_ATOM
- Retrieve a flag whose value is an
atom
. The returned value is an atom handle of typeatom_t
. PL_INTEGER
- Retrieve a flag whose value is an
integer
. The returned value is an integer of typeint64_t
. PL_FLOAT
- Retrieve a flag whose value is a
float
. The returned value is a floating point number of typedouble
. PL_TERM
- Retrieve a flag whose value is a
term
. The returned value is a term handle of typeterm_t
.