XAsyncWork

Represents the callback function invoked by XAsyncRun.

Syntax

HRESULT XAsyncWork(  
         XAsyncBlock* asyncBlock  
)  

Parameters

asyncBlock   _Inout_
Type: XAsyncBlock*

A pointer to a copy of the XAsyncBlock that was passed to XAsyncRun.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an error code. For a list of error codes, see Error Codes.

Remarks

A pointer to a copy of the XAsyncBlock that was passed to XAsyncRun is used to allow the system to ensure that the pointer always exists and is valid for the callback.

When using the XAsyncRun helper function to asynchronously run a callback function, you specify an XAsyncWork pointer for the callback function to be invoked. XAsyncRun then uses XAsyncProvider functionality to run the callback function.

For more information about XAsyncProvider functionality, see Asynchronous Programming Model.

Requirements

Header: XAsync.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

XAsync Members
XAsyncRun
Asynchronous Programming Model