HALCON Website / HALCON Operator Reference / System / Information
ClassesClasses | | Operators

search_operatorT_search_operatorSearchOperatorSearchOperator (Operator)

Name

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

static HTuple HInfo.SearchOperator(string keyword)

Description

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

Execution Information

Parameters

KeywordKeywordKeywordKeywordkeyword (input_control)  string → HTupleHTupleHtuple (string) (string) (HString) (char*)

Keyword for which corresponding operators are searched.

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

OperatorNamesOperatorNamesOperatorNamesOperatorNamesoperatorNames (output_control)  string-array → HTupleHTupleHtuple (string) (string) (HString) (char*)

Operators whose slot 'keyword' contains the keyword.

Result

The operator search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperator 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_keywordsGetKeywordsGetKeywordsGetKeywords

See also

get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywords, get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo, get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfo

Module

Foundation

ClassesClasses | | Operators
HALCON Operator Reference 17.12 Copyright © 1996-2017 MVTec Software GmbH