Herror ::get_keywords (
    const HTuple &ProcName,
    HTuple *Keywords
)

Get keywords which are assigned to procedures.

The operator ::get_keywords returns all the keywords in the online-texts corresponding to those procedures which have the indicated substring ProcName in their name. If instead of ProcName the empty string is transmitted, the operator ::get_keywords returns all keywords. The keywords of an individual procedure can also be called by using the operator ::get_operator_info. The online-texts will be taken from the files english.hlp, english.sta, english.num, english.key and english.idx, which are searched by HALCON in the currently used directory and in the directory 'help_dir' (see also ::get_system and ::set_system).


Parameters

ProcName (input_control)
proc_name -> HTuple.char *
Substring in the names of those procedures for which keywords are needed.
Default value: 'get_keywords'

Keywords (output_control)
string-array -> HTuple.char *
Keywords for the procedures.


Result

The operator ::get_keywords returns the value H_MSG_TRUE if the parameters are correct and the helpfiles are available. Otherwise an exception handling is raised.


Possible Predecessors

::get_chapter_info


Alternatives

::get_operator_info


See also

::get_operator_name, ::search_operator, ::get_param_info


Module

Image / region / XLD management



Copyright © 1996-2002 MVTec Software GmbH