next up previous contents
Next: 4.8 fluke_region_move: move a Up: 4 Regions Previous: 4.6 fluke_region_destroy: destroy a

4.7 fluke_region_get_state: retrieve the current state of a region object

SYNOPSIS

void fluke_region_get_state(fluke_region_t *region, fluke_region_state *state, fluke_ref_t *task_ref, fluke_ref_t *keeper_ref);

DESCRIPTION

This operation retrieves the state of a region object.

PARAMETERS

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

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
region does not point to an active object.
NOT_REGION
The object pointed to by region is not a region object.
INVALID_OBJECT
The state of the region object or one of the reference objects has become invalid.
NOT_REF
task_ref or keeper_ref is not a pointer to a reference object.

RELATED INFORMATION

fluke_region_set_state



Utah Flux Research Group