1.4.4.12 OSAL_MUTEX_Unlock Function

1.4.4.12 C

OSAL_RESULT OSAL_MUTEX_Unlock(OSAL_MUTEX_HANDLE_TYPE* mutexID)

1.4.4.12 Summary

Unlocks a mutex.

1.4.4.12 Description

This function unlocks a previously obtained mutex.

1.4.4.12 Precondition

Mutex must have been created.

1.4.4.12 Parameters

ParametersDescription
mutexIDPointer to the mutex handle

1.4.4.12 Returns

OSAL_RESULT_TRUE - Mutex released.

OSAL_RESULT_FALSE - Mutex failed to be released or error occurred.

1.4.4.12 Example

...
if (OSAL_MUTEX_Lock(&mutexData, 1000) == OSAL_RESULT_TRUE)
{
    // manipulate the shared data
    ...
    
    // unlock the mutex
    OSAL_MUTEX_Unlock(&mutexData);
}

1.4.4.12 Remarks

None.