WSB_ActionResultConstraint Class

Marlin license consumption constraints access. More...

Typedefs
typedef struct WSB_ActionResultConstraint	WSB_ActionResultConstraint
	A WSB_ActionResultConstraint object represents a single constraint associated with a SHI_ActionResult. More...
typedef struct WSB_ActionResultOutputControlConstraint	WSB_ActionResultOutputControlConstraint
	A WSB_ActionResultOutputControlConstraint object represents a single output control constraint associated with a SHI_ActionResult. More...

Functions
WSB_EXPORT WSB_UInt32	WSB_ActionResultConstraint_GetType (WSB_ActionResultConstraint *constraint)
	Returns the type of the constraint. More...
WSB_EXPORT WSB_Boolean	WSB_ActionResultConstraint_IsMandatory (WSB_ActionResultConstraint *constraint)
	Returns a boolean indicating whether the constraint is mandatory. More...
WSB_EXPORT WSB_ActionResultOutputControlConstraint *	WSB_ActionResultConstraint_GetAsOutputControlConstraint (WSB_ActionResultConstraint *constraint)
	For constraints of type WSB_ACTION_RESULT_CONSTRAINT_TYPE_OUTPUT_CONTROL, returns a pointer to a WSB_ActionResultOutputControlConstraint object. More...
WSB_EXPORT WSB_UInt32	WSB_ActionResultOutputControlConstraint_GetTechnology (WSB_ActionResultOutputControlConstraint *constraint)
	Returns the technology type associated with the specified output control constraint. More...
WSB_EXPORT WSB_UInt32	WSB_ActionResultOutputControlConstraint_GetParameter (WSB_ActionResultOutputControlConstraint *constraint)
	Returns the parameter type associated with the specified output control constraint. More...
WSB_EXPORT WSB_UInt32	WSB_ActionResultOutputControlConstraint_GetValue (WSB_ActionResultOutputControlConstraint *constraint)
	Returns the integer value associated with the technology and parameter in the specified output control constraint. More...
WSB_EXPORT WSB_Result	WSB_ActionResultConstraint_Destroy (WSB_ActionResultConstraint *constraint)
	Destroys the WSB_ActionResultConstraint object. More...

Detailed Description

Marlin license consumption constraints access.

Typedef Documentation

typedef struct WSB_ActionResultConstraint WSB_ActionResultConstraint

A WSB_ActionResultConstraint object represents a single constraint associated with a SHI_ActionResult.

typedef struct WSB_ActionResultOutputControlConstraint WSB_ActionResultOutputControlConstraint

A WSB_ActionResultOutputControlConstraint object represents a single output control constraint associated with a SHI_ActionResult.

Function Documentation

WSB_EXPORT WSB_Result WSB_ActionResultConstraint_Destroy

(

WSB_ActionResultConstraint *

constraint

)

Destroys the WSB_ActionResultConstraint object.

Parameters

constraint

The WSB_ActionResultConstraint to be destroyed.

WSB_EXPORT WSB_ActionResultOutputControlConstraint* WSB_ActionResultConstraint_GetAsOutputControlConstraint

(

WSB_ActionResultConstraint *

constraint

)

For constraints of type WSB_ACTION_RESULT_CONSTRAINT_TYPE_OUTPUT_CONTROL, returns a pointer to a WSB_ActionResultOutputControlConstraint object.

Parameters

constraint

The WSB_ActionResultConstraint object.

Returns

A pointer to a WSB_ActionResultOutputControlConstraint object.

WSB_EXPORT WSB_UInt32 WSB_ActionResultConstraint_GetType

(

WSB_ActionResultConstraint *

constraint

)

Returns the type of the constraint.

See WSB_ACTION_RESULT_CONSTRAINT_TYPE_XXX constants for possible values.

Parameters

constraint

The WSB_ActionResultConstraint object.

Returns

The type of the constraint.

WSB_EXPORT WSB_Boolean WSB_ActionResultConstraint_IsMandatory

(

WSB_ActionResultConstraint *

constraint

)

Returns a boolean indicating whether the constraint is mandatory.

Mandatory constraints must be supported and handled by the application, while optional constraints my be ignored, if not supported. However, it is recommended that optional constraints by handled, if possible.

Parameters

constraint

The WSB_ActionResultConstraint object.

Returns

WSB_TRUE if the constraint is mandatory, WSB_FALSE otherwise.

WSB_EXPORT WSB_UInt32 WSB_ActionResultOutputControlConstraint_GetParameter

(

WSB_ActionResultOutputControlConstraint *

constraint

)

Returns the parameter type associated with the specified output control constraint.

See WSB_ACTION_RESULT_CONSTRAINT_OUTPUT_CONTROL_PARAMETER_XXX constants for possible values.

Parameters

constraint

The WSB_ActionResultOutputControlConstraint object.

Returns

An integer representing the output control parameter of the specified constraint.

WSB_EXPORT WSB_UInt32 WSB_ActionResultOutputControlConstraint_GetTechnology

(

WSB_ActionResultOutputControlConstraint *

constraint

)

Returns the technology type associated with the specified output control constraint.

See WSB_ACTION_RESULT_CONSTRAINT_OUTPUT_CONTROL_TECHNOLOGY_XXX constants for possible values.

Parameters

constraint

The WSB_ActionResultOutputControlConstraint whose technology type will be returned.

Returns

An integer representing the output control technology of the specified constraint.

WSB_EXPORT WSB_UInt32 WSB_ActionResultOutputControlConstraint_GetValue

(

WSB_ActionResultOutputControlConstraint *

constraint

)

Returns the integer value associated with the technology and parameter in the specified output control constraint.

For possible values, see the Marlin Output Control Specification.

Parameters

constraint

The WSB_ActionResultOutputControlConstraint object.

Returns

An integer representing the value of the output control technology's parameter.