Operator Reference

clear_text_resultT_clear_text_resultClearTextResultClearTextResultclear_text_result (Operator)

clear_text_resultT_clear_text_resultClearTextResultClearTextResultclear_text_result — Clear a text result.

Signature

clear_text_result( : : TextResultID : )

Herror T_clear_text_result(const Htuple TextResultID)

void ClearTextResult(const HTuple& TextResultID)

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

void HTextResult::ClearTextResult() const

static void HOperatorSet.ClearTextResult(HTuple textResultID)

static void HTextResult.ClearTextResult(HTextResult[] textResultID)

void HTextResult.ClearTextResult()

def clear_text_result(text_result_id: MaybeSequence[HHandle]) -> None

Description

clear_text_resultclear_text_resultClearTextResultClearTextResultclear_text_result clears the text result in TextResultIDTextResultIDTextResultIDtextResultIDtext_result_id and frees all underlying memory.

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

TextResultIDTextResultIDTextResultIDtextResultIDtext_result_id (input_control, state is modified)  text_result(-array) HTextResult, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Text result to be cleared.

Result

clear_text_resultclear_text_resultClearTextResultClearTextResultclear_text_result returns the value 2 ( H_MSG_TRUE) .

Module

Foundation