SHI_ActionObligation Struct Reference

Obligation returned by SHI_ActionResult_GetObligations. More...

#include <ShiAction.h>

Data Fields
SHI_ActionObligationType	type
	Type of the obligation. More...
SHI_Flags	flags
	Flags for this obligation (e.g., SHI_ACTION_OBLIGATION_IS_MANDATORY). More...
const void *	parameters
	Pointer to a parameters structure for the obligation, or NULL if this obligation has no parameters. More...

Detailed Description

Obligation returned by SHI_ActionResult_GetObligations.

Field Documentation

flags

SHI_Flags SHI_ActionObligation::flags

Flags for this obligation (e.g., SHI_ACTION_OBLIGATION_IS_MANDATORY).

parameters

const void* SHI_ActionObligation::parameters

Pointer to a parameters structure for the obligation, or NULL if this obligation has no parameters.

The actual data structure type is inferred by the type field.

type

SHI_ActionObligationType SHI_ActionObligation::type

Type of the obligation.

The specific data structure the parameters pointer can be cast to depends on the type.

---

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

• ShiAction.h