synchapi.h header

This header is used by System Services. For more information, see:

synchapi.h contains the following programming interfaces:

Functions

 
AcquireSRWLockExclusive

Acquires a slim reader/writer (SRW) lock in exclusive mode.
AcquireSRWLockShared

Acquires a slim reader/writer (SRW) lock in shared mode.
CancelWaitableTimer

Sets the specified waitable timer to the inactive state.
CreateEventA

Creates or opens a named or unnamed event object. (ANSI)
CreateEventExA

Creates or opens a named or unnamed event object and returns a handle to the object. (ANSI)
CreateEventExW

Creates or opens a named or unnamed event object and returns a handle to the object. (Unicode)
CreateEventW

Creates or opens a named or unnamed event object. (Unicode)
CreateMutexA

Creates or opens a named or unnamed mutex object. (ANSI)
CreateMutexExA

Creates or opens a named or unnamed mutex object and returns a handle to the object. (ANSI)
CreateMutexExW

Creates or opens a named or unnamed mutex object and returns a handle to the object. (Unicode)
CreateMutexW

Creates or opens a named or unnamed mutex object. (Unicode)
CreateSemaphoreExW

Creates or opens a named or unnamed semaphore object and returns a handle to the object. (CreateSemaphoreExW)
CreateSemaphoreW

Creates or opens a named or unnamed semaphore object. (CreateSemaphoreW)
CreateWaitableTimerExW

Creates or opens a waitable timer object and returns a handle to the object.
CreateWaitableTimerW

Creates or opens a waitable timer object.
DeleteCriticalSection

Releases all resources used by an unowned critical section object.
DeleteSynchronizationBarrier

Deletes a synchronization barrier.
EnterCriticalSection

Waits for ownership of the specified critical section object. The function returns when the calling thread is granted ownership.
EnterSynchronizationBarrier

Causes the calling thread to wait at a synchronization barrier until the maximum number of threads have entered the barrier.
InitializeConditionVariable

Initializes a condition variable.
InitializeCriticalSection

Initializes a critical section object.
InitializeCriticalSectionAndSpinCount

Initializes a critical section object and sets the spin count for the critical section.
InitializeCriticalSectionEx

Initializes a critical section object with a spin count and optional flags.
InitializeSRWLock

Initialize a slim reader/writer (SRW) lock.
InitializeSynchronizationBarrier

Initializes a new synchronization barrier.
InitOnceBeginInitialize

Begins one-time initialization.
InitOnceComplete

Completes one-time initialization started with the InitOnceBeginInitialize function.
InitOnceExecuteOnce

Executes the specified function successfully one time. No other threads that specify the same one-time initialization structure can execute the specified function while it is being executed by the current thread.
InitOnceInitialize

Initializes a one-time initialization structure.
LeaveCriticalSection

Releases ownership of the specified critical section object.
OpenEventA

Opens an existing named event object. (ANSI)
OpenEventW

Opens an existing named event object. (Unicode)
OpenMutexW

Opens an existing named mutex object.
OpenSemaphoreW

Opens an existing named semaphore object.
OpenWaitableTimerW

Opens an existing named waitable timer object.
ReleaseMutex

Releases ownership of the specified mutex object.
ReleaseSemaphore

Increases the count of the specified semaphore object by a specified amount.
ReleaseSRWLockExclusive

Releases a slim reader/writer (SRW) lock that was acquired in exclusive mode.
ReleaseSRWLockShared

Releases a slim reader/writer (SRW) lock that was acquired in shared mode.
ResetEvent

Sets the specified event object to the nonsignaled state.
SetCriticalSectionSpinCount

Sets the spin count for the specified critical section.
SetEvent

Sets the specified event object to the signaled state.
SetWaitableTimer

Activates the specified waitable timer. When the due time arrives, the timer is signaled and the thread that set the timer calls the optional completion routine.
SetWaitableTimerEx

Activates the specified waitable timer and provides context information for the timer. When the due time arrives, the timer is signaled and the thread that set the timer calls the optional completion routine.
SignalObjectAndWait

Signals one object and waits on another object as a single operation.
Sleep

Suspends the execution of the current thread until the time-out interval elapses.
SleepConditionVariableCS

Sleeps on the specified condition variable and releases the specified critical section as an atomic operation.
SleepConditionVariableSRW

Sleeps on the specified condition variable and releases the specified lock as an atomic operation.
SleepEx

Suspends the current thread until the specified condition is met.
TryAcquireSRWLockExclusive

Attempts to acquire a slim reader/writer (SRW) lock in exclusive mode. If the call is successful, the calling thread takes ownership of the lock.
TryAcquireSRWLockShared

Attempts to acquire a slim reader/writer (SRW) lock in shared mode. If the call is successful, the calling thread takes ownership of the lock.
TryEnterCriticalSection

Attempts to enter a critical section without blocking. If the call is successful, the calling thread takes ownership of the critical section.
WaitForMultipleObjects

Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses.
WaitForMultipleObjectsEx

Waits until one or all of the specified objects are in the signaled state, an I/O completion routine or asynchronous procedure call (APC) is queued to the thread, or the time-out interval elapses.
WaitForSingleObject

Waits until the specified object is in the signaled state or the time-out interval elapses.
WaitForSingleObjectEx

Waits until the specified object is in the signaled state, an I/O completion routine or asynchronous procedure call (APC) is queued to the thread, or the time-out interval elapses.
WaitOnAddress

Waits for the value at the specified address to change.
WakeAllConditionVariable

Wake all threads waiting on the specified condition variable.
WakeByAddressAll

Wakes all threads that are waiting for the value of an address to change.
WakeByAddressSingle

Wakes one thread that is waiting for the value of an address to change.
WakeConditionVariable

Wake a single thread waiting on the specified condition variable.

Callback functions

 
PINIT_ONCE_FN

An application-defined callback function. Specify a pointer to this function when calling the InitOnceExecuteOnce function.
PTIMERAPCROUTINE

An application-defined timer completion routine. Specify this address when calling the SetWaitableTimer function.