home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD5.iso / workbench / libs / rexmooslib.lha / MOOS / Docs / english / moos_dos.doc < prev    next >
Encoding:
Text File  |  1997-01-20  |  5.9 KB  |  275 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. dos/AddBuffers()
  6. dos/FileNote()
  7. dos/Makedir()
  8. dos/Protect()
  9. dos/Relabel()
  10.  
  11.  
  12. dos/AddBuffers()                                              dos/AddBuffers()
  13.  
  14.                  $VER: dos/AddBuffers 1.00 (17.Jan.1997)
  15.  
  16.     NAME
  17.  
  18.         dos/AddBuffers()
  19.  
  20.     SYNOPSIS
  21.  
  22.         bufnum = 'dos/AddBuffers'(drive,buffers)
  23.  
  24.     FUNCTION
  25.  
  26.         It is an interface for the AmigaDOS command "AddBuffers",
  27.         that must be present into the commands paths.
  28.  
  29.     INPUTS
  30.  
  31.         drive   - A valid drive name (DF0:, HD0:, RAM:,...).
  32.                   Must be available and mounted in the system.
  33.                   If not specified the function will refer to the
  34.                   drive associated with the current directory.
  35.  
  36.         buffers - The number of buffers to be added, may be a negative
  37.                   number. If not specified the function returns the
  38.                   actual number of buffers for the given drive.
  39.  
  40.     RESULT
  41.  
  42.         The total number of buffers assigned to the given drive.
  43.         On failure a zero is returned.
  44.  
  45.     EXAMPLE
  46.  
  47.         drive = "DF0:"
  48.         buffs = 'dos/AddBuffers'(drive,25)
  49.         SAY drive "now has" buffs "buffers..."
  50.  
  51.     NOTES
  52.  
  53.     TODO
  54.  
  55.     BUGS
  56.  
  57.         In case of errors the module don't give any information about
  58.         which was the cause of failure.
  59.  
  60.     SEE ALSO
  61.  
  62.         dos.library/AddBuffers()
  63.  
  64. dos/FileNote()                                                  dos/FileNote()
  65.  
  66.                   $VER: dos/FileNote 1.00 (19.Jan.1997)
  67.  
  68.     NAME
  69.  
  70.         dos/FileNote()
  71.  
  72.     SYNOPSIS
  73.  
  74.         success = 'dos/FileNote'(file,comment,options)
  75.  
  76.     FUNCTION
  77.  
  78.         It is an interface for the AmigaDOS command "FileNote",
  79.         that must be present into the commands paths.
  80.  
  81.     INPUTS
  82.  
  83.         file    - May be a single file/dir path name, or a pattern
  84.                   (eg: "libs:rex#?").
  85.  
  86.         comment - The new comment line, max 80 characters long.
  87.  
  88.         options - "All/S"
  89.  
  90.             "All/S" - Specifying a directory as "file" and giving
  91.                       this keyword, the "comment" will be added
  92.                       for every file into that directory and its
  93.                       sub-directories.
  94.  
  95.     RESULT
  96.  
  97.         boolean, 1 mean "all done".
  98.  
  99.     EXAMPLE
  100.  
  101.         CALL 'dos/FileNote'("rexx:dos/","ARexx script",'All')
  102.  
  103.     NOTES
  104.  
  105.     TODO
  106.  
  107.     BUGS
  108.  
  109.         In case of errors the module don't give any information about
  110.         which was the cause of failure.
  111.  
  112.     SEE ALSO
  113.  
  114.         dos.library/SetComment()
  115.  
  116. dos/Makedir()                                                    dos/Makedir()
  117.  
  118.                    $VER: dos/Makedir 1.00 (19.Jan.1997)
  119.  
  120.     NAME
  121.  
  122.         dos/Makedir()
  123.  
  124.     SYNOPSIS
  125.  
  126.         success = 'dos/Makedir'(dirs...)
  127.  
  128.     FUNCTION
  129.  
  130.         It is an interface for the AmigaDOS command "Makedir",
  131.         that must be present into the commands paths.
  132.  
  133.     INPUTS
  134.  
  135.         dirs - The function accepts a maximum of 15 arguments,
  136.                each of them may be one or more directories to be
  137.                created, separated by spaces.
  138.  
  139.     RESULT
  140.  
  141.         boolean, 1 mean "all done".
  142.  
  143.     EXAMPLE
  144.  
  145.         CALL 'dos/Makedir'("t:env t:env/sys","'RAM:new t' RAM:new_t")
  146.  
  147.     NOTES
  148.  
  149.     TODO
  150.  
  151.     BUGS
  152.  
  153.         In case of errors the module don't give any information about
  154.         which was the cause of failure.
  155.  
  156.     SEE ALSO
  157.  
  158.         dos.library/CreateDir()
  159.  
  160. dos/Protect()                                                    dos/Protect()
  161.  
  162.                    $VER: dos/Protect 1.00 (19.Jan.1997)
  163.  
  164.     NAME
  165.  
  166.         dos/Protect()
  167.  
  168.     SYNOPSIS
  169.  
  170.         success = 'dos/Protect'(file,flags,options)
  171.  
  172.     FUNCTION
  173.  
  174.         It is an interface for the AmigaDOS command "Protect",
  175.         that must be present into the commands paths.
  176.  
  177.     INPUTS
  178.  
  179.         file    - May be a single file/dir path name, or a pattern
  180.                   (eg: "libs:rex#?").
  181.  
  182.         flags   - Any combination of "AHPSRWED"
  183.  
  184.                     A - Archived
  185.                     H - Hidden
  186.                     P - Pure
  187.                     S - Script
  188.                     R - Readable
  189.                     W - Writeable
  190.                     E - Executable
  191.                     D - Deletable
  192.  
  193.         options - "Add/S,Sub/S,All/S"
  194.  
  195.             "Add/S" - The specified "flags" must be added for the
  196.                       given "file".
  197.  
  198.             "Sub/S" - The specified "flags" must be substracted
  199.                       for the given "file".
  200.  
  201.             "All/S" - Specifying a directory as "file" and giving
  202.                       this keyword, the "flags" will be changed
  203.                       for every file into that directory and its
  204.                       sub-directories.
  205.  
  206.     RESULT
  207.  
  208.         boolean, 1 mean "all done".
  209.  
  210.     EXAMPLE
  211.  
  212.         CALL 'dos/Protect'("rexx:","S",'Add All')
  213.  
  214.     NOTES
  215.  
  216.     TODO
  217.  
  218.     BUGS
  219.  
  220.         In case of errors the module don't give any information about
  221.         which was the cause of failure.
  222.  
  223.     SEE ALSO
  224.  
  225.         dos.library/SetProtection()
  226.  
  227. dos/Relabel()                                                    dos/Relabel()
  228.  
  229.                    $VER: dos/Relabel 1.00 (17.Jan.1997)
  230.  
  231.     NAME
  232.  
  233.         dos/Relabel()
  234.  
  235.     SYNOPSIS
  236.  
  237.         success = 'dos/Relabel'(drive,name)
  238.  
  239.     FUNCTION
  240.  
  241.         It is an interface for the AmigaDOS command "Relabel",
  242.         that must be present into the commands paths.
  243.  
  244.     INPUTS
  245.  
  246.         drive - A valid drive name (DF0:, HD0:, RAM:,...).
  247.                 Must be available and mounted in the system.
  248.  
  249.         name  - The new name for the given drive, without the
  250.                 trailing ":" (Work, Mail, Empty,...). The function
  251.                 removes any trailing ":" from the given name.
  252.  
  253.     RESULT
  254.  
  255.         boolean, 1 mean "all done".
  256.  
  257.     EXAMPLE
  258.  
  259.         IF ~'dos/Relabel'("RAM:","Ram") THEN
  260.             SAY "Sorry, an error was occurred."
  261.         ELSE SAY "Ram disk relabeled..."
  262.  
  263.     NOTES
  264.  
  265.     TODO
  266.  
  267.     BUGS
  268.  
  269.         In case of errors the module don't give any information about
  270.         which was the cause of failure.
  271.  
  272.     SEE ALSO
  273.  
  274.  
  275.