Initialize User Interface Package

This Subprogram must be called before attempting to call any other UIPACK Subprograms.

Short Name Calling Sequence

         STATUS = UIINIT([MODE,INLUN,OUTLUN,
     &                  DEVICE,WRKSIZ,MAXNAM])

Long Name Calling Sequence

STATUS = UI_INITIALISE(...) STATUS = UI_INITIALIZE(...)

Input Arguments

MODE (Integer) Operation Mode (Opt.) INLUN (Integer) Input Logical Unit (Opt.) OUTLUN (Integer) Output Logical Unit (Opt.) DEVICE (Integer) Device Driver Code (Opt.) WRKSIZ (Integer) Work Area Size (Opt.) MAXNAM (Integer) Max. YBOS Bank Names(Opt.)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__ILLEGAL_DEVICE ) Illegal Device ID UIILDV )

UI__ILLEGAL_SIZE ) Illegal Work Area Size UIILSZ )

UI__ILLEGAL_MODE ) Illegal Operation Mode UIILMD ) Note:

1. All Arguments to this Subprogram are Optional.
2. The valid Operation Modes are:-

   UIPROMPTEDMODE        Prompted Mode
   UIPRMD
   
   UISCROLLMODE          Text Scroll Mode
   UISCMD
   
   UIVIEWTEXTMODE        Viewport/Text Mode
   UIVTMD
   
   UIVIEWCURSORMODE      Viewport/Cursor Mode
   UIVCMD
   
   UIGRAPHICSMODE        Graphics Mode
   UIGRMD
   

   where these Parameters are defined in an Include file described in Appendix B.
3. Operation Mode UI_SCROLL_MODE will be assumed by default if the MODE optional argument is absent or unphysical.
4. Input Logical Unit 5 will be assumed by default if the INLUN optional argument is absent or unphysical (<=0)
5. Output Logical Unit 6 will be assumed by default if the OUTLUN optional argument is absent or unphysical (<=0).
6. DI3000 Device Driver 1 will be assumed by default if the DEVICE optional argument is absent or unphysical (<=0).
7. This Subprogram performs all necessary DI3000 initialisations.
8. The defaults for DI3000 Segment Visibility, Detectability and Highlighting are set by the Subprogram to the following:-

   Segments Invisible Not Detectable Not Highlighted

   Thus the Application Programmer must explicitly set his own newly created segments to be visible before they will appear on the display surface.

9. If the Application Programmer wishes to extend the default working area he should include the following code fragment in his initialisation routine:-

         INTEGER              WRKSIZ
         PARAMETER           (WRKSIZ = n )
         COMMON/MENUCO/MENUI4(WRKSIZ)
         INTEGER       MENUI4
   

   where ``n" is set to the desired length of the work area. The default is 32768.

10. UIPACK uses the YBOS Data Management Package for its internal data structures. This uses a predetermined default for the maximum number of YBOS Bank Names that it allows. This can restrict the number of Verb Groups, Menus and Viewports below their theoretical maxima. Specifying the MAXNAM Argument allows this restriction to be overcome. See Appendix B for a more detailed discussion of this.