Home » Archimedes archive » Micro User » MU 1992-08.adf » ArcFSExtra » Documents/EntryPoint
Documents/EntryPoint
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 » Micro User » MU 1992-08.adf » ArcFSExtra |
| Filename: | Documents/EntryPoint |
| Read OK: | ✔ |
| File size: | 08F9 bytes |
| Load address: | 0000 |
| Exec address: | 0000 |
Duplicates
There is 1 duplicate copy of this file in the archive:
- Archimedes archive » Micro User » MU 1992-08.adf » ArcFSExtra » Documents/EntryPoint
- Archimedes archive » Micro User » MU 1992-09.adf » ArcFSExtra » Documents/EntryPoint
File contents
ArcFS 0.50/2.00 Documentation
-----------------------------
ArcFS supports the following entry points:
FSEntry_Func 0 to set current directory (*Dir)
FSEntry_Func 1 to set library directory (*Lib)
FSEntry_Func 2 to catalogue directory (*Cat)
FSEntry_Func 3 to examine directory (*EX)
FSEntry_Func 4 to catalogue library directory (*LCat)
FSEntry_Func 5 to examine library directory (*LEX)
FSEntry_Func 6 to examine objects (*Info).
FSEntry_Func 8 to rename objects (*Rename) - r/w version only
FSEntry_Func 9 to access objects (*Access) - r/w version only
FSEntry_Func 11 to read name of archive containing the CSD (OS_GBPB 5)
FSEntry_Func 12 to read CSD name (OS_GBPB 6)
FSEntry_Func 13 to read Lib. name (OS_GBPB 7)
FSEntry_Func 14 to read dir. entries (OS_GBPB 8/9)
FSEntry_Func 15 to respond to requests from the Filer for
the necessary information to display a directory window
FSEntry_Func 16 to close all archives on a Shut down
FSEntry_Func 19 to read directory entries & information
FSEntry_Func 20 to give full information on objects (*FileInfo)
FSEntry_File 0 to save files - r/w version only
FSEntry_File 1-4 to write catalogue information - r/w version only
FSEntry_File 5 to read catalogue information on a file
FSEntry_File 6 to delete objects - r/w version only
FSEntry_File 7 to create files - r/w version only
FSEntry_File 8 to create directories - r/w version only
FSEntry_File 255 to load files
FSEntry_Open to provide facilities for opening files for
random access input (and output for r/w version). ArcFS claims memory
from the R.M.A. the size of the uncompressed file and the loads the file
into this claimed memory. For this reason it is possible to
get 'No Room in RMA errors' when opening large files.
FSEntry_GetBytes reads required bytes from memory claimed
by FSEntry_Open
FSEntry_PutBytes writes required bytes to memory claimed by FSEntry_Open
extending it if necessary.
FSEntry_Args 3,4,7,8,9 is supported for operations on files open for
update - r/w version only
FSEntry_Close releases memory claimed by FSEntry_Open (and writes the
data back to the file if open for update)
00000000 41 72 63 46 53 20 30 2e 35 30 2f 32 2e 30 30 20 |ArcFS 0.50/2.00 | 00000010 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 0a 2d 2d |Documentation.--| 00000020 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 2d 2d 2d 0a 0a 41 72 63 |-----------..Arc| 00000040 46 53 20 73 75 70 70 6f 72 74 73 20 74 68 65 20 |FS supports the | 00000050 66 6f 6c 6c 6f 77 69 6e 67 20 65 6e 74 72 79 20 |following entry | 00000060 70 6f 69 6e 74 73 3a 0a 0a 20 20 20 20 46 53 45 |points:.. FSE| 00000070 6e 74 72 79 5f 46 75 6e 63 20 30 20 74 6f 20 73 |ntry_Func 0 to s| 00000080 65 74 20 63 75 72 72 65 6e 74 20 64 69 72 65 63 |et current direc| 00000090 74 6f 72 79 20 28 2a 44 69 72 29 0a 0a 20 20 20 |tory (*Dir).. | 000000a0 20 46 53 45 6e 74 72 79 5f 46 75 6e 63 20 31 20 | FSEntry_Func 1 | 000000b0 74 6f 20 73 65 74 20 6c 69 62 72 61 72 79 20 64 |to set library d| 000000c0 69 72 65 63 74 6f 72 79 20 28 2a 4c 69 62 29 0a |irectory (*Lib).| 000000d0 0a 20 20 20 20 46 53 45 6e 74 72 79 5f 46 75 6e |. FSEntry_Fun| 000000e0 63 20 32 20 74 6f 20 63 61 74 61 6c 6f 67 75 65 |c 2 to catalogue| 000000f0 20 64 69 72 65 63 74 6f 72 79 20 28 2a 43 61 74 | directory (*Cat| 00000100 29 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 5f 46 |).. FSEntry_F| 00000110 75 6e 63 20 33 20 74 6f 20 65 78 61 6d 69 6e 65 |unc 3 to examine| 00000120 20 64 69 72 65 63 74 6f 72 79 20 28 2a 45 58 29 | directory (*EX)| 00000130 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 5f 46 75 |.. FSEntry_Fu| 00000140 6e 63 20 34 20 74 6f 20 63 61 74 61 6c 6f 67 75 |nc 4 to catalogu| 00000150 65 20 6c 69 62 72 61 72 79 20 64 69 72 65 63 74 |e library direct| 00000160 6f 72 79 20 28 2a 4c 43 61 74 29 0a 0a 20 20 20 |ory (*LCat).. | 00000170 20 46 53 45 6e 74 72 79 5f 46 75 6e 63 20 35 20 | FSEntry_Func 5 | 00000180 74 6f 20 65 78 61 6d 69 6e 65 20 6c 69 62 72 61 |to examine libra| 00000190 72 79 20 64 69 72 65 63 74 6f 72 79 20 28 2a 4c |ry directory (*L| 000001a0 45 58 29 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 |EX).. FSEntry| 000001b0 5f 46 75 6e 63 20 36 20 74 6f 20 65 78 61 6d 69 |_Func 6 to exami| 000001c0 6e 65 20 6f 62 6a 65 63 74 73 20 28 2a 49 6e 66 |ne objects (*Inf| 000001d0 6f 29 2e 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 |o)... FSEntry| 000001e0 5f 46 75 6e 63 20 38 20 74 6f 20 72 65 6e 61 6d |_Func 8 to renam| 000001f0 65 20 6f 62 6a 65 63 74 73 20 28 2a 52 65 6e 61 |e objects (*Rena| 00000200 6d 65 29 20 2d 20 72 2f 77 20 76 65 72 73 69 6f |me) - r/w versio| 00000210 6e 20 6f 6e 6c 79 0a 0a 20 20 20 20 46 53 45 6e |n only.. FSEn| 00000220 74 72 79 5f 46 75 6e 63 20 39 20 74 6f 20 61 63 |try_Func 9 to ac| 00000230 63 65 73 73 20 6f 62 6a 65 63 74 73 20 28 2a 41 |cess objects (*A| 00000240 63 63 65 73 73 29 20 2d 20 72 2f 77 20 76 65 72 |ccess) - r/w ver| 00000250 73 69 6f 6e 20 6f 6e 6c 79 0a 0a 20 20 20 20 46 |sion only.. F| 00000260 53 45 6e 74 72 79 5f 46 75 6e 63 20 31 31 20 74 |SEntry_Func 11 t| 00000270 6f 20 72 65 61 64 20 6e 61 6d 65 20 6f 66 20 61 |o read name of a| 00000280 72 63 68 69 76 65 20 63 6f 6e 74 61 69 6e 69 6e |rchive containin| 00000290 67 20 74 68 65 20 43 53 44 20 28 4f 53 5f 47 42 |g the CSD (OS_GB| 000002a0 50 42 20 35 29 0a 0a 20 20 20 20 46 53 45 6e 74 |PB 5).. FSEnt| 000002b0 72 79 5f 46 75 6e 63 20 31 32 20 74 6f 20 72 65 |ry_Func 12 to re| 000002c0 61 64 20 43 53 44 20 6e 61 6d 65 20 28 4f 53 5f |ad CSD name (OS_| 000002d0 47 42 50 42 20 36 29 0a 0a 20 20 20 20 46 53 45 |GBPB 6).. FSE| 000002e0 6e 74 72 79 5f 46 75 6e 63 20 31 33 20 74 6f 20 |ntry_Func 13 to | 000002f0 72 65 61 64 20 4c 69 62 2e 20 6e 61 6d 65 20 28 |read Lib. name (| 00000300 4f 53 5f 47 42 50 42 20 37 29 0a 0a 20 20 20 20 |OS_GBPB 7).. | 00000310 46 53 45 6e 74 72 79 5f 46 75 6e 63 20 31 34 20 |FSEntry_Func 14 | 00000320 74 6f 20 72 65 61 64 20 64 69 72 2e 20 65 6e 74 |to read dir. ent| 00000330 72 69 65 73 20 28 4f 53 5f 47 42 50 42 20 38 2f |ries (OS_GBPB 8/| 00000340 39 29 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 5f |9).. FSEntry_| 00000350 46 75 6e 63 20 31 35 20 74 6f 20 72 65 73 70 6f |Func 15 to respo| 00000360 6e 64 20 74 6f 20 72 65 71 75 65 73 74 73 20 66 |nd to requests f| 00000370 72 6f 6d 20 74 68 65 20 46 69 6c 65 72 20 66 6f |rom the Filer fo| 00000380 72 20 0a 20 20 20 20 74 68 65 20 6e 65 63 65 73 |r . the neces| 00000390 73 61 72 79 20 69 6e 66 6f 72 6d 61 74 69 6f 6e |sary information| 000003a0 20 74 6f 20 64 69 73 70 6c 61 79 20 61 20 64 69 | to display a di| 000003b0 72 65 63 74 6f 72 79 20 77 69 6e 64 6f 77 0a 0a |rectory window..| 000003c0 20 20 20 20 46 53 45 6e 74 72 79 5f 46 75 6e 63 | FSEntry_Func| 000003d0 20 31 36 20 74 6f 20 63 6c 6f 73 65 20 61 6c 6c | 16 to close all| 000003e0 20 61 72 63 68 69 76 65 73 20 6f 6e 20 61 20 53 | archives on a S| 000003f0 68 75 74 20 64 6f 77 6e 0a 0a 20 20 20 20 46 53 |hut down.. FS| 00000400 45 6e 74 72 79 5f 46 75 6e 63 20 31 39 20 74 6f |Entry_Func 19 to| 00000410 20 72 65 61 64 20 64 69 72 65 63 74 6f 72 79 20 | read directory | 00000420 65 6e 74 72 69 65 73 20 26 20 69 6e 66 6f 72 6d |entries & inform| 00000430 61 74 69 6f 6e 0a 0a 20 20 20 20 46 53 45 6e 74 |ation.. FSEnt| 00000440 72 79 5f 46 75 6e 63 20 32 30 20 74 6f 20 67 69 |ry_Func 20 to gi| 00000450 76 65 20 66 75 6c 6c 20 69 6e 66 6f 72 6d 61 74 |ve full informat| 00000460 69 6f 6e 20 6f 6e 20 6f 62 6a 65 63 74 73 20 28 |ion on objects (| 00000470 2a 46 69 6c 65 49 6e 66 6f 29 0a 0a 20 20 20 20 |*FileInfo).. | 00000480 46 53 45 6e 74 72 79 5f 46 69 6c 65 20 30 20 74 |FSEntry_File 0 t| 00000490 6f 20 73 61 76 65 20 66 69 6c 65 73 20 2d 20 72 |o save files - r| 000004a0 2f 77 20 76 65 72 73 69 6f 6e 20 6f 6e 6c 79 0a |/w version only.| 000004b0 0a 20 20 20 20 46 53 45 6e 74 72 79 5f 46 69 6c |. FSEntry_Fil| 000004c0 65 20 31 2d 34 20 74 6f 20 77 72 69 74 65 20 63 |e 1-4 to write c| 000004d0 61 74 61 6c 6f 67 75 65 20 69 6e 66 6f 72 6d 61 |atalogue informa| 000004e0 74 69 6f 6e 20 2d 20 72 2f 77 20 76 65 72 73 69 |tion - r/w versi| 000004f0 6f 6e 20 6f 6e 6c 79 0a 0a 20 20 20 20 46 53 45 |on only.. FSE| 00000500 6e 74 72 79 5f 46 69 6c 65 20 35 20 74 6f 20 72 |ntry_File 5 to r| 00000510 65 61 64 20 63 61 74 61 6c 6f 67 75 65 20 69 6e |ead catalogue in| 00000520 66 6f 72 6d 61 74 69 6f 6e 20 6f 6e 20 61 20 66 |formation on a f| 00000530 69 6c 65 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 |ile.. FSEntry| 00000540 5f 46 69 6c 65 20 36 20 74 6f 20 64 65 6c 65 74 |_File 6 to delet| 00000550 65 20 6f 62 6a 65 63 74 73 20 2d 20 72 2f 77 20 |e objects - r/w | 00000560 76 65 72 73 69 6f 6e 20 6f 6e 6c 79 0a 0a 20 20 |version only.. | 00000570 20 20 46 53 45 6e 74 72 79 5f 46 69 6c 65 20 37 | FSEntry_File 7| 00000580 20 74 6f 20 63 72 65 61 74 65 20 66 69 6c 65 73 | to create files| 00000590 20 2d 20 72 2f 77 20 76 65 72 73 69 6f 6e 20 6f | - r/w version o| 000005a0 6e 6c 79 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 |nly.. FSEntry| 000005b0 5f 46 69 6c 65 20 38 20 74 6f 20 63 72 65 61 74 |_File 8 to creat| 000005c0 65 20 64 69 72 65 63 74 6f 72 69 65 73 20 2d 20 |e directories - | 000005d0 72 2f 77 20 76 65 72 73 69 6f 6e 20 6f 6e 6c 79 |r/w version only| 000005e0 0a 0a 20 20 20 20 46 53 45 6e 74 72 79 5f 46 69 |.. FSEntry_Fi| 000005f0 6c 65 20 32 35 35 20 74 6f 20 6c 6f 61 64 20 66 |le 255 to load f| 00000600 69 6c 65 73 0a 0a 20 20 20 20 46 53 45 6e 74 72 |iles.. FSEntr| 00000610 79 5f 4f 70 65 6e 20 74 6f 20 70 72 6f 76 69 64 |y_Open to provid| 00000620 65 20 66 61 63 69 6c 69 74 69 65 73 20 66 6f 72 |e facilities for| 00000630 20 6f 70 65 6e 69 6e 67 20 66 69 6c 65 73 20 66 | opening files f| 00000640 6f 72 20 0a 20 20 20 20 72 61 6e 64 6f 6d 20 61 |or . random a| 00000650 63 63 65 73 73 20 69 6e 70 75 74 20 28 61 6e 64 |ccess input (and| 00000660 20 6f 75 74 70 75 74 20 66 6f 72 20 72 2f 77 20 | output for r/w | 00000670 76 65 72 73 69 6f 6e 29 2e 20 41 72 63 46 53 20 |version). ArcFS | 00000680 63 6c 61 69 6d 73 20 6d 65 6d 6f 72 79 0a 20 20 |claims memory. | 00000690 20 20 66 72 6f 6d 20 74 68 65 20 52 2e 4d 2e 41 | from the R.M.A| 000006a0 2e 20 74 68 65 20 73 69 7a 65 20 6f 66 20 74 68 |. the size of th| 000006b0 65 20 75 6e 63 6f 6d 70 72 65 73 73 65 64 20 66 |e uncompressed f| 000006c0 69 6c 65 20 61 6e 64 20 74 68 65 20 6c 6f 61 64 |ile and the load| 000006d0 73 20 74 68 65 20 66 69 6c 65 20 0a 20 20 20 20 |s the file . | 000006e0 69 6e 74 6f 20 74 68 69 73 20 63 6c 61 69 6d 65 |into this claime| 000006f0 64 20 6d 65 6d 6f 72 79 2e 20 46 6f 72 20 74 68 |d memory. For th| 00000700 69 73 20 72 65 61 73 6f 6e 20 69 74 20 69 73 20 |is reason it is | 00000710 70 6f 73 73 69 62 6c 65 20 74 6f 20 0a 20 20 20 |possible to . | 00000720 20 67 65 74 20 27 4e 6f 20 52 6f 6f 6d 20 69 6e | get 'No Room in| 00000730 20 52 4d 41 20 65 72 72 6f 72 73 27 20 77 68 65 | RMA errors' whe| 00000740 6e 20 6f 70 65 6e 69 6e 67 20 6c 61 72 67 65 20 |n opening large | 00000750 66 69 6c 65 73 2e 0a 0a 20 20 20 20 46 53 45 6e |files... FSEn| 00000760 74 72 79 5f 47 65 74 42 79 74 65 73 20 72 65 61 |try_GetBytes rea| 00000770 64 73 20 72 65 71 75 69 72 65 64 20 62 79 74 65 |ds required byte| 00000780 73 20 66 72 6f 6d 20 6d 65 6d 6f 72 79 20 63 6c |s from memory cl| 00000790 61 69 6d 65 64 20 0a 20 20 20 20 62 79 20 46 53 |aimed . by FS| 000007a0 45 6e 74 72 79 5f 4f 70 65 6e 0a 0a 20 20 20 20 |Entry_Open.. | 000007b0 46 53 45 6e 74 72 79 5f 50 75 74 42 79 74 65 73 |FSEntry_PutBytes| 000007c0 20 77 72 69 74 65 73 20 72 65 71 75 69 72 65 64 | writes required| 000007d0 20 62 79 74 65 73 20 74 6f 20 6d 65 6d 6f 72 79 | bytes to memory| 000007e0 20 63 6c 61 69 6d 65 64 20 62 79 20 46 53 45 6e | claimed by FSEn| 000007f0 74 72 79 5f 4f 70 65 6e 0a 20 20 20 20 65 78 74 |try_Open. ext| 00000800 65 6e 64 69 6e 67 20 69 74 20 69 66 20 6e 65 63 |ending it if nec| 00000810 65 73 73 61 72 79 2e 0a 0a 20 20 20 20 46 53 45 |essary... FSE| 00000820 6e 74 72 79 5f 41 72 67 73 20 33 2c 34 2c 37 2c |ntry_Args 3,4,7,| 00000830 38 2c 39 20 69 73 20 73 75 70 70 6f 72 74 65 64 |8,9 is supported| 00000840 20 66 6f 72 20 6f 70 65 72 61 74 69 6f 6e 73 20 | for operations | 00000850 6f 6e 20 66 69 6c 65 73 20 6f 70 65 6e 20 66 6f |on files open fo| 00000860 72 0a 20 20 20 20 75 70 64 61 74 65 20 2d 20 72 |r. update - r| 00000870 2f 77 20 76 65 72 73 69 6f 6e 20 6f 6e 6c 79 0a |/w version only.| 00000880 0a 20 20 20 20 46 53 45 6e 74 72 79 5f 43 6c 6f |. FSEntry_Clo| 00000890 73 65 20 72 65 6c 65 61 73 65 73 20 6d 65 6d 6f |se releases memo| 000008a0 72 79 20 63 6c 61 69 6d 65 64 20 62 79 20 46 53 |ry claimed by FS| 000008b0 45 6e 74 72 79 5f 4f 70 65 6e 20 28 61 6e 64 20 |Entry_Open (and | 000008c0 77 72 69 74 65 73 20 74 68 65 0a 20 20 20 20 64 |writes the. d| 000008d0 61 74 61 20 62 61 63 6b 20 74 6f 20 74 68 65 20 |ata back to the | 000008e0 66 69 6c 65 20 69 66 20 6f 70 65 6e 20 66 6f 72 |file if open for| 000008f0 20 75 70 64 61 74 65 29 0a | update).| 000008f9
.