get_chapter_infoT_get_chapter_infoGetChapterInfoGetChapterInfo (Operator)

Name

get_chapter_infoT_get_chapter_infoGetChapterInfoGetChapterInfo — Get information concerning the chapters on operators.

The operator get_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfoGetChapterInfo gives information concerning the chapters on operators. If instead of ChapterChapterChapterChapterchapter the empty string is transmitted, the routine will provide in InfoInfoInfoInfoinfo the names of all chapters. If on the other hand a certain chapter or a chapter and its subchapter(s) are indicated (by a tuple of names), the corresponding subchapters or - in case there are no further subchapters - the names of the corresponding operators will be given. The organization of the chapters on operators is the same as the organization of chapters and subchapters in the HALCON-manual. Please note: The chapters on operators respectively the subchapters concerning an individual operator can be called by using the operator get_operator_info(::<Name>,'chapter',Info:)get_operator_info(<Name>,"chapter",Info)GetOperatorInfo(<Name>,"chapter",Info)GetOperatorInfo(<Name>,"chapter",Info)GetOperatorInfo(<Name>,"chapter",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 will be searched by HALCON in the currently used directory or 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

ChapterChapterChapterChapterchapter (input_control) string(-array) → (string)

Operator class or subclass of interest.

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

InfoInfoInfoInfoinfo (output_control) string-array → (string)

Operator classes (ChapterChapterChapterChapterchapter = ”) or operator subclasses respectively operators.

Result

If the parameter values are correct and the helpfile is available, the operator get_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfoGetChapterInfo returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

get_systemget_systemGetSystemGetSystemGetSystem, set_systemset_systemSetSystemSetSystemSetSystem

Module

Foundation

Operators