proc_info ( : : ProcName, Slot : Information )

Information concerning a HORUS-procedure.

With the help of the operator proc_info the online-texts concerning a certain procedure can be called (see also proc_name). The form of information available for all procedures (Slot) can be called using the operator query_proc_info. For the time being the following slots are available: 'short' Short description of the procedure. 'abstract' Description of the procedure. 'procedure_class' Name(s) of the chapter(s) in the procedure hierarchy (chapter, subchapter in the HORUS manual). 'functionality' Functionality is equivalent to the object class to which the procedure can be assigned. 'keywords' Keywords of the procedure (optional). 'example' Example for the use of the procedure (optional). The operator 'example.LANGUAGE' (LANGUAGE={c,c++,smalltalk,trias}) calls examples for a certain language if available. If the language is not indicated or if no example is available in this language, the TRIAS-example will be returned. 'complexity' Mathematical complexity of the procedure (optional). 'effect' Not in use so far. 'alternatives' Alternative procedures (optional). 'see_also' Procedures containing further information (optional). 'predecessor' Possible and sensible predecessor 'successor' Possible and sensible successor 'result_state' Return values of the procedure (TRUE, FALSE, FAIL, VOID or EXCEPTION). 'attention' Restrictions and advice concering the correct use of the procedure (optional). 'parameter' Names of the parameters of the procedure (see also param_info). 'references' Literary references (optional). The texts will be taken from the files english.hlp, english.sta, english.key, english.num und english.idx which will be searched by HORUS in the currently used directory or in the directory 'help_dir' (respectively 'user_help_dir') (see also get_system and set_system). By adding '.latex' after the slotname, the text of slots containing textual information can be made available in notation.


Parameters

ProcName (input_control)
string -> string
Name of the procedure on which more information is needed.
Default value: 'proc_info'

Slot (input_control)
string -> string
Desired information.
Default value: 'abstract'
List of values: 'short', 'abstract', 'procedure_class', 'functionality', 'effect', 'complexity', 'predecessor', 'successor', 'alternatives', 'see_also', 'keywords', 'example', 'attention', 'result_state', 'return_value', 'references', 'sourcefiles', 'deffile'

Information (output_control)
string-array -> string
Information (empty if no information is available)


Result

The operator proc_info returns the value TRUE if the parameters are correct and the helpfiles are availabe. Otherwise an exception is raised.


Possible Predecessors

search_keyword, search_proc, proc_name, query_proc_info, query_param_info, param_info


Possible Successors

proc_info1, proc_info2, proc_info3


Alternatives

proc_info1


See also

query_proc_info, param_info, proc_name, proc_info2, proc_info3



Copyright © 1996-1997 MVTec Software GmbH