clear_barrierclear_barrierClearBarrierClearBarrier (Operator)

Name

clear_barrierclear_barrierClearBarrierClearBarrier — Destroy a barrier synchronization object.

clear_barrierclear_barrierClearBarrierClearBarrierClearBarrier destroys the barrier object given in BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandle. No threads should be waiting on the barrier at the time clear_barrierclear_barrierClearBarrierClearBarrierClearBarrier is called. After calling clear_barrierclear_barrierClearBarrierClearBarrierClearBarrier, the barrier can no longer be used. The handle BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandle becomes invalid.

Execution Information

Multithreading type: independent (runs in parallel even with exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandle (input_control) barrier → (integer)

Barrier synchronization object.

Result

If the barrier handle is valid, the operator clear_barrierclear_barrierClearBarrierClearBarrierClearBarrier returns 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

create_barriercreate_barrierCreateBarrierCreateBarrierCreateBarrier

Module

Foundation

Operators