Unit Threads

Return to Unit Reference

InitialOwner	If true set the state of the spin to locked and the owner to the current thread
Return	Handle of new Spin entry or INVALID_HANDLE_VALUE if entry could not be created

Spin	Handle of Spin entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Spin	Handle of Spin entry to get owner for
Return	Handle of owning thread or INVALID_HANDLE_VALUE if not currently owned

Spin	Handle of Spin entry to lock
Return	ERROR_SUCCESS if completed or another error code on failure

Spin	Handle of Spin entry to unlock
Return	ERROR_SUCCESS if completed or another error code on failure

Unit Threads

Contents

Description

Constants

Type definitions

Public variables

Function declarations

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

Spin	Handle of Spin entry to check
Return	True if the mask would enable IRQ on restore, False if it would not
Note	The Spin entry must be locked by the current thread

Spin1	Handle of first Spin entry
Spin2	Handle of second Spin entry
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Both Spin entries must be locked by the current thread

InitialOwner	If true set the state of the mutex to locked and the owner to the current thread
SpinCount	The number of times the mutex will spin before yielding (Always 0 if CPU count equals 1)
Flags	The flags for the Mutex entry (eg MUTEX_FLAG_RECURSIVE)
Return	Handle of new Mutex entry or INVALID_HANDLE_VALUE if entry could not be created

Mutex	Handle of Mutex entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Mutex	Handle of Mutex entry to get flags for
Return	Current flags or INVALID_HANDLE_VALUE on error

Mutex	Mutex to get count for
Return	Current lock count or INVALID_HANDLE_VALUE on error
Note	Count is only valid if Flags includes MUTEX_FLAG_RECURSIVE

Mutex	Handle of Mutex entry to get owner for
Return	Handle of owning thread or INVALID_HANDLE_VALUE if not currently owned

Mutex	Handle of Mutex entry to lock
Return	ERROR_SUCCESS if completed or another error code on failure

Mutex	Handle of Mutex entry to unlock
Return	ERROR_SUCCESS if completed or another error code on failure

Mutex	Mutex to try to lock
Return	ERROR_SUCCESS if completed, ERROR_LOCKED if already locked or another error code on failure
Note	If the Mutex is not locked then lock it and mark the owner as the current thread. If the Mutex is already locked then return immediately with an error and do not wait for it to be unlocked.

CriticalSection	If true set the state of the criticalsection to locked and the owner to the current thread
SpinCount	The number of times the criticalsection will spin before waiting (Always 0 if CPU count equals 1)
Return	Handle of new CriticalSection entry or INVALID_HANDLE_VALUE if entry could not be created

CriticalSection	Handle of CriticalSection entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

CriticalSection	CriticalSection to get count for
Return	Current lock count or INVALID_HANDLE_VALUE on error

CriticalSection	CriticalSection to get owner for
Return	Handle of owning thread or INVALID_HANDLE_VALUE if not currently owned

CriticalSection	CriticalSection to set spin count for
SpinCount	The spin count value to set
Return	Current spin count or INVALID_HANDLE_VALUE on error

CriticalSection	CriticalSection to lock
Return	ERROR_SUCCESS if completed or another error code on failure
Note	If the CriticalSection is not locked then lock it, set the count to one and mark the owner as the current thread. If the CriticalSection is already locked by the current thread then increment the count and return immediately. If the CriticalSection is already locked by another thread then wait until it is unlocked.

CriticalSection	CriticalSection to lock
Timeout	Milliseconds to wait before timeout (0 equals do not wait, INFINITE equals wait forever)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	If the CriticalSection is not locked then lock it, set the count to one and mark the owner as the current thread. If the CriticalSection is already locked by the current thread then increment the count and return immediately. If the CriticalSection is already locked by another thread then wait until it is unlocked.

CriticalSection	CriticalSection to unlock
Return	ERROR_SUCCESS if completed or another error code on failure
Note	If the CriticalSection is locked by the current thread then decrement the count. If the count is greater than zero then return immediately. If the count reaches zero then unlock the CriticalSection and release the first thread waiting for it to be unlocked. If the CriticalSection is locked by another thread then return an error. If the CriticalSection is not locked then return an error.

CriticalSection	CriticalSection to try to lock
Return	ERROR_SUCCESS if completed, ERROR_LOCKED if locked by another thread or another error code on failure
Note	If the CriticalSection is not locked then lock it, set the count to one and mark the owner as the current thread. If the CriticalSection is already locked by the current thread then increment the count and return immediately. If the CriticalSection is already locked by another thread then return immediately with an error and do not wait for it to be unlocked.

Count	The initial count of the Semaphore (Must be greater than or equal to zero)
Return	Handle of new Semaphore entry or INVALID_HANDLE_VALUE if entry could not be created

Count	The initial count of the Semaphore (Must be greater than or equal to zero)
Maximum	The maximum count of the Semaphore (Must be greater than one)
Flags	The flags for the Semaphore entry (eg SEMAPHORE_FLAG_IRQ)
Return	Handle of new Semaphore entry or INVALID_HANDLE_VALUE if entry could not be created

Semaphore	Handle of Semaphore entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Semaphore	Semaphore to get count for
Return	Current count or INVALID_HANDLE_VALUE on error

Semaphore	Semaphore to wait on
Return	ERROR_SUCCESS if completed or another error code on failure
Note	If the Semaphore count is greater than zero it will be decremented and this function will return immediately. If the Semaphore count is zero the current thread will be put on a wait queue until the Semaphore is signalled by another thread calling SemaphoreSignal() or SemaphoreSignalEx().

Semaphore	Semaphore to signal
Return	ERROR_SUCCESS if completed or another error code on failure
Note	If any threads are waiting on the Semaphore then one thread will be woken up and placed on the ready queue. If no threads are wait then the Semaphore count will be incremented.

InitialReader	If true set the state of the synchronizer to locked and the reader count to 1
InitialWriter	If true set the state of the synchronizer to locked and the writer owner to the current thread
Return	Handle of new Synchronizer entry or INVALID_HANDLE_VALUE if entry could not be created

Synchronizer	Handle of Synchronizer entry to destroy
Return	ERROR_SUCCESS if completed or another error code on failure

Synchronizer	Synchronizer to get count for
Return	Current reader count or INVALID_HANDLE_VALUE on error

Synchronizer	Synchronizer to last reader for
Return	Last reader thread or INVALID_HANDLE_VALUE on error

Synchronizer	Synchronizer to lock
Return	ERROR_SUCCESS if completed or another error code on failure
Note	If the Synchronizer is not locked then lock it and set the reader count to one. If the Synchronizer is already locked for reading then increment the reader count and return immediately. If the Synchronizer is already locked for writing then wait until it is unlocked.