get_keywordsT_get_keywordsGetKeywordsGetKeywords (Operator)

Name

get_keywordsT_get_keywordsGetKeywordsGetKeywords — Get keywords which are assigned to operators.

Signature

get_keywords( : : OperatorName : Keywords)

The operator get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywords returns all the keywords in the online-texts corresponding to those operators which have the indicated substring OperatorNameOperatorNameOperatorNameOperatorNameoperatorName in their name. If instead of OperatorNameOperatorNameOperatorNameOperatorNameoperatorName the empty string is transmitted, the operator get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywords returns all keywords. The keywords of an individual operator can also be called by using the operator get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo. The online-texts will be taken from the files operators_[LANG].ref, operators_[LANG].sta, operators_[LANG].num, operators_[LANG].key and operators_[LANG].idx, which are searched by HALCON in the currently used directory and in the directory 'help_dir' (see also get_systemget_systemGetSystemGetSystemGetSystem and set_systemset_systemSetSystemSetSystemSetSystem).

Attention

The encoding of the result is ISO 8859-1 for English and German, and UTF-8 for Japanese.

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

OperatorNameOperatorNameOperatorNameOperatorNameoperatorName (input_control) proc_name → (string)

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

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

KeywordsKeywordsKeywordsKeywordskeywords (output_control) string-array → (string)

Keywords for the operators.

Result

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