NDSummary.OnToolTipsLoaded("File:dos.h",{1269:"
void DOS_Call(
u8 func
)
Call a BDOS function
",1270:"
void DOS_Exit0()
Exit program and return to DOS
",1272:"
c8 DOS_CharInput()
Input character
",1273:"
void DOS_CharOutput(
c8 chr
)
Output character
",1274:"
void DOS_StringOutput(
const c8* str
)
The characters of the string will be output. The string is terminated by "$" (ASCII 24h).
",1275:"
inline void DOS_Beep()
Play bip sound
",1276:"
inline void DOS_ClearScreen()
Clear console screen
",1277:"
inline void DOS_Return()
Carriage return
",1279:"
void DOS_SetTransferAddr(
void* data
)
Set transfer address This function simply records the address passed in DE as the disk transfer address.  This address will be used for all subsequent FCB read and write calls, for "search for first" and "search for next" calls to store the directory entry, and for absolute read and write calls.  It is not used by the new MSX-DOS read and write functions. The address is set back to 80h by a DISK RESET call.
",1280:"
u16 DOS_GetFreeSpace(
u8 drive
)
Get free space on disk
",1281:"
u8 DOS_OpenFCB(
DOS_FCB* stream
)
Open file The unopened FCB must contain a drive which may be zero to indicate the current drive and a filename and extension which may be ambiguous.  The current directory of the specified drive will be searched for a matching file and if found it will be opened.  Matching entries which are sub-directories or system files will be ignored, and if the filename is ambiguous then the first suitable matching entry will be opened.
",1282:"
inline u32 DOS_GetSizeFCB(
DOS_FCB* stream
)
Get the size of an opened file
",1283:"
u8 DOS_CloseFCB(
DOS_FCB* stream
)
Close file
",1284:"
u8 DOS_CreateFCB(
DOS_FCB* stream
)
Create file
",1285:"
u8 DOS_DeleteFCB(
DOS_FCB* stream
)
Delete file
",1286:"
u8 DOS_SequentialReadFCB(
DOS_FCB* stream
)
Sequential read
",1287:"
u8 DOS_SequentialWriteFCB(
DOS_FCB* stream
)
Sequential write
",1288:"
u8 DOS_RandomBlockWriteFCB(
DOS_FCB* stream,
u16 records
)
Random block write
",1289:"
u16 DOS_RandomBlockReadFCB(
DOS_FCB* stream,
u16 records
)
Random block read
",1290:"
u8 DOS_FindFirstFileFCB(
DOS_FCB* stream
)
Search the first file matched with wildcard
",1291:"
u8 DOS_FindNextFileFCB()
Search the second and after the second file matched wildcard
",1293:"
void DOS_InstallErrorHandler(
callback cb,
u8 size
)
Install the DOS error handler in RAM (page 3).
",1294:"
inline void DOS_ResetLastError()
Reset the last error code.  Must be called before any MSX-DOS 1 function call when you want to check whether an error has occurred.
",1296:"
u8 DOS_GetVersion(
DOS_Version* ver
)
Get MSX-DOS version number
",1297:"
u8 DOS_SelectDrive(
u8 drive
)
Select disk drive number
",1298:"
inline u8 DOS_SelectDriveLetter(
c8 drive
)
Select disk drive letter
",1299:"
Get a bit field of all available disk drives
",1300:"
u8 DOS_GetCurrentDrive()
Get current disk drive number
",1301:"
inline c8 DOS_GetCurrentDriveLetter()
Get current disk drive letter
",1302:"
void DOS_GetDiskInfo(
u8 drive,
DOS_DiskInfo* info
)
Get given disk information
",1303:"
inline u16 DOS_GetFreeClusters(
DOS_DiskInfo* info
)
Retreive number of free clusters from a disk information structure
",1304:"
inline u32 DOS_GetFreeSectors(
DOS_DiskInfo* info
)
Retreive number of free sectors from a disk information structure
",1305:"
inline u32 DOS_GetFreeBytes(
DOS_DiskInfo* info
)
Retreive number of free bytes from a disk information structure
",1306:"
inline u16 DOS_GetTotalClusters(
DOS_DiskInfo* info
)
Retreive total number of clusters from a disk information structure
",1307:"
inline u32 DOS_GetTotalSectors(
DOS_DiskInfo* info
)
Retreive total number of sectors from a disk information structure
",1308:"
inline u32 DOS_GetTotalBytes(
DOS_DiskInfo* info
)
Retreive total number of bytes from a disk information structure
",1310:"
u8 DOS_OpenHandle(
const c8* path,
u8 mode
)
Open file handle
",1311:"
u8 DOS_CreateHandle(
const c8* path,
u8 mode,
u8 attr
)
Create file handle
",1312:"
u8 DOS_CloseHandle(
u8 file
)
Close file handle
",1313:"
u8 DOS_EnsureHandle(
u8 file
)
Ensure file handle
",1314:"
u8 DOS_DuplicateHandle(
u8 file
)
Duplicate file handle
",1315:"
u16 DOS_ReadHandle(
u8 file,
void* buffer,
u16 size
)
Read from file handle
",1316:"
u16 DOS_WriteHandle(
u8 file,
const void* buffer,
u16 size
)
Write to file handle
",1317:"
u32 DOS_SeekHandle(
u8 file,
i32 offset,
u8 mode
) __CALLEE
Move file handle pointer
",1318:"
u8 DOS_DeleteHandle(
u8 file
)
Delete file or subdirectory
",1319:"
u8 DOS_RenameHandle(
u8 file,
const c8* newPath
)
Rename file or subdirectory
",1320:"
u8 DOS_MoveHandle(
u8 file,
const c8* newPath
)
Move the file associated with the specified file handle to the directory specified by the new path string.  A file handle cannot be moved if there are any other separately opened file handles for this file (".FOPEN" error), although it can be moved if there are copies of this file handle, and in this case the copies will also be moved.  Moving a file handle will not alter the file pointer but it will do an implicit "ensure" operation.
",1321:"
u8 DOS_SetAttributeHandle(
u8 file,
u8 attr
)
Set the attributes byte of the file associated with the specified file handle.  A file handle cannot have its attributes changed (although they can be read) if there are any other separately opened file handles for this file (".FOPEN" error).  The file pointer will not be altered but an implicit "ensure" operation will be done.
",1322:"
u8 DOS_GetAttributeHandle(
u8 file
)
Get the attributes byte of the file associated with the specified file handle.  A file handle cannot have its attributes changed (although they can be read) if there are any other separately opened file handles for this file (".FOPEN" error).  The file pointer will not be altered but an implicit "ensure" operation will be done.
",1324:"
u8 DOS_GetDiskParam(
u8 drv,
DOS_DiskParam* param
)
Get disk parameters
",1325:"
void DOS_Exit(
u8 err
)
Terminate with error code
",1326:"
void DOS_Explain(
u8 err,
c8* str
)
Explain error code
",1327:"
inline u8 DOS_GetLastError()
Get last error code
",1329:"
DOS_FIB* DOS_FindFirstEntry(
const c8* filename,
u8 attr
)
Find first entry
",1330:"
DOS_FIB* DOS_FindNextEntry()
Find next entry
",1331:"
inline DOS_FIB* DOS_GetLastFileInfo()
Get last file info
",1332:"
inline u16 DOS_GetFileYear(
const DOS_FIB* fib
)
Get last error code
",1333:"
inline u8 DOS_GetFileMonth(
const DOS_FIB* fib
)
Get last error code
",1334:"
inline u8 DOS_GetFileDay(
const DOS_FIB* fib
)
Get last error code
",1335:"
inline u8 DOS_GetFileHour(
const DOS_FIB* fib
)
Get last error code
",1336:"
inline u8 DOS_GetFileMinute(
const DOS_FIB* fib
)
Get last error code
",1337:"
inline u8 DOS_GetFileSecond(
const DOS_FIB* fib
)
Get last error code
",1338:"
u8 DOS_Delete(
const c8* path
)
Delete file or subdirectory
",1339:"
u8 DOS_Rename(
const c8* path,
const c8* newPath
)
Rename file or subdirectory
",1340:"
u8 DOS_Move(
const c8* path,
const c8* newPath
)
Move file or subdirectory
",1341:"
u8 DOS_SetAttribute(
const c8* path,
u8 attr
)
Set file attributes
",1342:"
u8 DOS_GetAttribute(
const c8* path
)
Get file attributes
",1343:"
u8 DOS_GetDirectory(
u8 drive,
const c8* path
)
Get current directory
",1344:"
inline u8 DOS_GetCurrentDiskDirectory(
const c8* path
)
Get directory in the current drive
",1345:"
u8 DOS_ChangeDirectory(
const c8* path
)
Change current directory
",1346:"
const DOS_Time* DOS_GetTime()
Get current date and time
",1348:"
u8 DOS_InterSlotRead(
u8 slot,
u16 addr
)
Reads the value of an address in another slot
",1349:"
void DOS_InterSlotWrite(
u8 slot,
u16 addr,
u8 value
)
Writes a value to an address in another slot
",1350:"
void DOS_InterSlotCall(
u8 slot,
u16 addr
)
Executes inter-slot call.
"});