OfxMultiThreadSuiteV1::mutexLock
Prev   Multi Threading Suite   Next

Name

OfxMultiThreadSuiteV1::mutexLock — Blocking lock on the mutex

Synopsis

#include "ofxMultiThread.h"
OfxStatus (*mutexLock) ( const OfxMutexHandle mutex ) ;
 

Arguments

  • mutex -

Description

This trys to lock a mutex and blocks the thread it is in until the lock suceeds.

A sucessful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked.

Returns

  • kOfxStatOK - if it got the lock
  • kOfxStatErrBadHandle - if the handle was bad

Prev   Up   Next
OfxMultiThreadSuiteV1::mutexDestroy   Home   OfxMultiThreadSuiteV1::mutexUnLock