Operator Reference

HALCON Operator Reference / System / Information
ClassesClasses | | Operators

get_keywordsT_get_keywordsGetKeywordsGetKeywordsget_keywords (Operator)

get_keywordsT_get_keywordsGetKeywordsGetKeywordsget_keywords — Get keywords which are assigned to operators.

Signature

get_keywords( : : OperatorName : Keywords)

Herror T_get_keywords(const Htuple OperatorName, Htuple* Keywords)

void GetKeywords(const HTuple& OperatorName, HTuple* Keywords)

static HTuple HInfo::GetKeywords(const HString& OperatorName)

static HTuple HInfo::GetKeywords(const char* OperatorName)

static HTuple HInfo::GetKeywords(const wchar_t* OperatorName)   ( Windows only)

static void HOperatorSet.GetKeywords(HTuple operatorName, out HTuple keywords)

static HTuple HInfo.GetKeywords(string operatorName)

def get_keywords(operator_name: str) -> Sequence[str]

Description

The operator get_keywordsget_keywordsGetKeywordsGetKeywordsget_keywords returns all the keywords in the online-texts corresponding to those operators which have the indicated substring OperatorNameOperatorNameOperatorNameoperatorNameoperator_name in their name. If instead of OperatorNameOperatorNameOperatorNameoperatorNameoperator_name the empty string is transmitted, the operator get_keywordsget_keywordsGetKeywordsGetKeywordsget_keywords returns all keywords. The keywords of an individual operator can also be called by using the operator get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info. The online-texts will be 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 and in the directory 'help_dir' (see also get_systemget_systemGetSystemGetSystemget_system and set_systemset_systemSetSystemSetSystemset_system).

Attention

The encoding of the result is UTF-8.

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

OperatorNameOperatorNameOperatorNameoperatorNameoperator_name (input_control)  proc_name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Substring in the names of those operators for which keywords are needed.

Default: 'get_keywords' "get_keywords" "get_keywords" "get_keywords" "get_keywords"

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

Keywords for the operators.

Result

The operator get_keywordsget_keywordsGetKeywordsGetKeywordsget_keywords 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_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfoget_chapter_info

Alternatives

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info

See also

get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameget_operator_name, search_operatorsearch_operatorSearchOperatorSearchOperatorsearch_operator, get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info

Module

Foundation

ClassesClasses | | Operators