get_keywordsT_get_keywordsGetKeywordsGetKeywordsget_keywords (Operator)
Name
get_keywordsT_get_keywordsGetKeywordsGetKeywordsget_keywords — Get keywords which are assigned to operators.
Signature
Description
The operator get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywordsget_keywords returns all the keywords in
the online-texts corresponding to those operators which have the indicated
substring OperatorNameOperatorNameOperatorNameOperatorNameoperatorNameoperator_name in their name. If instead of OperatorNameOperatorNameOperatorNameOperatorNameoperatorNameoperator_name
the empty string is transmitted, the operator get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywordsget_keywords
returns all keywords.
The keywords of an individual operator can also be called by using the
operator get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info.
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_systemGetSystemGetSystemGetSystemget_system and
set_systemset_systemSetSystemSetSystemSetSystemset_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
OperatorNameOperatorNameOperatorNameOperatorNameoperatorNameoperator_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"
"get_keywords"
KeywordsKeywordsKeywordsKeywordskeywordskeywords (output_control) string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Keywords for the operators.
Result
The operator get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywordsget_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_infoGetChapterInfoGetChapterInfoGetChapterInfoget_chapter_info
Alternatives
get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info
See also
get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorNameget_operator_name,
search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperatorsearch_operator,
get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info
Module
Foundation