home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d0xx / d034 / requester.lha / Requester / requester.doc < prev    next >
Encoding:
Text File  |  1986-09-03  |  1.6 KB  |  44 lines
  1. NAME
  2.     FileRequest -- Presents a file name requester in your window.
  3.  
  4. SYNOPSIS
  5.     BOOL FileRequest(Title, LeftButtonText, FullPath, Window);
  6.  
  7.     UBYTE *Title, *LeftButtonText, *FullPath;
  8.     struct Window *Window;
  9.  
  10. FUNCTION
  11.     This routine performs the functions of a file name requester:  it lists
  12.     the directory specified by FullPath; it displays up to 8 file or
  13.     directory names; it allows scrolling up and down the list using boolean
  14.     or potentiometer gadgets; and it permits directory and file name
  15.     selection using the mouse or the keyboard.
  16.  
  17.     NOTE: The "GADGETDOWN, GADGETUP and REQCLEAR" IDCMP flags must be set in
  18.     your Window structure for this requester to operate properly.
  19.  
  20. INPUTS
  21.     Title = pointer to a string that is the title of the requester.
  22.     LeftButtonText = pointer to a string that indicates the function
  23.         associated with the left boolean gadget (e.g. Load or Save).
  24.         (The right mouse button is always associated with the Cancel
  25.         function.)
  26.     FullPath = pointer to a string containing the full path of the directory
  27.         to be listed when requester is displayed. (There must be room in the
  28.         string for at least 80 bytes - 79 + NULL termination.)
  29.         Example: UBYTE MyFile[80] = "df0:dir1/dir2/file"
  30.     Window = pointer to the window in which the requester is to be rendered.
  31.  
  32. RESULT
  33.     If the right requester (Cancel) button is selected, FALSE is returned.
  34.     If the left requester button (defined by you) is selected, TRUE is
  35.     returned.
  36.  
  37.     The variable "FullPath" is modified by the user's actions, regardless of
  38.     which button is selected.
  39.  
  40. BUGS
  41.  
  42. SEE ALSO
  43.     AutoRequest(), Request().
  44.