next up previous contents
Next: 5.8 fluke_mapping_move: move a Up: 5 Mappings Previous: 5.6 fluke_mapping_destroy: destroy a

5.7 fluke_mapping_get_state: retrieve the current state of a mapping object

SYNOPSIS

void fluke_mapping_get_state(fluke_mapping_t *mapping, fluke_mapping_state *state, fluke_ref_t *region_ref, fluke_ref_t *task_ref);

DESCRIPTION

This operation retrieves the state of a mapping object.

PARAMETERS

mapping
The mapping whose state is to be retrieved.
state
If non-null, the structure to fill in with the simple (non-reference) mapping state.
region_ref
If non-null, the address of a reference object to associate with the mapping's region object.
task_ref
If non-null, the address of a reference object to associate with the mapping's task object.

ERRORS

If any of the following errors is detected by the Fluke implementation, it causes the current thread to take a synchronous exception with one of the following codes. All of these have an implicit FLUKE_INSANITY_ prefix.
NO_OBJECT
mapping does not point to an active object.
NOT_MAPPING
The object pointed to by mapping is not a mapping object.
INVALID_OBJECT
The state of the mapping object or one of the reference objects has become invalid.
NOT_REF
region_ref or task_ref is not a pointer to a reference object.

RELATED INFORMATION

fluke_mapping_set_state



Utah Flux Research Group