Herror ::disp_info (
    const HTuple &ProcName,
    const HTuple &Machine,
    const HTuple &DispProgram,
    const HTuple &Extension
)

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 (<Name: >.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').


Parameters

ProcName (input_control)
proc_name -> HTuple.char *
Name of the seeked procedure.
Default value: 'read_image'

Machine (input_control)
string -> HTuple.char *
Name of the computer to which the data shall be transmitted or empty string.
Default value: ''

DispProgram (input_control)
string -> HTuple.char *
Name of the program which shall display the help text.
Default value: 'ghostview'
Suggested values: 'gs', 'ghostview'

Extension (input_control)
string -> HTuple.char *
Extension of the helpfile.
Default value: 'ps'


Result

If the parameter values are correct and the file and the program are available, the operator ::disp_info returns the value H_MSG_TRUE. Otherwise an exception handling is raised.


See also

::open_window


Module

Image / region / XLD management



Copyright © 1996-2002 MVTec Software GmbH