Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


Global Functions in Global Namespace C++
in Sourcefile mutex.h


osl_acquireMutex
extern "C"
sal_Bool osl_acquireMutex(
oslMutex Mutex );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Acquire the mutex, block if already acquired by another thread.
Parameters
Mutex
handle to a created mutex.
Return
False if system-call fails.

osl_createMutex
extern "C"
oslMutex osl_createMutex(
void );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Create a thread-local mutex.
Return
0 if the mutex could not be created, otherwise a handle to the mutex.

osl_destroyMutex
extern "C"
void osl_destroyMutex(
oslMutex Mutex );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Release the OS-structures and free mutex data-structure.
Parameters
Mutex
the mutex-handle 

osl_getGlobalMutex
extern "C"
oslMutex * osl_getGlobalMutex(
void );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Returns a unique and global mutex.
Return
the global mutex.

osl_releaseMutex
extern "C"
sal_Bool osl_releaseMutex(
oslMutex Mutex );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Release the mutex.
Parameters
Mutex
handle to a created mutex.
Return
False if system-call fails.

osl_tryToAcquireMutex
extern "C"
sal_Bool osl_tryToAcquireMutex(
oslMutex Mutex );

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO NO YES

Summary
Try to acquire the mutex without blocking.
Parameters
Mutex
handle to a created mutex.
Return
False if it could not be acquired.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.