Reference material for Xbox One thread APIs.
Note that this list is limited to the most important functions for game developers. There are other APIs related to threads, thread pools, and fibers that are part of the XDK but which are not documented here. Consult the Windows 8 SDK documentation for those APIs.
CallbackMayRunLong
Indicates that the callback may not return quickly.
CancelThreadpoolIo
Cancels the notification from the StartThreadpoolIo function.
CloseThreadpoolCleanupGroupMembers
Releases the members of the specified cleanup group, waits for all callback functions to complete, and optionally cancels any outstanding callback functions.
CloseThreadpoolCleanupGroup
Closes the specified cleanup group.
CloseThreadpoolIo
Releases the specified I/O completion object.
CloseThreadpoolTimer
Releases the specified timer object.
CloseThreadpoolWait
Releases the specified wait object.
CloseThreadpoolWork
Releases the specified work object.
CloseThreadpool
Closes the specified thread pool.
Creates a thread to execute within the virtual address space of the calling process.
CreateThreadpool
Allocates a new pool of threads to execute callbacks.
CreateThreadpoolCleanupGroup
Creates a cleanup group that applications can use to track one or more thread pool callbacks.
CreateThreadpoolIo
Creates a new I/O completion object.
CreateThreadpoolTimer
Creates a new timer object.
CreateThreadpoolWait
Creates a new wait object.
CreateThreadpoolWork
Creates a new work object.
Deletes the specified list of attributes for process and thread creation.
DisassociateCurrentThreadFromCallback
Removes the association between the currently executing callback function and the object that initiated the callback. The current thread will no longer count as executing a callback on behalf of the object.
Ends the calling thread.
Retrieves a pseudo handle for the calling thread.
Retrieves the thread identifier of the calling thread.
Retrieves the boundaries of the stack that was allocated by the system for the current thread.
Retrieves the termination status of the specified thread.
GetProcessIdOfThread
Retrieves the process identifier of the process associated with the specified thread.
GetThreadId
Retrieves the thread identifier of the specified thread.
Retrieves the processor number of the ideal processor for the specified thread.
Retrieves the name that was assigned to a thread using SetThreadName.
Retrieves the priority value for the specified thread. This value, together with the priority class of the thread’s process, determines the thread’s base-priority level.
Retrieves the priority boost control state of the specified thread.
Retrieves timing information for the specified thread.
InitializeProcThreadAttributeList
Initializes the specified list of attributes for process and thread creation.
IsThreadAFiber
Determines whether the current thread is a fiber.
IsThreadpoolTimerSet
Determines whether the specified timer object is currently set.
Opens an existing thread object.
Decrements a thread’s suspend count. When the suspend count is decremented to zero, the execution of the thread is resumed.
SetThreadAffinityMask
Sets a processor affinity mask for the specified thread.
SetThreadGroupAffinity
Sets the processor group affinity for the specified thread.
Sets the ideal processor for the specified thread and optionally retrieves the previous ideal processor.
Assigns a name to a thread.
Sets the priority value for the specified thread. This value, together with the priority class of the thread’s process, determines the thread’s base priority level.
Disables or enables the ability of the system to temporarily boost the priority of a thread.
SetThreadpoolAffinityMask
Sets the affinity mask for the threads in the pool.
Sets the stack reserve and commit sizes for new threads in the specified thread pool. Stack reserve and commit sizes for existing threads are not changed.
SetThreadpoolThreadMaximum
Sets the maximum number of threads that the specified thread pool can allocate to process callbacks.
SetThreadpoolThreadMinimum
Sets the minimum number of threads that the specified thread pool must make available to process callbacks.
SetThreadpoolTimer
Sets the timer object. A worker thread calls the timer object’s callback after the specified timeout expires.
SetThreadpoolWait
Sets the wait object. A worker thread calls the wait object’s callback function after the handle becomes signaled or after the specified timeout expires.
StartThreadpoolIo
Notifies the thread pool that I/O operations may possibly begin for the specified I/O completion object. A worker thread calls the I/O completion object’s callback function after the operation completes on the file handle bound to this object.
SubmitThreadpoolWork
Posts a work object to the thread pool. A worker thread calls the work object’s callback function.
Suspends the specified thread.
Causes the calling thread to yield execution to another thread that is ready to run on the current processor. The operating system selects the next thread to be executed.
TrySubmitThreadpoolCallback
Requests that a thread pool worker thread call the specified callback function.
Updates the specified attribute in a list of attributes for process and thread creation.
WaitForThreadpoolIoCallbacks
Waits for outstanding I/O completion callbacks to complete and optionally cancels pending callbacks that have not yet started to execute.
WaitForThreadpoolTimerCallbacks
Waits for outstanding timer callbacks to complete and optionally cancels pending callbacks that have not yet started to execute.
WaitForThreadpoolWaitCallbacks
Waits for outstanding wait callbacks to complete and optionally cancels pending callbacks that have not yet started to execute.
WaitForThreadpoolWorkCallbacks
Waits for outstanding work callbacks to complete and optionally cancels pending callbacks that have not yet started to execute.