get_chapter_info ( : : Chapter : Info )

Get information concerning the chapters on procedures.

The operator get_chapter_info gives information concerning the chapters on procedures. If instead of Chapter the empty string is transmitted, the routine will provide in Info 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 procedures will be given. The organization of the chapters on procedures is the same as the organization of chapters and subchapters in the HALCON-manual. Please note: The chapters on procedures respectively the subchapters concerning an individual procedure can be called by using the operator get_operator_info(::<Name>,'chapter',Info:). The Online-texts will be taken from the files english.hlp, english.sta, english.num and english.idx, which will be searched by HALCON in the currently used directory or the directory 'help_dir' (see also get_system and set_system).


Parameters

Chapter (input_control)
string(-array) -> string
Procedure class or subclass of interest.
Default value: ''

Info (output_control)
string-array -> string
Procedure classes (Chapter = '') or procedure subclasses respectively procedures.


Result

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


Parallelization Information

get_chapter_info is processed completely exclusively without parallelization.


Possible Predecessors

get_system, set_system


See also

get_operator_info, get_system, set_system


Module

Image / region / XLD management



Copyright © 1996-2005 MVTec Software GmbH