1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>libmspack: mschmd_file Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libmspack
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">mschmd_file Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A structure which represents a file stored in a CHM helpfile.
<a href="structmschmd__file.html#details">More...</a></p>
<p><code>#include <<a class="el" href="mspack_8h_source.html">mspack.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aacdeb0d33c01266beb36e0b48af09055"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmschmd__file.html">mschmd_file</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmd__file.html#aacdeb0d33c01266beb36e0b48af09055">next</a></td></tr>
<tr class="memdesc:aacdeb0d33c01266beb36e0b48af09055"><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the next file in the list, or NULL if this is the final file. <a href="#aacdeb0d33c01266beb36e0b48af09055">More...</a><br/></td></tr>
<tr class="separator:aacdeb0d33c01266beb36e0b48af09055"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8c413e3759fae57732a09e7060c1225"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmschmd__section.html">mschmd_section</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmd__file.html#ab8c413e3759fae57732a09e7060c1225">section</a></td></tr>
<tr class="memdesc:ab8c413e3759fae57732a09e7060c1225"><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the section that this file is located in. <a href="#ab8c413e3759fae57732a09e7060c1225">More...</a><br/></td></tr>
<tr class="separator:ab8c413e3759fae57732a09e7060c1225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad085b530903f47a4d908d04ce0a37499"><td class="memItemLeft" align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmd__file.html#ad085b530903f47a4d908d04ce0a37499">offset</a></td></tr>
<tr class="memdesc:ad085b530903f47a4d908d04ce0a37499"><td class="mdescLeft"> </td><td class="mdescRight">The offset within the section data that this file is located at. <a href="#ad085b530903f47a4d908d04ce0a37499">More...</a><br/></td></tr>
<tr class="separator:ad085b530903f47a4d908d04ce0a37499"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95fd0339c2cca86fe152924ac1777521"><td class="memItemLeft" align="right" valign="top">off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmd__file.html#a95fd0339c2cca86fe152924ac1777521">length</a></td></tr>
<tr class="memdesc:a95fd0339c2cca86fe152924ac1777521"><td class="mdescLeft"> </td><td class="mdescRight">The length of this file, in bytes. <a href="#a95fd0339c2cca86fe152924ac1777521">More...</a><br/></td></tr>
<tr class="separator:a95fd0339c2cca86fe152924ac1777521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80b7f519909795b2cfe0cc7baf6d4e30"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmd__file.html#a80b7f519909795b2cfe0cc7baf6d4e30">filename</a></td></tr>
<tr class="memdesc:a80b7f519909795b2cfe0cc7baf6d4e30"><td class="mdescLeft"> </td><td class="mdescRight">The filename of this file – a null terminated string in UTF-8. <a href="#a80b7f519909795b2cfe0cc7baf6d4e30">More...</a><br/></td></tr>
<tr class="separator:a80b7f519909795b2cfe0cc7baf6d4e30"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A structure which represents a file stored in a CHM helpfile. </p>
<p>All fields are READ ONLY. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a80b7f519909795b2cfe0cc7baf6d4e30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* mschmd_file::filename</td>
</tr>
</table>
</div><div class="memdoc">
<p>The filename of this file – a null terminated string in UTF-8. </p>
</div>
</div>
<a class="anchor" id="a95fd0339c2cca86fe152924ac1777521"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">off_t mschmd_file::length</td>
</tr>
</table>
</div><div class="memdoc">
<p>The length of this file, in bytes. </p>
</div>
</div>
<a class="anchor" id="aacdeb0d33c01266beb36e0b48af09055"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmschmd__file.html">mschmd_file</a>* mschmd_file::next</td>
</tr>
</table>
</div><div class="memdoc">
<p>A pointer to the next file in the list, or NULL if this is the final file. </p>
</div>
</div>
<a class="anchor" id="ad085b530903f47a4d908d04ce0a37499"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">off_t mschmd_file::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>The offset within the section data that this file is located at. </p>
</div>
</div>
<a class="anchor" id="ab8c413e3759fae57732a09e7060c1225"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structmschmd__section.html">mschmd_section</a>* mschmd_file::section</td>
</tr>
</table>
</div><div class="memdoc">
<p>A pointer to the section that this file is located in. </p>
<p>Indirectly, it also points to the CHM helpfile the file is located in. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mspack_8h_source.html">mspack.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|