Display the manual information of a procedure on the screen.
The operator disp_info together with the previewer DispProgram shows the manual entry of the indicated procedure on the screen. The individual files (ProcName.Extension) are located in the HALCON-Directory "doc/ps/reference/LANGUAGE/*", whereby the value for LANGUAGE will be determined by the currently used host language. The directory can also be generated with the help of the operator set_system(::'reference_dir','Pfad':).
|
ProcName (input_control) |
proc_name -> string |
| Name of the seeked procedure. | |
| Default value: 'read_image' | |
|
Machine (input_control) |
string -> string |
| Name of the computer to which the data shall be transmitted or empty string. | |
| Default value: '' | |
|
DispProgram (input_control) |
string -> string |
| Name of the program which shall display the help text. | |
| Default value: 'ghostview' | |
| Suggested values: 'gs', 'ghostview' | |
|
Extension (input_control) |
string -> string |
| Extension of the helpfile. | |
| Default value: 'ps' | |
If the parameter values are correct and the file and the program are available, the operator disp_info returns the value 2 (H_MSG_TRUE). Otherwise an exception handling is raised.
disp_info is reentrant and processed without parallelization.
Image / region / XLD management
