XGameUiShowTextEntryResultSize

Article
06/22/2023

Gets the size of the return buffer from a XGameUiShowTextEntryAsync call.

Syntax

HRESULT XGameUiShowTextEntryResultSize(  
         XAsyncBlock* async,  
         uint32_t* resultTextBufferSize  
)

Parameters

async _In_
Type: XAsyncBlock*

A pointer to the XAsyncBlock that was passed to XGameUiShowTextEntryAsync.

resultTextBufferSize _Out_
Type: uint32_t*

The size of the result text buffer.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

Typically this function is to be called in XGameUiShowTextEntryAsync's XAsyncBlock. This function allows you to retrieve the size of the text input from a text entry field that was originally called for by XGameUiShowTextEntryAsync. To retrieve the text entry result you will need to call XGameUiShowTextEntryResult.
You may also call this function anytime after the async function completes in order to retrieve the function result.

Requirements

Header: XGameUI.h

Library: xgameruntime.lib

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

Share via