Skip to content

get_chapter_infoGetChapterInfoGetChapterInfoget_chapter_infoT_get_chapter_info🔗

Short description🔗

get_chapter_infoGetChapterInfoGetChapterInfoget_chapter_infoT_get_chapter_info — Get information concerning the chapters on operators.

Signature🔗

get_chapter_info( string Chapter, out string Info )void GetChapterInfo( const HTuple& Chapter, HTuple* Info )static void HOperatorSet.GetChapterInfo( HTuple chapter, out HTuple info )def get_chapter_info( chapter: MaybeSequence[str] ) -> Sequence[str]

Herror T_get_chapter_info( 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 HTuple HInfo.GetChapterInfo( HTuple chapter )

static HTuple HInfo.GetChapterInfo( string chapter )

Description🔗

The operator get_chapter_infoGetChapterInfo gives information concerning the chapters on operators. If instead of Chapterchapterchapter the empty string is transmitted, the routine will provide in Infoinfoinfo 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:). 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_systemGetSystem and set_systemSetSystem).

Attention🔗

The encoding of the result is UTF-8.

Execution information🔗

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🔗

Chapterchapterchapter (input_control) string(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Operator class or subclass of interest.

Default: ''""

Infoinfoinfo (output_control) string-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Operator classes (Chapterchapterchapter = ‘’) or operator subclasses respectively operators.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

get_systemGetSystem, set_systemSetSystem

See also

get_operator_infoGetOperatorInfo, get_systemGetSystem, set_systemSetSystem

Module🔗

Foundation