<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libburn: burn_progress Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div> <div class="contents"> <h1>burn_progress Struct Reference</h1><!-- doxytag: class="burn_progress" --> <p>Operation progress report. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="libburn_8h_source.html">libburn.h</a>></code></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Data Fields</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a7f150e04854b94b2b4fe3359e4602afa">sessions</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The total number of sessions. <a href="#a7f150e04854b94b2b4fe3359e4602afa"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a300edce46c85bcf322b96291f7da87dc">session</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Current session. <a href="#a300edce46c85bcf322b96291f7da87dc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a711f38142a4a1ed9055efb071c3cfe1c">tracks</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The total number of tracks. <a href="#a711f38142a4a1ed9055efb071c3cfe1c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a93666a25e6d3611f9384e89fe2a2f65e">track</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Current track. <a href="#a93666a25e6d3611f9384e89fe2a2f65e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a8f46cf5a172d4247c64cc34cad385f46">indices</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The total number of indices. <a href="#a8f46cf5a172d4247c64cc34cad385f46"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a0d554fe904153e1ca49210a9d64bba92">index</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Curent index. <a href="#a0d554fe904153e1ca49210a9d64bba92"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a5fae8dc29160c2d8cd50e7ec350a331d">start_sector</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The starting logical block address. <a href="#a5fae8dc29160c2d8cd50e7ec350a331d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#af093a66f1ae097ba40eeac7e1c6ac5d9">sectors</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">On write: The number of sectors. <a href="#af093a66f1ae097ba40eeac7e1c6ac5d9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a7aa74bd989075ae02a5066003874c60d">sector</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">On write: The current sector being processed. <a href="#a7aa74bd989075ae02a5066003874c60d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a6b2690b3662cf6ebd3521fb49c307f83">buffer_capacity</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The capacity of the drive buffer. <a href="#a6b2690b3662cf6ebd3521fb49c307f83"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#acecdd45782b86ecec914dc2444f1f7c8">buffer_available</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The free space in the drive buffer (might be slightly outdated). <a href="#acecdd45782b86ecec914dc2444f1f7c8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a046f511fc686d836df5deeaddcd5c54a">buffered_bytes</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of bytes sent to the drive buffer. <a href="#a046f511fc686d836df5deeaddcd5c54a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structburn__progress.html#a47657c55d8b25e7f75341abfec045dba">buffer_min_fill</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The minimum number of bytes stored in buffer during write. <a href="#a47657c55d8b25e7f75341abfec045dba"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Operation progress report. </p> <p>All values are 0 based indices. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00596">596</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> <hr/><h2>Field Documentation</h2> <a class="anchor" id="acecdd45782b86ecec914dc2444f1f7c8"></a><!-- doxytag: member="burn_progress::buffer_available" ref="acecdd45782b86ecec914dc2444f1f7c8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned <a class="el" href="structburn__progress.html#acecdd45782b86ecec914dc2444f1f7c8">burn_progress::buffer_available</a></td> </tr> </table> </div> <div class="memdoc"> <p>The free space in the drive buffer (might be slightly outdated). </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00623">623</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a6b2690b3662cf6ebd3521fb49c307f83"></a><!-- doxytag: member="burn_progress::buffer_capacity" ref="a6b2690b3662cf6ebd3521fb49c307f83" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned <a class="el" href="structburn__progress.html#a6b2690b3662cf6ebd3521fb49c307f83">burn_progress::buffer_capacity</a></td> </tr> </table> </div> <div class="memdoc"> <p>The capacity of the drive buffer. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00621">621</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a47657c55d8b25e7f75341abfec045dba"></a><!-- doxytag: member="burn_progress::buffer_min_fill" ref="a47657c55d8b25e7f75341abfec045dba" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned <a class="el" href="structburn__progress.html#a47657c55d8b25e7f75341abfec045dba">burn_progress::buffer_min_fill</a></td> </tr> </table> </div> <div class="memdoc"> <p>The minimum number of bytes stored in buffer during write. </p> <p>(Caution: Before surely one buffer size of bytes was processed, this value is 0xffffffff.) </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00633">633</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a046f511fc686d836df5deeaddcd5c54a"></a><!-- doxytag: member="burn_progress::buffered_bytes" ref="a046f511fc686d836df5deeaddcd5c54a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">off_t <a class="el" href="structburn__progress.html#a046f511fc686d836df5deeaddcd5c54a">burn_progress::buffered_bytes</a></td> </tr> </table> </div> <div class="memdoc"> <p>The number of bytes sent to the drive buffer. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00628">628</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a0d554fe904153e1ca49210a9d64bba92"></a><!-- doxytag: member="burn_progress::index" ref="a0d554fe904153e1ca49210a9d64bba92" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a0d554fe904153e1ca49210a9d64bba92">burn_progress::index</a></td> </tr> </table> </div> <div class="memdoc"> <p>Curent index. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00608">608</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a8f46cf5a172d4247c64cc34cad385f46"></a><!-- doxytag: member="burn_progress::indices" ref="a8f46cf5a172d4247c64cc34cad385f46" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a8f46cf5a172d4247c64cc34cad385f46">burn_progress::indices</a></td> </tr> </table> </div> <div class="memdoc"> <p>The total number of indices. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00606">606</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a7aa74bd989075ae02a5066003874c60d"></a><!-- doxytag: member="burn_progress::sector" ref="a7aa74bd989075ae02a5066003874c60d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a7aa74bd989075ae02a5066003874c60d">burn_progress::sector</a></td> </tr> </table> </div> <div class="memdoc"> <p>On write: The current sector being processed. </p> <p>On blank: Relative progress steps 0 to 0x10000 </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00616">616</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> <p>Referenced by <a class="el" href="libburner_8c_source.html#l00271">libburner_blank_disc()</a>, <a class="el" href="libburner_8c_source.html#l00331">libburner_format()</a>, and <a class="el" href="libburner_8c_source.html#l00407">libburner_payload()</a>.</p> </div> </div> <a class="anchor" id="af093a66f1ae097ba40eeac7e1c6ac5d9"></a><!-- doxytag: member="burn_progress::sectors" ref="af093a66f1ae097ba40eeac7e1c6ac5d9" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#af093a66f1ae097ba40eeac7e1c6ac5d9">burn_progress::sectors</a></td> </tr> </table> </div> <div class="memdoc"> <p>On write: The number of sectors. </p> <p>On blank: 0x10000 as upper limit for relative progress steps </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00613">613</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> <p>Referenced by <a class="el" href="libburner_8c_source.html#l00271">libburner_blank_disc()</a>, <a class="el" href="libburner_8c_source.html#l00331">libburner_format()</a>, and <a class="el" href="libburner_8c_source.html#l00407">libburner_payload()</a>.</p> </div> </div> <a class="anchor" id="a300edce46c85bcf322b96291f7da87dc"></a><!-- doxytag: member="burn_progress::session" ref="a300edce46c85bcf322b96291f7da87dc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a300edce46c85bcf322b96291f7da87dc">burn_progress::session</a></td> </tr> </table> </div> <div class="memdoc"> <p>Current session. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00600">600</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a7f150e04854b94b2b4fe3359e4602afa"></a><!-- doxytag: member="burn_progress::sessions" ref="a7f150e04854b94b2b4fe3359e4602afa" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a7f150e04854b94b2b4fe3359e4602afa">burn_progress::sessions</a></td> </tr> </table> </div> <div class="memdoc"> <p>The total number of sessions. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00598">598</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a5fae8dc29160c2d8cd50e7ec350a331d"></a><!-- doxytag: member="burn_progress::start_sector" ref="a5fae8dc29160c2d8cd50e7ec350a331d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a5fae8dc29160c2d8cd50e7ec350a331d">burn_progress::start_sector</a></td> </tr> </table> </div> <div class="memdoc"> <p>The starting logical block address. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00610">610</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <a class="anchor" id="a93666a25e6d3611f9384e89fe2a2f65e"></a><!-- doxytag: member="burn_progress::track" ref="a93666a25e6d3611f9384e89fe2a2f65e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a93666a25e6d3611f9384e89fe2a2f65e">burn_progress::track</a></td> </tr> </table> </div> <div class="memdoc"> <p>Current track. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00604">604</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> <p>Referenced by <a class="el" href="libburner_8c_source.html#l00407">libburner_payload()</a>.</p> </div> </div> <a class="anchor" id="a711f38142a4a1ed9055efb071c3cfe1c"></a><!-- doxytag: member="burn_progress::tracks" ref="a711f38142a4a1ed9055efb071c3cfe1c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structburn__progress.html#a711f38142a4a1ed9055efb071c3cfe1c">burn_progress::tracks</a></td> </tr> </table> </div> <div class="memdoc"> <p>The total number of tracks. </p> <p>Definition at line <a class="el" href="libburn_8h_source.html#l00602">602</a> of file <a class="el" href="libburn_8h_source.html">libburn.h</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="libburn_8h_source.html">libburn.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on 30 Sep 2009 for libburn by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>