a0DisposeMutex()

Disposes a mutex.


Syntax

a0tError a0DisposeMutex(
a0tMutex *mutex );

Arguments

Namerd/wrDescription
mutex write Mutex descriptor to dispose.

Description

This routine disposes the structures allocated to a mutex and empties its descriptor. The mutex can no longer be used afer this call.


Return Values

If an error condition occurs, it returns the error code, otherwise it returns A0ErrOk. Possible values are as follows:
Error CodeDescription
A0ErrInvMutex The mutex descriptor is invalid.
A0ErrLockedMutex The mutex is locked by other thread.
A0Err...Some error occurred.
A0ErrOkSuccessful completion.

See Also

a0NewMutex() a0LockMutex() a0UnlockMutex()