Skip to content

get_keywordsGetKeywordsGetKeywordsget_keywordsT_get_keywords🔗

Short description🔗

get_keywordsGetKeywordsGetKeywordsget_keywordsT_get_keywords — Get keywords which are assigned to operators.

Signature🔗

get_keywords( proc_name OperatorName, out string Keywords )void GetKeywords( const HTuple& OperatorName, HTuple* Keywords )static void HOperatorSet.GetKeywords( HTuple operatorName, out HTuple keywords )def get_keywords( operator_name: str ) -> Sequence[str]

Herror T_get_keywords( 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 HTuple HInfo.GetKeywords( string operatorName )

Description🔗

The operator get_keywordsGetKeywords returns all the keywords in the online-texts corresponding to those operators which have the indicated substring OperatorNameoperatorNameoperator_name in their name. If instead of OperatorNameoperatorNameoperator_name the empty string is transmitted, the operator get_keywordsGetKeywords returns all keywords. The keywords of an individual operator can also be called by using the operator get_operator_infoGetOperatorInfo. 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_systemGetSystem and set_systemSetSystem).

Attention🔗

The encoding of the result is UTF-8.

Execution information🔗

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🔗

OperatorNameoperatorNameoperator_name (input_control) proc_name → (string)HTuple (HString)HTuple (string)strHtuple (char*)

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

Default: 'get_keywords'"get_keywords"

Keywordskeywordskeywords (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Keywords for the operators.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

get_chapter_infoGetChapterInfo

Alternatives

get_operator_infoGetOperatorInfo

See also

get_operator_nameGetOperatorName, search_operatorSearchOperator, get_param_infoGetParamInfo

Module🔗

Foundation