clear_barrierclear_barrierclear_barrierClearBarrierClearBarrier (Operator)

Name

clear_barrierclear_barrierclear_barrierClearBarrierClearBarrier — Destroy a barrier synchronization object.

Signature

Description

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

Parallelization

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

Parameters

Result

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

Possible Predecessors

create_barriercreate_barriercreate_barrierCreateBarrierCreateBarrier

See also

create_barriercreate_barriercreate_barrierCreateBarrierCreateBarrier, clear_all_barriersclear_all_barriersclear_all_barriersClearAllBarriersClearAllBarriers

Module

Foundation