next up previous contents
Up: Definition File Subprograms Previous: Definition File Subprograms

Define Verbs and Menus etc

This Subprogram creates all Verbs, Qualifiers and Menus as defined within the specified Definition File.

Short Name Calling Sequence

         STATUS = UIDFFI(FILNAM[,LOWGRP,LOWMEN,LOWVPT,
     &                          HIGGRP,HIGMEN,HIGVPT])

Long name Calling Sequence

STATUS = UI_DEFINE_FILE(...)

Input Arguments

FILNAM (Character) Filename

Output Arguments

LOWGRP (Integer) Low Group ID (Optional) LOWMEN (Integer) Low Menu ID (Optional) LOWVPT (Integer) Low Viewport ID (Optional) HIGGRP (Integer) High Group ID (Optional) HIGMEN (Integer) High Menu ID (Optional) HIGVPT (Integer) High Viewport ID (Optional)

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__STACK_DEPTH ) Open File maximum Stack UISTAK ) Depth exceeded

UI__OPEN_INPUT ) Unable to open File UICIFI )

Note:

  1. On a VAX, the file type defaults to ``.UID" if it isn't explicitly specified within FILNAM, and the file defaults to ``UIPACK.UID" if FILNAM is null (all spaces).
  2. The format of the Definition File is given in the next Section.
  3. This Subprogram has several optional arguments which may be used to determine the range of Verb Group IDs, Menu IDs and Viewport IDs that were defined by the Definition File. This is particularly useful in the case where self-relative definitions of Verb Groups, Menus and Viewports are used (see next Section) since these Arguments allow the actual Group, Menu and Viewport IDs to be determined.
  4. If Verbs and Menu Buttons are defined within a Definition File, the Verb Group or Menu to which they belong must be explicitly specified within the body of the file via the appropriate Command Line.
  5. UIPACK utilises the next available Logical Unit Number from its pool used to access Indirect Command Files in order to access the specified file. This means that the Subprogram should not be called during the scanning of an Indirect Command File if the nesting of such files exceeds 3. Error UI__STACK_DEPTH will result if this is attempted and the request will be ignored.
  6. Errors in the File Format will give rise to error messages and the line in error will be ignored. Processing of the file will continue, however, until either the end-of-file is encountered, or an ``END_FILE" command line is encountered (see next Section).
  7. There is no limit to the number of Definition Files that may be read in a single program.



next up previous contents
Up: Definition File Subprograms Previous: Definition File Subprograms



Liz Buckle
Fri Jan 13 17:29:41 CST 1995