PEXOCCConditionalExecuteStructure - Conditional Execute Structure (5.2)

Synopsis 

 
   void PEXOCCConditionalExecuteStructure(
        PEXOCC context,
        unsigned long mask,
        int test,
        PEXStructure structure
   )

Arguments

context
An OC context returned by a successful PEXCreateOCC call.

display (OCC)
A pointer to a display structure returned by a successful XOpenDisplay call.

resource_id (OCC)
The resource identifier of the renderer or structure.

req_type (OCC)
The request type for the output command (PEXOCRender, PEXOCStore, PEXOCRenderSingle or PEXOCStoreSingle).

mask
The bit mask to use in the conditional test.

test
The type of conditional test to use (PEXCTAllEnabled, PEXCTAllDisabled, PEXCTNotAllDisabled, PEXCTNotAllEnabled, PEXCTAlwaysPass or PEXCTAlwaysFail).

structure
The resource identifier of the structure.

Returns

None.

Description

Invoke PEXOCCConditionalExecuteStructure to create a conditional execute structure output command.

Use the mask argument to select which bits in the renderer's condition flags are used in the test. The test passes if these selected bits in the renderer's condition flags meet the condition described by the test argument. If the test passes, then the implementation performs the same operation as described in PEXOCCExecuteStructure, using the structure argument as the structure identifier of the structure to process next. If the test fails, then the implementation continues processing output commands without invoking the structure specified by the structure argument.

If structure does not exist at the time PEXOCCConditionalExecuteStructure is processed, then the implementation issues a BadPEXOutputCommand error. You must first create the structure.

Errors

BadPEXOutputCommand
The structure argument references an non-existent structure.

BadPEXOutputCommand
The test argument is not a registered value.

BadPEXRenderer
The specified renderer resource identifier is invalid.

BadPEXStructure
The specified structure resource identifier is invalid.

See Also

See Structure Control and Miscellaneous Functions for an overview.