Home » Archimedes archive » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95 » !AWJan95/Goodies/Event/Docs/OS

!AWJan95/Goodies/Event/Docs/OS

This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.

Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.

Tape/disk: Home » Archimedes archive » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95
Filename: !AWJan95/Goodies/Event/Docs/OS
Read OK:
File size: 0682 bytes
Load address: 0000
Exec address: 0000
File contents
--------------------------------------------------------

FNshell_OSCheckModuleVersion()
Params =>
         str  module name
         real version nr required

       <=
         bool TRUE or FALSE

Use this routine to check whether a
certain version (or later) of a specific
module is installed.

--------------------------------------------------------

FNshell_OSCheckVersion()
Params =>
         real version nr required

       <=
         bool TRUE or FALSE

Use this routine to check whether RISC
OS 3 is installed for example. The
routine returns FALSE if the OS version
requested (or a later version) is not
found.

--------------------------------------------------------

FNshell_OSVarExists()
Params =>
         int  workspace buffer
         str  os variable name

       <=
         bool TRUE or FALSE

--------------------------------------------------------

FNshell_OSVarGetVal()
Params =>
         int  workspace buffer
         int  size of buffer
         str  os variable name
         bool expand flag

       <=
         str  value of variable

--------------------------------------------------------

FNshell_OSReadCommandArg()
Params =>
         int  option (must be 0 or 1)

       <=
         str  command string

--------------------------------------------------------

FNshell_GetCmdLineArgs
Params =>
         None

Returns the command line used to start the program
excluding the program name itself. If an alias has
been set up for the filetype with  Set
Alias$@RunType_xxx then this call will return the
name of the file that was double clicked on to start
the application.

