ClassesClassesClassesClasses | | | | Operators

get_keywordsT_get_keywordsGetKeywordsget_keywordsGetKeywordsGetKeywords (Operator)

Name

get_keywordsT_get_keywordsGetKeywordsget_keywordsGetKeywordsGetKeywords — Get keywords which are assigned to operators.

Signature

get_keywords( : : OperatorName : Keywords)

Herror T_get_keywords(const Htuple OperatorName, Htuple* Keywords)

Herror 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)

void HOperatorSetX.GetKeywords(
[in] VARIANT OperatorName, [out] VARIANT* Keywords)

VARIANT HInfoX.GetKeywords([in] BSTR OperatorName)

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

static HTuple HInfo.GetKeywords(string operatorName)

Description

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

Attention

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

Parallelization

Parameters

OperatorNameOperatorNameOperatorNameOperatorNameOperatorNameoperatorName (input_control)  proc_name HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

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

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

KeywordsKeywordsKeywordsKeywordsKeywordskeywords (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Keywords for the operators.

Result

The operator get_keywordsget_keywordsGetKeywordsget_keywordsGetKeywordsGetKeywords 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_infoGetChapterInfoget_chapter_infoGetChapterInfoGetChapterInfo

Alternatives

get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo

See also

get_operator_nameget_operator_nameGetOperatorNameget_operator_nameGetOperatorNameGetOperatorName, search_operatorsearch_operatorSearchOperatorsearch_operatorSearchOperatorSearchOperator, get_param_infoget_param_infoGetParamInfoget_param_infoGetParamInfoGetParamInfo

Module

Foundation


ClassesClassesClassesClasses | | | | Operators