Skip to content

clear_text_resultClearTextResultClearTextResultclear_text_resultT_clear_text_result🔗

Short description🔗

clear_text_resultClearTextResultClearTextResultclear_text_resultT_clear_text_result — Clear a text result.

Signature🔗

clear_text_result( text_result TextResultID )void ClearTextResult( const HTuple& TextResultID )static void HOperatorSet.ClearTextResult( HTuple textResultID )def clear_text_result( text_result_id: MaybeSequence[HHandle] ) -> None

Herror T_clear_text_result( const Htuple TextResultID )

static void HTextResult::ClearTextResult( const HTextResultArray& TextResultID )

void HTextResult::ClearTextResult( ) const

static void HTextResult.ClearTextResult( HTextResult[] textResultID )

void HTextResult.ClearTextResult( )

Description🔗

clear_text_resultClearTextResult clears the text result in TextResultIDtextResultIDtext_result_id and frees all underlying memory.

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

TextResultIDtextResultIDtext_result_id (input_control, state is modified) text_result(-array) → (handle)HTuple (HHandle)HTextResult, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Text result to be cleared.

Result🔗

clear_text_resultClearTextResult returns the value 2 (H_MSG_TRUE).

Module🔗

Foundation