home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Programming / Misc / TRSICAT.LZX / CATS_CD2_TRSI / Inc&AD2.1 / Text_Autodocs / asl.doc < prev    next >
Encoding:
Text File  |  1992-09-11  |  25.1 KB  |  702 lines
  1. TABLE OF CONTENTS
  2.  
  3. asl.library/AllocAslRequest
  4. asl.library/AllocFileRequest
  5. asl.library/AslRequest
  6. asl.library/FreeAslRequest
  7. asl.library/FreeFileRequest
  8. asl.library/RequestFile
  9. asl.library/AllocAslRequest                       asl.library/AllocAslRequest
  10.  
  11.    NAME
  12.     AllocAslRequest -- allocate an ASL requester. (V36)
  13.     AllocAslRequestTags -- varargs stub for AllocAslRequest(). (V36)
  14.  
  15.    SYNOPSIS
  16.     requester = AllocAslRequest(reqType,tagList);
  17.     D0                          D0      A0
  18.  
  19.     APTR AllocAslRequest(ULONG,struct TagItem *);
  20.  
  21.     requester = AllocAslRequestTags(reqType,firstTag, ...);
  22.  
  23.     APTR AllocAslRequestTags(ULONG,Tag,...);
  24.  
  25.    FUNCTION
  26.     Allocates an ASL requester data structure of the specified type.
  27.  
  28.    INPUTS
  29.     type - type of requester to allocate. Currently defined types
  30.            are ASL_FileRequest, ASL_FontRequest and ASL_ScreenModeRequest.
  31.            ASL_ScreenModeRequest is available starting with asl.library
  32.            V38 only.
  33.     tags - pointer to an optional tag list specifying how to initialize the
  34.            data structure returned by this function. See the
  35.            documentation for AslRequest() for an explanation of
  36.            how to use the currently defined tags.
  37.  
  38.    RESULT
  39.     requester - an initialized requester data structure, or NULL on
  40.                 failure. The data structure returned corresponds to the
  41.             requested type;
  42.             ASL_FileRequest       -> (struct FileRequester *)
  43.             ASL_FontRequest       -> (struct FontRequester *)
  44.             ASL_ScreenModeRequest -> (struct ScreenModeRequester *)
  45.  
  46.    WARNING
  47.     All ASL requester data structures are READ-ONLY and can only be
  48.     modified by using tags!
  49.  
  50.    SEE ALSO
  51.     AslRequest(), FreeAslRequest()
  52.  
  53. asl.library/AllocFileRequest                     asl.library/AllocFileRequest
  54.  
  55.    NAME
  56.     AllocFileRequest -- allocates an ASL FileRequester structure. (V36)
  57.  
  58.    SYNOPSIS
  59.     requester = AllocFileRequest()
  60.     D0
  61.  
  62.     struct FileRequester *AllocFileRequest(VOID);
  63.  
  64.    NOTES
  65.     This function is obsolete, please use AllocAslRequest() instead.
  66.  
  67.    SEE ALSO
  68.     AllocAslRequest()
  69.  
  70. asl.library/AslRequest                                 asl.library/AslRequest
  71.  
  72.    NAME
  73.     AslRequest -- get input from user using an ASL requester. (V36)
  74.     AslRequestTags -- varargs stub for AslRequest(). (V36)
  75.  
  76.    SYNOPSIS
  77.     result = AslRequest(requester,tags);
  78.     D0                  A0        A1
  79.  
  80.     BOOL AslRequest(APTR,struct TagItem *);
  81.  
  82.     result = AslRequestTags(requester,firstTag,...);
  83.  
  84.     BOOL AslRequestTags(APTR,Tag,...);
  85.  
  86.    FUNCTION
  87.     Prompts the user for input, based on the specific type of
  88.     requester and modifying tags. The actions and results
  89.     are specific to the type of requester, but in general the action is
  90.     to open a requesting window prompting the user for a specific input.
  91.     If the user cancels or the system aborts the request, FALSE
  92.     is returned, otherwise the requester's data structure reflects the
  93.     user input.
  94.  
  95.     Note that tag values stay in effect for each use of the
  96.     requester until they are cleared or modified by passing the
  97.     same tag with a new value.
  98.  
  99.    INPUTS
  100.     requester - requester structure allocated with AllocAslRequest(). If
  101.             this parameter is NULL, this function will always return
  102.             FALSE with a dos.library/IoErr() result of
  103.             ERROR_NO_FREE_STORE.
  104.     tags - pointer to an optional tag list which may be used to
  105.            control features of the requester.
  106.  
  107.    TAGS
  108.     Tags for use with the file requester:
  109.  
  110.     ASLFR_Window (struct Window *) - Parent window of requester. If no
  111.             ASLFR_Screen tag is specified, the window structure
  112.             is used to determine on which screen to open the
  113.             requesting window. (V36)
  114.  
  115.     ASLFR_PubScreenName (STRPTR) - Name of a public screen to open on.
  116.             This overrides the screen used by ASLFR_Window. (V38)
  117.  
  118.     ASLFR_Screen (struct Screen *) - Screen on which to open the requester.
  119.             This overrides the screen used by ASLFR_Window or by
  120.             ASLFR_PubScreenName. (V38)
  121.  
  122.     ASLFR_PrivateIDCMP (BOOL) - When set to TRUE, this tells ASL to
  123.             allocate a new IDCMP port for the requesting window.
  124.             If not specified or set to FALSE, and if ASLFR_Window
  125.             is provided, the requesting window will share
  126.             ASLFR_Window's IDCMP port. (V38)
  127.  
  128.     ASLFR_IntuiMsgFunc (struct Hook *) - A function to call whenever an
  129.             unknown Intuition message arrives at the message port
  130.             being used by the requesting window. The function
  131.                        receives the following parameters:
  132.                 A0 - (struct Hook *)
  133.                 A1 - (struct IntuiMessage *)
  134.                 A2 - (struct FileRequester *)
  135.             (V38)
  136.  
  137.     ASLFR_SleepWindow (BOOL) - When set to TRUE, this tag will cause the
  138.             window specified by ASLFR_Window to be "put to
  139.             sleep". That is, a busy pointer will be displayed in
  140.             the parent window, and no gadget or menu activity will
  141.             be allowed. This is done by opening an invisible
  142.             Intuition Requester in the parent window. (V38)
  143.  
  144.     ASLFR_UserData (APTR) - A 32-bit value that is simply copied in the
  145.             fr_UserData field of the requester structure. (V38)
  146.  
  147.     ASLFR_TextAttr (struct TextAttr *) - Font to be used for the requesting
  148.             window's gadgets and menus. If this tag is not provided
  149.             or its value is NULL, the default font of the screen
  150.             on which the requesting window opens will be used.
  151.             This font must already be in memory as ASL calls
  152.             OpenFont() and not OpenDiskFont(). As of V38, the font
  153.             used in the file requester's file list must be
  154.             monospaced. If the font provided with this tag is
  155.             not monospaced, then the file list will use the current
  156.             system default font as chosen in preferences. (V38)
  157.  
  158.     ASLFR_Locale (struct Locale *) - Locale to use for the requesting
  159.             window. This determines the language used for the
  160.             requester's gadgets and menus. If this tag is not
  161.             provided or its value is NULL, the system's current
  162.             default locale will be used. As of V38, items such as
  163.             the date format always uses the system default locale.
  164.             (V38)
  165.  
  166.     ASLFR_TitleText (STRPTR) - Title to use for the requesting window.
  167.             Default is no title. (V36)
  168.  
  169.     ASLFR_PositiveText (STRPTR) - Label of the positive gadget in the
  170.             requester. English default is "OK". Prior to V38, this
  171.             string could not be longer than 6 characters. (V36)
  172.  
  173.     ASLFR_NegativeText (STRPTR) - Label of the negative gadget in the
  174.             requester. English default is "Cancel". Prior to V38,
  175.             this string could not be longer than 6 characters.
  176.             (V36)
  177.  
  178.     ASLFR_InitialLeftEdge (WORD) - Suggested left edge of requesting
  179.             window. (V36)
  180.  
  181.     ASLFR_InitialTopEdge (WORD) - Suggested top edge of requesting
  182.             window. (V36)
  183.  
  184.     ASLFR_InitialWidth (WORD) - Suggested width of requesting window. (V36)
  185.  
  186.     ASLFR_InitialHeight (WORD) - Suggested height of requesting window.
  187.             (V36)
  188.  
  189.     ASLFR_InitialFile (STRPTR) - Initial contents of the file requester's
  190.             File text gadget. Default is empty. (V36)
  191.  
  192.     ASLFR_InitialDrawer (STRPTR) - Initial contents of the file
  193.             requester's Drawer text gadget. Default is empty. (V36)
  194.  
  195.     ASLFR_InitialPattern (STRPTR) - Initial contents of the file
  196.             requester's Pattern text gadget. Default is #?. (V36)
  197.  
  198.     ASLFR_Flags1 (ULONG) - Bulk initialization of many of the requester's
  199.             options. See <libraries/asl.h> for the possible
  200.             flag values. Default is 0. (V36)
  201.  
  202.     ASLFR_Flags2 (ULONG) - Bulk initialization of many of the requester's
  203.             options. See <libraries/asl.h> for the possible
  204.             flag values. Default is 0. (V36)
  205.  
  206.     ASLFR_DoSaveMode (BOOL) - Set this tag to TRUE when the file requester
  207.             is being used for saving. Default is FALSE. (V38)
  208.  
  209.     ASLFR_DoMultiSelect (BOOL) - Set this tag to TRUE to let the user
  210.             select multiple files at once. This tag excludes
  211.             save mode. Default is FALSE. (V38)
  212.  
  213.     ASLFR_DoPatterns (BOOL) - Set this tag to TRUE to cause a pattern
  214.             gadget to be displayed. Default is FALSE. (V38)
  215.  
  216.     ASLFR_DrawersOnly (BOOL) - Set this tag to TRUE to cause the requester
  217.             to only display drawers, and have no File gadget. This
  218.             is useful to let the user choose a destination
  219.             directory. Default is FALSE. (V38)
  220.  
  221.     ASLFR_FilterFunc (struct Hook *) - A function to call for each file
  222.             encountered. If the function returns TRUE, the file is
  223.             included in the file list, otherwise it is rejected
  224.             and not displayed. The function receives the following
  225.             parameters:
  226.                 A0 - (struct Hook *)
  227.                 A1 - (struct AnchorPath *)
  228.                 A2 - (struct FileRequester *)
  229.             (V38)
  230.  
  231.     ASLFR_RejectIcons (BOOL) - Set this tag to TRUE to cause the requester
  232.             not to display Workbench icons. This flag should
  233.                 normally be set. Default is FALSE. (V38)
  234.  
  235.     ASLFR_RejectPattern (UBYTE *) - Specifies an AmigaDOS pattern that is
  236.             used to reject files. That is, any files with names
  237.             matching this pattern are not included in the file
  238.             list. Note that the pattern must have been
  239.             parsed by dos.library/ParsePatternNoCase(). Default
  240.             is ~(#?) which matches nothing. (V38)
  241.  
  242.     ASLFR_AcceptPattern (UBYTE *) - Specifies an AmigaDOS pattern that is
  243.             used to accept files. That is, only files with names
  244.             matching this pattern are included in the file list.
  245.             Note that the pattern must have been parsed by
  246.             dos.library/ParsePatternNoCase(). Default is #? which
  247.                 matches everything. (V38)
  248.  
  249.     ASLFR_FilterDrawers (BOOL) - Set this tag to TRUE if you want the
  250.             ASLFR_RejectPattern, ASLFR_AcceptPattern, and the
  251.             Pattern text gadget to also apply to drawer names.
  252.             Normally, drawers are always displayed. Default is
  253.             FALSE. (V38)
  254.  
  255.     ASLFR_HookFunc (APTR) - A function that is called if the
  256.             FRF_FILTERFUNC or FRF_INTUIFUNC flags are specified in
  257.             the ASLFR_Flags1 tag. The function will be called like
  258.             so, with the arguments on the stack using the standard
  259.                 C pushing order:
  260.  
  261.                 ULONG function(ULONG mask, APTR object,
  262.                            struct FileRequester *fr)
  263.  
  264.             The Mask value is a copy of the specific ASLFR_Flags1
  265.             value the callback is for, either FRF_FILTERFUNC or
  266.             FRF_INTUIFUNC; object is a pointer to a data object
  267.             (a (struct IntuiMessage *) for FRF_INTUIFUNC, and a
  268.             (struct AnchorPath *) for FRF_FILTERFUNC).
  269.  
  270.             For FRF_FILTERFUNC, the function should return 0 if the
  271.             file should be added to the list, non-zero if it
  272.             shouldn't. For FRF_INTUIFUNC, the function should
  273.             return the original (struct IntuiMessage *) it was
  274.             passed.
  275.  
  276.     Tags used for the font requester:
  277.  
  278.     ASLFO_Window (struct Window *) - Parent window of requester. If no
  279.             ASLFO_Screen tag is specified, the window structure
  280.             is used to determine on which screen to open the
  281.             requesting window. (V36)
  282.  
  283.     ASLFO_PubScreenName (STRPTR) - Name of a public screen to open on.
  284.             This overrides the screen used by ASLFO_Window. (V38)
  285.  
  286.     ASLFO_Screen (struct Screen *) - Screen on which to open the requester.
  287.             This overrides the screen used by ASLFO_Window or by
  288.             ASLFO_PubScreenName. (V38)
  289.  
  290.     ASLFO_PrivateIDCMP (BOOL) - When set to TRUE, this tells ASL to
  291.             allocate a new IDCMP port for the requesting window.
  292.             If not specified or set to FALSE, and if ASLFO_Window
  293.             is provided, the requesting window will share
  294.             ASLFO_Window's IDCMP port. (V38)
  295.  
  296.     ASLFO_IntuiMsgFunc (struct Hook *) - A function to call whenever an
  297.             unknown Intuition message arrives at the message port
  298.             being used by the requesting window. The function
  299.                        receives the following parameters:
  300.                 A0 - (struct Hook *)
  301.                 A1 - (struct IntuiMessage *)
  302.                 A2 - (struct FontRequester *)
  303.             (V38)
  304.  
  305.     ASLFO_SleepWindow (BOOL) - When set to TRUE, this tag will cause the
  306.             window specified by ASLFO_Window to be "put to
  307.             sleep". That is, a busy pointer will be displayed in
  308.             the parent window, and no gadget or menu activity will
  309.             be allowed. This is done by opening an invisible
  310.             Intuition Requester in the parent window. (V38)
  311.  
  312.     ASLFO_UserData (APTR) - A 32-bit value that is simply copied in the
  313.             fo_UserData field of the requester structure. (V38)
  314.  
  315.     ASLFO_TextAttr (struct TextAttr *) - Font to be used for the requesting
  316.             window's gadgets and menus. If this tag is not provided
  317.             or its value is NULL, the default font of the screen
  318.             on which the requesting window opens will be used.
  319.             This font must already be in memory as ASL calls
  320.             OpenFont() and not OpenDiskFont().
  321.             (V38)
  322.  
  323.     ASLFO_Locale (struct Locale *) - Locale to use for the requesting
  324.             window. This determines the language used for the
  325.             requester's gadgets and menus. If this tag is not
  326.             provided or its value is NULL, the system's current
  327.             default locale will be used. (V38)
  328.  
  329.     ASLFO_TitleText (STRPTR) - Title to use for the requesting window.
  330.             Default is no title. (V36)
  331.  
  332.     ASLFO_PositiveText (STRPTR) - Label of the positive gadget in the
  333.             requester. English default is "OK". Prior to V38, this
  334.             string could not be longer than 6 characters. (V36)
  335.  
  336.     ASLFO_NegativeText (STRPTR) - Label of the negative gadget in the
  337.             requester. English default is "Cancel". Prior to V38,
  338.             this string could not be longer than 6 characters.
  339.             (V36)
  340.  
  341.     ASLFO_InitialLeftEdge (WORD) - Suggested left edge of requesting
  342.             window. (V36)
  343.  
  344.     ASLFO_InitialTopEdge (WORD) - Suggested top edge of requesting
  345.             window. (V36)
  346.  
  347.     ASLFO_InitialWidth (WORD) - Suggested width of requesting window. (V38)
  348.  
  349.     ASLFO_InitialHeight (WORD) - Suggested height of requesting window.
  350.             (V38)
  351.  
  352.     ASLFO_InitialName (STRPTR) - Initial contents of the font requester's
  353.             Name text gadget. Default is none. (V36)
  354.  
  355.     ASLFO_InitialSize (UWORD) - Initial contents of the font requester's
  356.             Size numeric gadget (fo_Attr.ta_YSize). Default is 8.
  357.             (V36)
  358.  
  359.     ASLFO_InitialStyle (UBYTE) - Initial setting of the font requester's
  360.             Style gadget (fo_Attr.ta_Style). Default is FS_NORMAL.
  361.             (V36)
  362.  
  363.     ASLFO_InitialFlags (UBYTE) - Initial setting of the font requester's
  364.             fo_Flags field (fo_Attr.ta_Flags). Default is
  365.             FPF_ROMFONT. (V36)
  366.  
  367.     ASLFO_InitialFrontPen (UBYTE) - Initial setting of the font requester's
  368.             Front Color gadget (fo_FrontPen). Default is 1. (V36)
  369.  
  370.     ASLFO_InitialBackPen (UBYTE) - Initial setting of the font requester's
  371.                        Back Color gadget (fo_BackPen). Default is 0. (V36)
  372.  
  373.     ASLFO_InitialDrawMode (UBYTE) - Initial setting of the font
  374.             requester's Mode gadget (fo_DrawMode). Default is
  375.             JAM1. (V38)
  376.  
  377.     ASLFO_Flags (ULONG) - Bulk initialization of many of the requester's
  378.             options. See <libraries/asl.h> for the possible
  379.             flag values. Default is 0. (V36)
  380.  
  381.     ASLFO_DoFrontPen (BOOL) - Set this tag to TRUE to cause the requester
  382.             to display the Front Color selection gadget. Default is
  383.             FALSE. (V38)
  384.  
  385.     ASLFO_DoBackPen (BOOL) - Set this tag to TRUE to cause the requester
  386.             to display the Back Color selection gadget. Default
  387.             is FALSE. (V38)
  388.  
  389.     ASLFO_DoStyle (BOOL) - Set this tag to TRUE to cause the requester
  390.             to display the Style checkboxes. Default is FALSE.
  391.             (V38)
  392.  
  393.     ASLFO_DoDrawMode (BOOL) - Set this tag to TRUE to cause the requester
  394.             to display the Mode cycle gadget. Default is FALSE.
  395.             (V38)
  396.  
  397.     ASLFO_FixedWidthOnly (BOOL) - Set this tag to TRUE to cause the
  398.             requester to only display fixed-width fonts. Default
  399.             is FALSE. (V38)
  400.  
  401.     ASLFO_MinHeight (UWORD) - The minimum font height to let the user
  402.             select. Default is 5. (V36)
  403.  
  404.     ASLFO_MaxHeight (UWORD) - The maximum font height to let the user
  405.             select. Default is 24. (V36)
  406.  
  407.     ASLFO_FilterFunc (struct Hook *) - A function to call for each font
  408.             encountered. If the function returns TRUE, the font is
  409.             included in the font list, otherwise it is rejected
  410.             and not displayed. The function receives the following
  411.             parameters:
  412.                 A0 - (struct Hook *)
  413.                 A1 - (struct TextAttr *)
  414.                 A2 - (struct FontRequester *)
  415.             (V38)
  416.  
  417.     ASLFO_HookFunc (APTR) - A function that is called if the
  418.             FOF_FILTERFUNC or FOF_INTUIFUNC flags are specified in
  419.             the ASLFO_Flags tag. The function will be called like
  420.             so, with the arguments on the stack using the standard
  421.                 C pushing order:
  422.  
  423.                 ULONG function(ULONG mask, APTR object,
  424.                            struct FontRequester *fr)
  425.  
  426.             The Mask value is a copy of the specific ASLFO_Flags
  427.             value the callback is for, either FOF_FILTERFUNC or
  428.             FOF_INTUIFUNC; object is a pointer to a data object
  429.             (a (struct IntuiMessage *) for FOF_INTUIFUNC, and a
  430.             (struct TextAttr *) for FOF_FILTERFUNC).
  431.  
  432.             For FOF_FILTERFUNC, the function should return 1 if the
  433.             font should be added to the list, 0 if it
  434.             shouldn't. For FOF_INTUIFUNC, the function should
  435.             return the original (struct IntuiMessage *) it was
  436.             passed.
  437.  
  438.     ASLFO_ModeList (STRPTR *) - Replacement list of modes to display in
  439.             Mode cycle gadget. The first string pointer is used
  440.             as the name of the gadgets, and following strings are
  441.             used as the different labels of the cycle gadget,
  442.             until a NULL string pointer which denotes the end of
  443.             the string pointer array. The first string in this
  444.             array corresponds to JAM1, the second is JAM2, the
  445.             third to COMPLEMENT. The array can be early terminated
  446.             by not providing all entries. English default for
  447.             the array is "Text" "Text+Field" and "Complement".
  448.             (V36)
  449.  
  450.     Tags used for the screen mode requester (V38):
  451.  
  452.     ASLSM_Window (struct Window *) - Parent window of requester. If no
  453.             ASLSM_Screen tag is specified, the window structure
  454.             is used to determine on which screen to open the
  455.             requesting window. (V38)
  456.  
  457.     ASLSM_PubScreenName (STRPTR) - Name of a public screen to open on.
  458.             This overrides the screen used by ASLSM_Window. (V38)
  459.  
  460.     ASLSM_Screen (struct Screen *) - Screen on which to open the requester.
  461.             This overrides the screen used by ASLSM_Window or by
  462.             ASLSM_PubScreenName. (V38)
  463.  
  464.     ASLSM_PrivateIDCMP (BOOL) - When set to TRUE, this tells ASL to
  465.             allocate a new IDCMP port for the requesting window.
  466.             If not specified or set to FALSE, and if ASLSM_Window
  467.             is provided, the requesting window will share
  468.             ASLSM_Window's IDCMP port. (V38)
  469.  
  470.     ASLSM_IntuiMsgFunc (struct Hook *) - A function to call whenever an
  471.             unknown Intuition message arrives at the message port
  472.             being used by the requesting window. The function
  473.                        receives the following parameters:
  474.                 A0 - (struct Hook *)
  475.                 A1 - (struct IntuiMessage *)
  476.                 A2 - (struct ScreenModeRequester *)
  477.             (V38)
  478.  
  479.     ASLSM_SleepWindow (BOOL) - When set to TRUE, this tag will cause the
  480.             window specified by ASLSM_Window to be "put to
  481.             sleep". That is, a busy pointer will be displayed in
  482.             the parent window, and no gadget or menu activity will
  483.             be allowed. This is done by opening an invisible
  484.             Intuition Requester in the parent window. (V38)
  485.  
  486.     ASLSM_UserData (APTR) - A 32-bit value that is simply copied in the
  487.             sm_UserData field of the requester structure. (V38)
  488.  
  489.     ASLSM_TextAttr (struct TextAttr *) - Font to be used for the requesting
  490.             window's gadgets and menus. If this tag is not provided
  491.             or its value is NULL, the default font of the screen
  492.             on which the requesting window opens will be used.
  493.             This font must already be in memory as ASL calls
  494.             OpenFont() and not OpenDiskFont().
  495.             (V38)
  496.  
  497.     ASLSM_Locale (struct Locale *) - Locale to use for the requesting
  498.             window. This determines the language used for the
  499.             requester's gadgets and menus. If this tag is not
  500.             provided or its value is NULL, the system's current
  501.             default locale will be used. (V38)
  502.  
  503.     ASLSM_TitleText (STRPTR) - Title to use for the requesting window.
  504.             Default is no title. (V38)
  505.  
  506.     ASLSM_PositiveText (STRPTR) - Label of the positive gadget in the
  507.             requester. English default is "OK". Prior to V38, this
  508.             string could not be longer than 6 characters. (V36)
  509.  
  510.     ASLSM_NegativeText (STRPTR) - Label of the negative gadget in the
  511.             requester. English default is "Cancel". Prior to V38,
  512.             this string could not be longer than 6 characters.
  513.             (V36)
  514.  
  515.     ASLSM_InitialLeftEdge (WORD) - Suggested left edge of requesting
  516.             window. (V38)
  517.  
  518.     ASLSM_InitialTopEdge (WORD) - Suggested top edge of requesting
  519.             window. (V38)
  520.  
  521.     ASLSM_InitialWidth (WORD) - Suggested width of requesting window. (V38)
  522.  
  523.     ASLSM_InitialHeight (WORD) - Suggested height of requesting window.
  524.             (V38)
  525.  
  526.     ASLSM_InitialDisplayID (ULONG) - Initial setting of the Mode list view
  527.             gadget (sm_DisplayID). Default is 0 (LORES_KEY). (V38)
  528.  
  529.     ASLSM_InitialDisplayWidth (ULONG) - Initial setting of the Width gadget
  530.             (sm_DisplayWidth). Default is 640. (V38)
  531.  
  532.     ASLSM_InitialDisplayHeight (ULONG) - Initial setting of the Height
  533.             gadget (sm_DisplayHeight). Default is 200. (V38)
  534.  
  535.     ASLSM_InitialDisplayDepth (UWORD) - Initial setting of the Colors
  536.             gadget (sm_DisplayDepth). Default is 2. (V38)
  537.  
  538.     ASLSM_InitialOverscanType (UWORD) - Initial setting of the
  539.             Overscan Type cycle gadget (sm_OverscanType).
  540.             These values are the OSCAN_#? values from
  541.             <intuition/screens.h>. Default is OSCAN_TEXT.
  542.             As of V38, OSCAN_VIDEO is not supported. (V38)
  543.  
  544.     ASLSM_InitialAutoScroll (BOOL) - Initial setting of the AutoScroll
  545.             cycle gadget (sm_AutoScroll). Default is TRUE. (V38)
  546.  
  547.     ASLSM_InitialInfoOpened (BOOL) - Whether to open the property
  548.             information window automatically. Default is FALSE.
  549.             (V38)
  550.  
  551.     ASLSM_InitialInfoLeftEdge (WORD) - Initial left edge of information
  552.             window. (V38)
  553.  
  554.     ASLSM_InitialInfoTopEdge (WORD) - Initial top edge of information
  555.             window. (V38)
  556.  
  557.     ASLSM_DoWidth (BOOL) - Set this tag to TRUE to cause the requester
  558.             to display the Width numeric gadget. Default is FALSE.
  559.             (V38)
  560.  
  561.     ASLSM_DoHeight (BOOL) - Set this tag to TRUE to cause the requester
  562.             to display the Height numeric gadget. Default is FALSE.
  563.             (V38)
  564.  
  565.     ASLSM_DoDepth (BOOL) - Set this tag to TRUE to cause the requester to
  566.             display the Colors slider gadget. Default is FALSE.
  567.             (V38)
  568.  
  569.     ASLSM_DoOverscanType (BOOL) - Set this tag to TRUE to cause the
  570.             requester to display the Overscan Type cycle gadget.
  571.             Default is FALSE. (V38)
  572.  
  573.     ASLSM_DoAutoScroll (BOOL) - Set this tag to TRUE to cause the requester
  574.             to display the AutoScroll checkbox gadget. Default is
  575.             FALSE. (V38)
  576.  
  577.     ASLSM_PropertyFlags (ULONG) - A mode must have these property flags to
  578.             appear in the list of modes. Only the bits set in
  579.             ASLSM_PropertyMask are considered. Default is
  580.             DIPF_IS_WB. (V38)
  581.  
  582.     ASLSM_PropertyMask (ULONG) - A mask to apply to ASLSM_PropertyFlags
  583.             to determine which bits to consider. The use of these
  584.             two values is identical in concept to how Exec uses
  585.             the two flag paraneters in exec.library/SetSignal().
  586.             Default is DIPF_IS_WB. (V38)
  587.  
  588.     ASLSM_MinWidth (ULONG) - The minimum display width to let the user
  589.             choose. Default is 16. (V38)
  590.  
  591.     ASLSM_MaxWidth (ULONG) - The maximum display width to let the user
  592.             choose. Default is 16368. (V38)
  593.  
  594.     ASLSM_MinHeight (ULONG) - The minimum display height to let the user
  595.             choose. Default is 16. (V38)
  596.  
  597.     ASLSM_MaxHeight (ULONG) - The maximum display height to let the user
  598.             choose. Default is 16384. (V38)
  599.  
  600.     ASLSM_MinDepth (UWORD) - The minimum display depth to let the user
  601.             choose. Default is 1. (V38)
  602.  
  603.     ASLSM_MaxDepth (UWORD) - The maximum display depth to let the user
  604.             choose. Default is 24. (V38)
  605.  
  606.     ASLSM_FilterFunc (struct Hook *) - A function to call for each mode
  607.             encountered. If the function returns TRUE, the mode is
  608.             included in the file list, otherwise it is rejected
  609.             and not displayed. The function receives the following
  610.             parameters:
  611.                 A0 - (struct Hook *)
  612.                 A1 - (ULONG) mode id
  613.                 A2 - (struct ScreenModeRequester *)
  614.             (V38)
  615.  
  616.     ASLSM_CustomSMList (struct List *) - Custom list of modes to let
  617.             the user choose from. This is a list of DisplayNode
  618.             nodes, see <libraries/asl.h> for the definition. (V38)
  619.  
  620.    RESULT
  621.     result - FALSE if the user cancelled the requester or if something
  622.          prevented the requester from opening. If TRUE, values in the
  623.          requester structure will be set depending on the particular
  624.          type of requester.
  625.  
  626.          Under V38, If the return value is FALSE, you can look
  627.          at the result from the dos.library/IoErr() function to
  628.          determine whether the requester was cancelled or simply
  629.          failed to open. If dos.library/IoErr() returns 0, then the
  630.          requester was cancelled, any other value indicates a failure
  631.          to open. Current possible failure codes are
  632.          ERROR_NO_FREE_STORE which indicates there was not enough
  633.          memory, and ERROR_NO_MORE_ENTRIES which indicates no modes
  634.          were available for display in the screen mode requester
  635.          (usually because the application filter hook filtered them
  636.          all away)
  637.  
  638.    WARNING
  639.     All ASL requester data structures are READ-ONLY and can only be
  640.     modified by using tags!
  641.  
  642.    SEE ALSO
  643.     AllocAslRequest(), FreeAslRequest()
  644.  
  645. asl.library/FreeAslRequest                         asl.library/FreeAslRequest
  646.  
  647.    NAME
  648.     FreeAslRequest -- frees resources allocated by AllocAslRequest(). (V36)
  649.  
  650.    SYNOPSIS
  651.     FreeAslRequest(requester);
  652.                A0
  653.  
  654.     VOID FreeAslRequest(APTR);
  655.  
  656.    FUNCTION
  657.     FreeAslRequest() frees any system resources allocated by
  658.     AllocAslRequest(). Once a requester has been freed, it can no
  659.     longer be used with other calls to AslRequest().
  660.  
  661.    INPUTS
  662.     requester - requester obtained from AllocAslRequest(), or NULL in
  663.             which case this function does nothing.
  664.  
  665.    SEE ALSO
  666.     AllocAslRequest()
  667.  
  668. asl.library/FreeFileRequest                       asl.library/FreeFileRequest
  669.  
  670.    NAME
  671.     FreeFileRequest -- free file requester structure. (V36)
  672.  
  673.    SYNOPSIS
  674.     FreeFileRequest(requester);
  675.             A0
  676.  
  677.     VOID FreeFileRequest(struct FileRequester *);
  678.  
  679.    NOTES
  680.     This function is obsolete, please use AllocAslRequest() instead.
  681.  
  682.    SEE ALSO
  683.     FreeAslRequest()
  684.  
  685. asl.library/RequestFile                               asl.library/RequestFile
  686.  
  687.    NAME
  688.     RequestFile -- request user to select files. (V36)
  689.  
  690.    SYNOPSIS
  691.     result = RequestFile(requester);
  692.     D0                   A0
  693.  
  694.     BOOL RequestFile(struct FileRequester *);
  695.  
  696.    NOTES
  697.     This function is obsolete, please use AslRequest() instead.
  698.  
  699.    SEE ALSO
  700.     AslRequest()
  701.  
  702.