Home / Autodocs / trackfile.device
NAME
- TFEjectMediaTagList
-
Attempt to remove a disk image file from currently active unit, "ejecting" it.
SYNOPSIS
error = TFEjectMediaTagList(which_unit, tags)
LONG TFEjectMediaTagList(LONG which_unit,
LONG TFEjectMediaMediaTags(LONG which_unit, ...);
D0 D0 A0
CONST struct TagItem *tags);
FUNCTION
When a disk image file is no longer useful, memory can be saved by ejecting it from the trackfile.device it is currently attached to. This may involve writing back currently buffered data to the volume on which the disk image file resides, so that it may be removed safely.
INPUTS
- which_unit
-
Which unit to eject the disk image file from. Unit numbers must be >= 0.
- tags
-
Pointer to a list of TagItems; this may be NULL.
TAGS
- TF_Timeout (LONG)
-
How many seconds to wait for the file system to "settle" down before an attempt is made to eject the disk. This must be 5 seconds or more. If fewer than 5 seconds are requested, an attempt will be made to eject the disk immediately; this attempt may fail because the disk is still being used. The timeout defaults to 0 seconds, which means that no time is spent waiting for the disk image file to "settle down".
If you asked for a timeout, and the disk image file has not yet been ejected because it is busy, you can hit [Ctrl+C] to stop waiting and cancel the attempt to eject the disk.
RESULT
- error
-
Zero if successful, otherwise an error code is returned.
- TFERROR_Denied
-
Only a Process may call the TFEjectMediaTagList() function, never a Task.
- TFERROR_UnitNotFound
-
The unit you requested is either not known or not currently active.
- ERROR_BREAK
-
You hit [Ctrl+C] before the timeout had elapsed, waiting for the disk image file to settle down.
- TDERR_SeekError
-
The disk image file size or the file's properties have changed since the last time it was accessed. It may have been corrupted or truncated. Check with dos.library/IoErr() for more information.
- TDERR_WriteProt
-
The disk image file used to be writable, but now something happened which prevents buffered data from getting written back to it. Check with dos.library/IoErr() for more information.
- TDERR_DiskChanged
-
The disk image file has changed, or the volume on which it is stored is no longer in the same state as it used to be. Check with dos.library/IoErr() for more information.
SEE ALSO
<exec/errors.h>, <devices/trackdisk.h>, <devices/trackfile.h>, <dos/dos.h> TFInsertMediaTagList(), TFStartUnitTagList(), TFGetUnitData()