diff options
Diffstat (limited to 'include/osl/mutex.h')
-rw-r--r-- | include/osl/mutex.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/osl/mutex.h b/include/osl/mutex.h index 6cbfba15f026..8761f33737f7 100644 --- a/include/osl/mutex.h +++ b/include/osl/mutex.h @@ -33,11 +33,13 @@ struct _oslMutexImpl; typedef struct _oslMutexImpl * oslMutex; /** Create a mutex. + @return 0 if the mutex could not be created, otherwise a handle to the mutex. */ SAL_DLLPUBLIC oslMutex SAL_CALL osl_createMutex(void); /** Release the OS-structures and free mutex data-structure. + @param Mutex the mutex-handle */ SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex); @@ -49,18 +51,22 @@ SAL_DLLPUBLIC void SAL_CALL osl_destroyMutex(oslMutex Mutex); SAL_DLLPUBLIC sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex); /** Try to acquire the mutex without blocking. + @param Mutex handle to a created mutex. + @retval False if it could not be acquired. */ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex); /** Release the mutex. + @param Mutex handle to a created mutex. @retval False if system-call fails. */ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex); /** Returns a unique and global mutex. + @return the global mutex. */ SAL_DLLPUBLIC oslMutex * SAL_CALL osl_getGlobalMutex(void); |