Skip to content

search_operatorSearchOperatorSearchOperatorsearch_operatorT_search_operator🔗

Short description🔗

search_operatorSearchOperatorSearchOperatorsearch_operatorT_search_operator — Search names of all operators assigned to one keyword.

Signature🔗

search_operator( string Keyword, out string OperatorNames )void SearchOperator( const HTuple& Keyword, HTuple* OperatorNames )static void HOperatorSet.SearchOperator( HTuple keyword, out HTuple operatorNames )def search_operator( keyword: str ) -> Sequence[str]

Herror T_search_operator( const Htuple Keyword, Htuple* OperatorNames )

static HTuple HInfo::SearchOperator( const HString& Keyword )

static HTuple HInfo::SearchOperator( const char* Keyword )

static HTuple HInfo::SearchOperator( const wchar_t* Keyword ) (Windows only)

static HTuple HInfo.SearchOperator( string keyword )

Description🔗

The operator search_operatorSearchOperator returns the names of all operators whose online-texts include the keyword Keywordkeywordkeyword (see also get_operator_infoGetOperatorInfo). All available keywords are called by using the operator get_keywords(::'': <keywords>). The online-texts are taken from the files operators_[LANG].ref, operators_[LANG].sta, operators_[LANG].key, operators_[LANG].num and operators_[LANG].idx, which are searched by HALCON in the currently used directory or the directory ‘help_dir’ (see also get_systemGetSystem and get_systemGetSystem).

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.

Parameters🔗

Keywordkeywordkeyword (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Keyword for which corresponding operators are searched.

Default: 'Information'"Information"

OperatorNamesoperatorNamesoperator_names (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Operators whose slot ‘keyword’ contains the keyword.

Result🔗

The operator search_operatorSearchOperator returns the value 2 (H_MSG_TRUE) if the parameters are correct and the helpfiles are available. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

get_keywordsGetKeywords

See also

get_keywordsGetKeywords, get_operator_infoGetOperatorInfo, get_param_infoGetParamInfo

Module🔗

Foundation