Operator Reference

HALCON Operator Reference / System / Information
ClassesClasses | | Operators

get_chapter_infoT_get_chapter_infoGetChapterInfoGetChapterInfoget_chapter_info (Operator)

get_chapter_infoT_get_chapter_infoGetChapterInfoGetChapterInfoget_chapter_info — Get information concerning the chapters on operators.

Signature

get_chapter_info( : : Chapter : Info)

Herror T_get_chapter_info(const Htuple Chapter, Htuple* Info)

void GetChapterInfo(const HTuple& Chapter, HTuple* Info)

static HTuple HInfo::GetChapterInfo(const HTuple& Chapter)

static HTuple HInfo::GetChapterInfo(const HString& Chapter)

static HTuple HInfo::GetChapterInfo(const char* Chapter)

static HTuple HInfo::GetChapterInfo(const wchar_t* Chapter)   ( Windows only)

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

static HTuple HInfo.GetChapterInfo(HTuple chapter)

static HTuple HInfo.GetChapterInfo(string chapter)

def get_chapter_info(chapter: MaybeSequence[str]) -> Sequence[str]

Description

The operator get_chapter_infoget_chapter_infoGetChapterInfoGetChapterInfoget_chapter_info 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)get_operator_info(<Name>,"chapter",Info). 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 will be searched by HALCON in the currently used directory or the directory 'help_dir' (see also get_systemget_systemGetSystemGetSystemget_system and set_systemset_systemSetSystemSetSystemset_system).

Attention

The encoding of the result is UTF-8.

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) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Operator class or subclass of interest.

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

InfoInfoInfoinfoinfo (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (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_infoGetChapterInfoGetChapterInfoget_chapter_info returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

get_systemget_systemGetSystemGetSystemget_system, set_systemset_systemSetSystemSetSystemset_system

See also

get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoget_operator_info, get_systemget_systemGetSystemGetSystemget_system, set_systemset_systemSetSystemSetSystemset_system

Module

Foundation

ClassesClasses | | Operators