Operator Reference

HALCON Operator Reference / System / Information
ClassesClasses | | Operators

search_operatorT_search_operatorSearchOperatorSearchOperatorsearch_operator (Operator)

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

Signature

search_operator( : : Keyword : OperatorNames)

Herror T_search_operator(const Htuple Keyword, Htuple* OperatorNames)

void SearchOperator(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 void HOperatorSet.SearchOperator(HTuple keyword, out HTuple operatorNames)

static HTuple HInfo.SearchOperator(string keyword)

def search_operator(keyword: str) -> Sequence[str]

Description

The operator search_operatorsearch_operatorSearchOperatorSearchOperatorsearch_operator returns the names of all operators whose online-texts include the keyword KeywordKeywordKeywordkeywordkeyword (see also get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info). All available keywords are called by using the operator get_keywords(::”: <keywords>)get_keywords("", <keywords>)GetKeywords("", <keywords>)GetKeywords("", <keywords>)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_systemget_systemGetSystemGetSystemget_system and get_systemget_systemGetSystemGetSystemget_system).

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

KeywordKeywordKeywordkeywordkeyword (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Keyword for which corresponding operators are searched.

Default: 'Information' "Information" "Information" "Information" "Information"

OperatorNamesOperatorNamesOperatorNamesoperatorNamesoperator_names (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Operators whose slot 'keyword' contains the keyword.

Result

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

Possible Predecessors

get_keywordsget_keywordsGetKeywordsGetKeywordsget_keywords

See also

get_keywordsget_keywordsGetKeywordsGetKeywordsget_keywords, get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info, get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info

Module

Foundation

ClassesClasses | | Operators