--------------------------------------------------------
00000000  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000030  2d 2d 2d 2d 2d 2d 2d 2d  0a 0a 46 4e 73 68 65 6c  |--------..FNshel|
00000040  6c 5f 4f 53 43 68 65 63  6b 4d 6f 64 75 6c 65 56  |l_OSCheckModuleV|
00000050  65 72 73 69 6f 6e 28 29  0a 50 61 72 61 6d 73 20  |ersion().Params |
00000060  3d 3e 0a 20 20 20 20 20  20 20 20 20 73 74 72 20  |=>.         str |
00000070  20 6d 6f 64 75 6c 65 20  6e 61 6d 65 0a 20 20 20  | module name.   |
00000080  20 20 20 20 20 20 72 65  61 6c 20 76 65 72 73 69  |      real versi|
00000090  6f 6e 20 6e 72 20 72 65  71 75 69 72 65 64 0a 0a  |on nr required..|
000000a0  20 20 20 20 20 20 20 3c  3d 0a 20 20 20 20 20 20  |       <=.      |
000000b0  20 20 20 62 6f 6f 6c 20  54 52 55 45 20 6f 72 20  |   bool TRUE or |
000000c0  46 41 4c 53 45 0a 0a 55  73 65 20 74 68 69 73 20  |FALSE..Use this |
000000d0  72 6f 75 74 69 6e 65 20  74 6f 20 63 68 65 63 6b  |routine to check|
000000e0  20 77 68 65 74 68 65 72  20 61 0a 63 65 72 74 61  | whether a.certa|
000000f0  69 6e 20 76 65 72 73 69  6f 6e 20 28 6f 72 20 6c  |in version (or l|
00000100  61 74 65 72 29 20 6f 66  20 61 20 73 70 65 63 69  |ater) of a speci|
00000110  66 69 63 0a 6d 6f 64 75  6c 65 20 69 73 20 69 6e  |fic.module is in|
00000120  73 74 61 6c 6c 65 64 2e  0a 0a 2d 2d 2d 2d 2d 2d  |stalled...------|
00000130  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000160  2d 2d 0a 0a 46 4e 73 68  65 6c 6c 5f 4f 53 43 68  |--..FNshell_OSCh|
00000170  65 63 6b 56 65 72 73 69  6f 6e 28 29 0a 50 61 72  |eckVersion().Par|
00000180  61 6d 73 20 3d 3e 0a 20  20 20 20 20 20 20 20 20  |ams =>.         |
00000190  72 65 61 6c 20 76 65 72  73 69 6f 6e 20 6e 72 20  |real version nr |
000001a0  72 65 71 75 69 72 65 64  0a 0a 20 20 20 20 20 20  |required..      |
000001b0  20 3c 3d 0a 20 20 20 20  20 20 20 20 20 62 6f 6f  | <=.         boo|
000001c0  6c 20 54 52 55 45 20 6f  72 20 46 41 4c 53 45 0a  |l TRUE or FALSE.|
000001d0  0a 55 73 65 20 74 68 69  73 20 72 6f 75 74 69 6e  |.Use this routin|
000001e0  65 20 74 6f 20 63 68 65  63 6b 20 77 68 65 74 68  |e to check wheth|
000001f0  65 72 20 52 49 53 43 0a  4f 53 20 33 20 69 73 20  |er RISC.OS 3 is |
00000200  69 6e 73 74 61 6c 6c 65  64 20 66 6f 72 20 65 78  |installed for ex|
00000210  61 6d 70 6c 65 2e 20 54  68 65 0a 72 6f 75 74 69  |ample. The.routi|
00000220  6e 65 20 72 65 74 75 72  6e 73 20 46 41 4c 53 45  |ne returns FALSE|
00000230  20 69 66 20 74 68 65 20  4f 53 20 76 65 72 73 69  | if the OS versi|
00000240  6f 6e 0a 72 65 71 75 65  73 74 65 64 20 28 6f 72  |on.requested (or|
00000250  20 61 20 6c 61 74 65 72  20 76 65 72 73 69 6f 6e  | a later version|
00000260  29 20 69 73 20 6e 6f 74  0a 66 6f 75 6e 64 2e 0a  |) is not.found..|
00000270  0a 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |.---------------|
00000280  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
000002a0  2d 2d 2d 2d 2d 2d 2d 2d  2d 0a 0a 46 4e 73 68 65  |---------..FNshe|
000002b0  6c 6c 5f 4f 53 56 61 72  45 78 69 73 74 73 28 29  |ll_OSVarExists()|
000002c0  0a 50 61 72 61 6d 73 20  3d 3e 0a 20 20 20 20 20  |.Params =>.     |
000002d0  20 20 20 20 69 6e 74 20  20 77 6f 72 6b 73 70 61  |    int  workspa|
000002e0  63 65 20 62 75 66 66 65  72 0a 20 20 20 20 20 20  |ce buffer.      |
000002f0  20 20 20 73 74 72 20 20  6f 73 20 76 61 72 69 61  |   str  os varia|
00000300  62 6c 65 20 6e 61 6d 65  0a 0a 20 20 20 20 20 20  |ble name..      |
00000310  20 3c 3d 0a 20 20 20 20  20 20 20 20 20 62 6f 6f  | <=.         boo|
00000320  6c 20 54 52 55 45 20 6f  72 20 46 41 4c 53 45 0a  |l TRUE or FALSE.|
00000330  0a 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |.---------------|
00000340  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000360  2d 2d 2d 2d 2d 2d 2d 2d  2d 0a 0a 46 4e 73 68 65  |---------..FNshe|
00000370  6c 6c 5f 4f 53 56 61 72  47 65 74 56 61 6c 28 29  |ll_OSVarGetVal()|
00000380  0a 50 61 72 61 6d 73 20  3d 3e 0a 20 20 20 20 20  |.Params =>.     |
00000390  20 20 20 20 69 6e 74 20  20 77 6f 72 6b 73 70 61  |    int  workspa|
000003a0  63 65 20 62 75 66 66 65  72 0a 20 20 20 20 20 20  |ce buffer.      |
000003b0  20 20 20 69 6e 74 20 20  73 69 7a 65 20 6f 66 20  |   int  size of |
000003c0  62 75 66 66 65 72 0a 20  20 20 20 20 20 20 20 20  |buffer.         |
000003d0  73 74 72 20 20 6f 73 20  76 61 72 69 61 62 6c 65  |str  os variable|
000003e0  20 6e 61 6d 65 0a 20 20  20 20 20 20 20 20 20 62  | name.         b|
000003f0  6f 6f 6c 20 65 78 70 61  6e 64 20 66 6c 61 67 0a  |ool expand flag.|
00000400  0a 20 20 20 20 20 20 20  3c 3d 0a 20 20 20 20 20  |.       <=.     |
00000410  20 20 20 20 73 74 72 20  20 76 61 6c 75 65 20 6f  |    str  value o|
00000420  66 20 76 61 72 69 61 62  6c 65 0a 0a 2d 2d 2d 2d  |f variable..----|
00000430  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000460  2d 2d 2d 2d 0a 0a 46 4e  73 68 65 6c 6c 5f 4f 53  |----..FNshell_OS|
00000470  52 65 61 64 43 6f 6d 6d  61 6e 64 41 72 67 28 29  |ReadCommandArg()|
00000480  0a 50 61 72 61 6d 73 20  3d 3e 0a 20 20 20 20 20  |.Params =>.     |
00000490  20 20 20 20 69 6e 74 20  20 6f 70 74 69 6f 6e 20  |    int  option |
000004a0  28 6d 75 73 74 20 62 65  20 30 20 6f 72 20 31 29  |(must be 0 or 1)|
000004b0  0a 0a 20 20 20 20 20 20  20 3c 3d 0a 20 20 20 20  |..       <=.    |
000004c0  20 20 20 20 20 73 74 72  20 20 63 6f 6d 6d 61 6e  |     str  comman|
000004d0  64 20 73 74 72 69 6e 67  0a 0a 2d 2d 2d 2d 2d 2d  |d string..------|
000004e0  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000510  2d 2d 0a 0a 46 4e 73 68  65 6c 6c 5f 47 65 74 43  |--..FNshell_GetC|
00000520  6d 64 4c 69 6e 65 41 72  67 73 0a 50 61 72 61 6d  |mdLineArgs.Param|
00000530  73 20 3d 3e 0a 20 20 20  20 20 20 20 20 20 4e 6f  |s =>.         No|
00000540  6e 65 0a 0a 52 65 74 75  72 6e 73 20 74 68 65 20  |ne..Returns the |
00000550  63 6f 6d 6d 61 6e 64 20  6c 69 6e 65 20 75 73 65  |command line use|
00000560  64 20 74 6f 20 73 74 61  72 74 20 74 68 65 20 70  |d to start the p|
00000570  72 6f 67 72 61 6d 0a 65  78 63 6c 75 64 69 6e 67  |rogram.excluding|
00000580  20 74 68 65 20 70 72 6f  67 72 61 6d 20 6e 61 6d  | the program nam|
00000590  65 20 69 74 73 65 6c 66  2e 20 49 66 20 61 6e 20  |e itself. If an |
000005a0  61 6c 69 61 73 20 68 61  73 0a 62 65 65 6e 20 73  |alias has.been s|
000005b0  65 74 20 75 70 20 66 6f  72 20 74 68 65 20 66 69  |et up for the fi|
000005c0  6c 65 74 79 70 65 20 77  69 74 68 20 20 53 65 74  |letype with  Set|
000005d0  0a 41 6c 69 61 73 24 40  52 75 6e 54 79 70 65 5f  |.Alias$@RunType_|
000005e0  78 78 78 20 74 68 65 6e  20 74 68 69 73 20 63 61  |xxx then this ca|
000005f0  6c 6c 20 77 69 6c 6c 20  72 65 74 75 72 6e 20 74  |ll will return t|
00000600  68 65 0a 6e 61 6d 65 20  6f 66 20 74 68 65 20 66  |he.name of the f|
00000610  69 6c 65 20 74 68 61 74  20 77 61 73 20 64 6f 75  |ile that was dou|
00000620  62 6c 65 20 63 6c 69 63  6b 65 64 20 6f 6e 20 74  |ble clicked on t|
00000630  6f 20 73 74 61 72 74 0a  74 68 65 20 61 70 70 6c  |o start.the appl|
00000640  69 63 61 74 69 6f 6e 2e  0a 0a 2d 2d 2d 2d 2d 2d  |ication...------|
00000650  2d 2d 2d 2d 2d 2d 2d 2d  2d 2d 2d 2d 2d 2d 2d 2d  |----------------|
*
00000680  2d 2d                                             |--|
00000682