•  Back 
  •  Application Services Library 
  •  Index 
  •  Tree View 
  •  Cross references 
  •  %About 
  •  Show info about hypertext 
  •  View a new file 
Topic       : The ATARI Compendium
Author      : Scott Sanders / JAY Software
Version     : 1.25 (20/6/2003)
Subject     : Documentation
Nodes       : 1117
Index Size  : 32614
HCP-Version : 6
Compiled on : Atari
@charset    : UTF-8
@lang       : en
@default    : 
@help       : %About
@options    : +g -i -t4 +y +z
@width      : 100
View Ref-Fileappl_init()
Application Services Library
appl_getinfo()                                                          AES

Syntax

WORD appl_getinfo(ap_gtype, ap_gout1, ap_gout2, ap_gout3, ap_gout4 )
WORD ap_gtype;
WORD *ap_gout1, *ap_gout2, *ap_gout3, *ap_gout4;

Function       appl_getinfo() returns information about the AES.

Opcode         130 (0x82)

Availability   Available as of AES version 4.00.

Parameters     ap_gtype specifies the type of information to be returned
               in the shorts pointed to by ap_gout1, ap_gout2, ap_gout3,
               and ap_gout4 as follows:

               Name         Value  Returns

               AES_LARGEFONT  0    AES Large Font Information
                                   ap_gout1 is filled in with the AES
                                      font's point size.
                                   ap_gout2 is filled in with the font
                                      id.
                                   ap_gout3 is a code indicating the type
                                      of font:

                                       SYSTEM_FONT (0) is the system font
                                      OUTLINE_FONT (1) is an outline font

                                   ap_gout4 is unused.

               AES_SMALLFONT  1    AES Large Font Information
                                   Same as above for the current small
                                   font.

               AES_SYSTEM     2    AES System Specifics
                                   ap_gout1 is filled in with the
                                      resolution number (as would
                                      be returned by Getrez()).
                                   ap_gout2 is filled in with the number
                                      of colors supported by the
                                      AES object library.
                                   ap_gout3 is 0 if color icons are not
                                      supported or 1 if they are.
                                   ap_gout4 is 0 to indicate that the
                                      extended resource file format
                                      is not supported or 1 if it is.

               AES_LANGUAGE   3    AES Globalization
                                   ap_gout1 is filled in with the current
                                      AES language code as follows:

                                      Name          ap_gout1  Language
                                      AESLANG_ENGLISH  0      English
                                      AESLANG_GERMAN   1      German
                                      AESLANG_FRENCH   2      French
                                      -                3      (Reserved)
                                      AESLANG_SPANISH  4      Spanish
                                      AESLANG_ITALIAN  5      Italian
                                      AESLANG_SWEDISH  6      Swedish

                                   ap_gout2, ap_gout3, and ap_gout4
                                      are unused.

               AES_PROCESS    4    AES Multiple Process Support
                                   ap_gout1 is 0 to indicate the use of
                                      non-pre-emptive multitasking and 1 to
                                      indicate the use of pre-emptive
                                      multitasking.
                                   ap_gout2 is 0 if appl_find() cannot
                                      convert between MiNT and AES id's and
                                      1 to indicate that it can.
                                   ap_gout3 is 0 if appl_search() is not
                                      implemented and 1 if it is.
                                   ap_gout4 is 0 if rsrc_rcfix() is not
                                      implemented and 1 if it is.

               AES_PCGEM      5    AES PC-GEM Features
                                   ap_gout1 is 0 if objc_xfind() is not
                                      implemented and 1 if it is.
                                   ap_gout2 is currently reserved.
                                   ap_gout3 is 0 if menu_click() is not
                                      implemented and 1 if it is.
                                   ap_gout4 is 0 if shel_rdef() and
                                      shel_wdef() are not implemented and
                                      1 if they are.

               AES_INQUIRE    6    AES Extended Inquiry Functions
                                   ap_gout1 is 0 if -1 is not a valid
                                      ap_id parameter to appl_read() or 1
                                      if it is.
                                   ap_gout2 is 0 if -1 is not a valid
                                      length parameter to shel_get() or 1
                                      if it is.
                                   ap_gout3 is 0 if -1 is not a valid
                                      mode parameter to menu_bar() or 1
                                      if it is.
                                   ap_gout4 is 0 if MENU_INSTL is not
                                      a valid mode parameter to menu_bar()
                                      or 1 if it is.

               -              7    Currently reserved.

               AES_MOUSE      8    AES Mouse Support
                                   ap_gout1 is 0 to indicate that mode
                                      parameters of 258-260 are not
                                      supported by graf_mouse() and 1
                                      if they are.
                                   ap_gout2 is 0 to indicate that the
                                      application has control over the
                                      mouse form and 1 to indicate that
                                      the mouse form is maintained by
                                      the AES on a per-application basis.
                                   ap_gout3 and ap_gout4 are currently
                                      unused.

               AES_MENU       9    AES Menu Support
                                   ap_gout1 is 0 to indicate that
                                      sub-menus are not supported and 1
                                      if MultiTOS style sub-menus are.
                                   ap_gout2 is 0 to indicate that popup
                                      menus are not supported and 1 if
                                      MultiTOS style popup menus are.
                                   ap_gout3 is 0 to indicate that
                                      scrollable menus are not supported
                                      and 1 if MultiTOS style scrollable
                                      menus are.
                                   ap_gout4 is 0 to indicate that the
                                      MN_SELECTED message does not contain
                                      object tree information in msg[57]
                                      and 1 to indicate that it does.

               AES_SHELL      10   AES Shell Support
                                   ap_gout1 & 0x00FF indicates the
                                      highest legal value for the
                                      mode parameter of shel_write().
                                   ap_gout1 & 0xFF00 indicate which
                                      extended shel_write() mode bits
                                      are supported.
                                   ap_gout2 is 0 if shel_write() with
                                      a mode parameter of 0 launches
                                      an application or 1 if it cancels
                                      the previous shel_write().
                                   ap_gout3 is 0 if shel_write() with
                                      a mode parameter of 1 launches an
                                      application immediately or 1 if
                                      it takes effect when the current
                                      application exits.
                                   ap_gout4 is 0 if ARGV style parameter
                                      passing is not supported or
                                      1 if it is.

               AES_WINDOW     11   AES Window Features
                                   ap_gout1 is a bitmap of extended modes
                                      supported by wind_get() and
                                      wind_set() (if a bit is set, it is
                                      supported) as follows:
                                      Bit  mode
                                       0   WF_TOP returns window below the
                                           top also.
                                       1   wind_get( WF_NEWDESK, ... )
                                           supported.
                                       2   WF_COLOR get/set.
                                       3   WF_DCOLOR get/set.
                                       4   WF_OWNER get/set.
                                       5   WF_BEVENT get/set.
                                       6   WF_BOTTOM set.
                                       7   WF_ICONIFY set.
                                       8   WF_UNICONIFY set.
                                      9-15 Unused

                                   ap_gout2 is current unused.
                                   ap_gout3 is a bitmap of supported
                                      window behaviors (if a bit is set,
                                      it is supported) as follows:

                                      Bit   Behaviour
                                       0    Iconifier gadget present.
                                       1    Bottomer gadget present.
                                       2    shift-click sends window
                                            to bottom.
                                       3    "hot" close box supported.
                                      4-15  Unused

                                   ap_gout4 is currently unused.

               AES_MESSAGE    12   AES Extended Messages
                                   ap_gout1 is a bitmap of extra messages
                                      supported (if a bit is set, it is
                                      supported) as follows:
                                      Bit Message
                                       0  WM_NEWTOP is meaningful.
                                       1  WM_UNTOPPED is sent.
                                       2  WM_ONTOP is sent.
                                       3  AP_TERM is sent.
                                       4  Shutdown and resolution
                                          change messages.
                                       5  CH_EXIT is sent.
                                       6  WM_BOTTOMED is sent.
                                       7  WM_ICONIFY is sent.
                                       8  WM_UNICONIFY is sent.
                                       9  WM_ALLICONIFY is sent.
                                    10-15 Unused

                                   ap_gout2 is a bitmap of extra messages
                                      supported. Current all bits are
                                      unused.
                                   ap_gout3 is a bitmap indicating
                                      message behaviour (if a bit is set,
                                      the behaviour exists) as follows:
                                      Bit Message
                                       0  WM_ICONIFY message gives
                                          coordinates.
                                     1-15 Unused

                                   ap_gout4 is currently unused.

               AES_OBJECT     13   AES Extended Objects
                                   ap_gout1 is 0 if 3D objects are not
                                      supported or 1 if they are.
                                   ap_gout2 is 0 if objc_sysvar() is not
                                      present, 1 if MultiTOS v1.01
                                      objc_sysvar() is present, or 2
                                      if extended objc_sysvar()
                                      is present.
                                   ap_gout3 is 0 if the system font is
                                      the only font supported or 1 if
                                      GDOS fonts are also supported.
                                   ap_gout4 is reserved for OS
                                      extensions.

               AES_FORM       14   AES Form Support
                                   ap_gout1 is 0 if 'flying dialogs' are
                                      not supported or 1 if they are.
                                   ap_gout2 is 0 if keyboard tables are
                                      not supported or 1 if Mag!X style
                                      keyboard tables are supported.
                                   ap_gout3 is 0 if the last cursor
                                      position from objc_edit() is not
                                      returned or 1 if it is.
                                   ap_gout4 is currently reserved.

Binding        intin[0] = ap_gtype;

               crys_if(0x82);

               *ap_gout1 = intout[1];
               *ap_gout2 = intout[2];
               *ap_gout3 = intout[3];
               *ap_gout4 = intout[4];

               return intout[0];

Return Value   appl_getinfo() returns 0 if an error occurred or non-zero
               otherwise.

Version Notes  Using an ap_gtype value of 4 and above is only supported as
               of AES version 4.1.

Comments       Many of the ap_gtype return values identify features of TOS
               not supported by Atari but for the benefit of third-party
               vendors. You should contact the appropriate third-party for
               documentation on these functions.

See Also       appl_init()

Group          Application Services Library