Skip to main content

XApuDequeueResult

Retrieves an XApuResult from the results queue, if available.

Syntax

Parameters

handle   _In_
Type: XApuHandle
Handle returned by calling XApuConnect. commandResult   _Out_
Type: XApuResult*
Result returned from the XAPU.

Return value

Type: HRESULT Returns S_OK if successful; otherwise, returns an error code.

Remarks

Retrieves an XApuResult from the results queue if available, otherwise the call will XAPU_E_PENDING_RESULTS. This call will return quickly as there is very little processing done under the hood. This call is thread safe, however there is no performance advantage to call it from more than one thread. If the hardware server is in a bad state, XApuEnqueueCommand will return XAPU_E_DEVICE_FATAL_ERROR error code. In this case all XAPU clients should be disconnected and reconnected again. If this method fails, a descriptive error code will be returned.

Requirements

Header: xapu.h Library: xapu.lib Supported platforms: XBOX Series X|S

See also

XAPU
XApuEnqueueCommand
XApuGetResultCount
Last modified on August 20, 2026