XApuGetResultCount

Returns the number of XApuResult in the results queue.

Syntax

uint32_t XApuGetResultCount(  
         XApuHandle handle,  
         uint32_t* totalResultCount  
)  

Parameters

handle _In_
Type: XApuHandle Handle returned by calling XApuConnect. totalResultCount _Out_opt_
Type: uint32_t* Number of XApuResult structures in the output/results queue of the XAPU.

Return value

Type: uint32_t If there is no command submitted or there is no XApuResult ready, the output will be zero, otherwise the return value will be greater than zero. If the return value is greater than zero, the caller must call XApuDequeueResult for each XApuResult contained in the results queue.

Remarks

This method will take a pointer to uint32_t to return the totalResultCount for the current session. This number represents the total results that have been processed since the session started and after XApuConnect was called. This number will be one when the first XApuDequeueResult and it will keep increasing as more commands get processed and the results become available for consumption. This number will not go back to zero.

Requirements

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

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

Additional pages

Reference

Syntax

Parameters

Return value

Remarks

Requirements

See also

​Syntax

​Parameters

​Return value

​Remarks

​Requirements

​See also

Syntax

Parameters

Return value

Remarks

Requirements

See also