1
0
mirror of https://github.com/cc65/cc65.git synced 2024-12-28 22:30:12 +00:00

document the dio_query_sectsize function

git-svn-id: svn://svn.cc65.org/cc65/trunk@3397 b7a2c559-68d2-44c3-8de9-860c34a00d81
This commit is contained in:
cpg 2005-02-20 21:01:09 +00:00
parent 50319e2a4f
commit ec579681e7

View File

@ -3,7 +3,7 @@
<article> <article>
<title>Diskette Sector I/O Routines <title>Diskette Sector I/O Routines
<author>Christian Groessler, <htmlurl url="mailto:cpg@aladdin.de" name="cpg@aladdin.de"> <author>Christian Groessler, <htmlurl url="mailto:cpg@aladdin.de" name="cpg@aladdin.de">
<date>21.11.2000 <date>20-Feb-2005
<abstract> <abstract>
The cc65 library provides functions to read and write raw disk sectors. The cc65 library provides functions to read and write raw disk sectors.
@ -45,7 +45,7 @@ The read and write functions are:
void *buffer); void *buffer);
</verb></tscreen> </verb></tscreen>
This function will read the sector specified by sect_num into the memory This function will read the sector specified by <tt>sect_num</tt> into the memory
location at buffer. location at buffer.
<tscreen><verb> <tscreen><verb>
@ -67,10 +67,24 @@ This function will write the memory contents at buffer to the sector specified
by <tt>sect_num</tt>. A verification is performed. by <tt>sect_num</tt>. A verification is performed.
<p> <p>
Use the <tt><ref name="dio_query_sectsize" id="sectsize"></tt> function to query the size of a sector.
All these functions will return 0 for success and an OS specific error code in All these functions will return 0 for success and an OS specific error code in
case of failure. case of failure.
<p> <p>
<sect>Querying sector size<label id="sectsize"><p>
Some systems support multiple diskette formats which have different sector sizes.
The following function returns the sector size of the currently inserted disk:
<tscreen><verb>
sectsize_t __fastcall__ dio_query_sectsize(dhandle_t handle);
</verb></tscreen>
On the Atari platform, the sector size is handled specially. Please refer
to the DIO section in the <htmlurl url="atari.html" name="Atari">
specific platform documentation.
<sect>Converting sector numbers<p> <sect>Converting sector numbers<p>