 |
PK_SESSION_ask_behaviour |
|
PK_ERROR_code_t PK_SESSION_ask_behaviour
(
--- received arguments ---
const PK_SESSION_ask_behaviour_o_t *options, --- option structure
--- returned arguments ---
PK_SESSION_behaviour_t *const behaviour --- currently set behaviour
)
This function returns the currently set behaviour of the modeller.
At session start the behaviour of the modeller is initialized as follows:
- The 'behaviour_type' field of 'behaviour' is initialized to
PK_SESSION_behave_as_unset_c.
- The 'behaviour_value' field is zero.
These values can be changed during the session by calling
PK_SESSION_set_behaviour.
If 'behaviour_type' is PK_SESSION_behave_as_value_c then the 'behaviour_value'
returned from this function is the value that was set from the most recent call
to PK_SESSION_set_behaviour.
If 'behaviour_type' is PK_SESSION_behave_as_latest_c then the 'behaviour_value'
returned from this function is the latest allowed behaviour of the modeller.
If 'behaviour_type' is PK_SESSION_behave_as_unset_c then the 'behaviour_value'
returned from this function is zero.