HALCON Reference Manual 10.0.2
Table of Contents / System / Information ClassesClassesClasses | | | Operators

get_chapter_infoT_get_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfo (Operator)

Name

get_chapter_infoT_get_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfo — Get information concerning the chapters on operators.

Signature

get_chapter_info( : : Chapter : Info)

Herror T_get_chapter_info(const Htuple Chapter, Htuple* Info)

Herror get_chapter_info(const HTuple& Chapter, HTuple* Info)

void HOperatorSetX.GetChapterInfo(
[in] VARIANT Chapter, [out] VARIANT* Info)

VARIANT HInfoX.GetChapterInfo([in] VARIANT Chapter)

static void HOperatorSet.GetChapterInfo(HTuple chapter, out HTuple info)

static HTuple HInfo.GetChapterInfo(HTuple chapter)

static HTuple HInfo.GetChapterInfo(string chapter)

Description

The operator get_chapter_infoget_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfo 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)get_operator_info(<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_systemget_systemGetSystemGetSystem and set_systemset_systemset_systemSetSystemSetSystem).

Attention

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

Parallelization

Parameters

ChapterChapterChapterChapterchapter (input_control)  string(-array) → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

Operator class or subclass of interest.

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

InfoInfoInfoInfoinfo (output_control)  string-array → HTupleHTupleVARIANTHtuple (string) (string) (char*) (BSTR) (char*)

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_infoget_chapter_infoGetChapterInfoGetChapterInfo returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Possible Predecessors

get_systemget_systemget_systemGetSystemGetSystem, set_systemset_systemset_systemSetSystemSetSystem

See also

get_operator_infoget_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfo, get_systemget_systemget_systemGetSystemGetSystem, set_systemset_systemset_systemSetSystemSetSystem

Module

Foundation

Table of Contents / System / Information ClassesClassesClasses | | | Operators
HALCON Reference Manual 10.0.2 Copyright © 1996-2011 MVTec Software GmbH