SHI_ActionResultInfo Struct Reference

Information about an action result. More...

#include <ShiAction.h>

Data Fields
SHI_Boolean	is_granted
	Indicates whether the action is granted or not. More...
SHI_Boolean	is_permanent
	Indicates whether this info is permanent or not. More...
SHI_Flags	flags
	Flags (see flags for SHI_ActionResultInfo) above. More...

Detailed Description

Information about an action result.

This information indicates whether the action result represents a grant or a denial of the action request, and whether or not this grant or denial is permanent. When the is_permament field is set to SHI_TRUE, the caller may infer that this is not a transient state; subsequent action requests under the same conditions would lead to the same result.

If the action result contains any callbacks or obligations, one or both of the flags SHI_ACTION_RESULT_HAS_CALLBACKS and SHI_ACTION_RESULT_HAS_OBLIGATIONS, respectively, will be set, as appropriate. If any callback or obligation is mandatory, an additional flag SHI_ACTION_RESULT_MUST_ACCEPT will be set. In the "must accept" case, the caller must not call SHI_ActionResult_Accept without first inspecting the callbacks and obligations and ensuring that it understands and is able to perform all mandatory obligations and callbacks.

Field Documentation

flags

SHI_Flags SHI_ActionResultInfo::flags

Flags (see flags for SHI_ActionResultInfo) above.

is_granted

SHI_Boolean SHI_ActionResultInfo::is_granted

Indicates whether the action is granted or not.

is_permanent

SHI_Boolean SHI_ActionResultInfo::is_permanent

Indicates whether this info is permanent or not.

---

The documentation for this struct was generated from the following file:

• ShiAction.h