File: structmschmc__file.html

package info (click to toggle)
libmspack 0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 3,916 kB
  • sloc: sh: 11,332; ansic: 7,879; perl: 131; makefile: 97
file content (183 lines) | stat: -rw-r--r-- 11,150 bytes parent folder | download | duplicates (3)
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
<!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: mschmc_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&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</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">mschmc_file Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A structure which represents a file to be placed in a CHM helpfile.  
 <a href="structmschmc__file.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="mspack_8h_source.html">mspack.h</a>&gt;</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:a11c5bd77b0142d3c3a94c5a24126e030"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmc__file.html#a11c5bd77b0142d3c3a94c5a24126e030">section</a></td></tr>
<tr class="memdesc:a11c5bd77b0142d3c3a94c5a24126e030"><td class="mdescLeft">&#160;</td><td class="mdescRight">One of <a class="el" href="mspack_8h.html#a80f996d3fbc7800630b9542d5e4620ec" title="mschmc_file::section value: end of CHM file list ">MSCHMC_ENDLIST</a>, <a class="el" href="mspack_8h.html#aa015256b5218d8a85f9be15dac719fa9" title="mschmc_file::section value: this file is in the Uncompressed section ">MSCHMC_UNCOMP</a> or <a class="el" href="mspack_8h.html#aa7b2bc5521ce3004703fd808662017be" title="mschmc_file::section value: this file is in the MSCompressed section ">MSCHMC_MSCOMP</a>.  <a href="#a11c5bd77b0142d3c3a94c5a24126e030">More...</a><br/></td></tr>
<tr class="separator:a11c5bd77b0142d3c3a94c5a24126e030"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60dcb986ab210e9f9674daaa813c6ca6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmc__file.html#a60dcb986ab210e9f9674daaa813c6ca6">filename</a></td></tr>
<tr class="memdesc:a60dcb986ab210e9f9674daaa813c6ca6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The filename of the source file that will be added to the CHM.  <a href="#a60dcb986ab210e9f9674daaa813c6ca6">More...</a><br/></td></tr>
<tr class="separator:a60dcb986ab210e9f9674daaa813c6ca6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2979483302579db0111fe5cff3d4eb5"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmc__file.html#ab2979483302579db0111fe5cff3d4eb5">chm_filename</a></td></tr>
<tr class="memdesc:ab2979483302579db0111fe5cff3d4eb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The full path and filename of the file within the CHM helpfile, a UTF-1 encoded null-terminated string.  <a href="#ab2979483302579db0111fe5cff3d4eb5">More...</a><br/></td></tr>
<tr class="separator:ab2979483302579db0111fe5cff3d4eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee5c029845e1ce6112c8d050d9b23fda"><td class="memItemLeft" align="right" valign="top">off_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmschmc__file.html#aee5c029845e1ce6112c8d050d9b23fda">length</a></td></tr>
<tr class="memdesc:aee5c029845e1ce6112c8d050d9b23fda"><td class="mdescLeft">&#160;</td><td class="mdescRight">The length of the file, in bytes.  <a href="#aee5c029845e1ce6112c8d050d9b23fda">More...</a><br/></td></tr>
<tr class="separator:aee5c029845e1ce6112c8d050d9b23fda"><td class="memSeparator" colspan="2">&#160;</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 to be placed in a CHM helpfile. </p>
<p>A contiguous array of these structures should be passed to <a class="el" href="structmschm__compressor.html#a1d2f3746c1573c1bc174bf6caca77312" title="Generates a CHM help file. ">mschm_compressor::generate()</a>. The array list is terminated with an entry whose <a class="el" href="structmschmc__file.html#a11c5bd77b0142d3c3a94c5a24126e030" title="One of MSCHMC_ENDLIST, MSCHMC_UNCOMP or MSCHMC_MSCOMP. ">mschmc_file::section</a> field is set to <a class="el" href="mspack_8h.html#a80f996d3fbc7800630b9542d5e4620ec" title="mschmc_file::section value: end of CHM file list ">MSCHMC_ENDLIST</a>, the other fields in this entry are ignored. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ab2979483302579db0111fe5cff3d4eb5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* mschmc_file::chm_filename</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The full path and filename of the file within the CHM helpfile, a UTF-1 encoded null-terminated string. </p>

</div>
</div>
<a class="anchor" id="a60dcb986ab210e9f9674daaa813c6ca6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* mschmc_file::filename</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The filename of the source file that will be added to the CHM. </p>
<p>This is passed directly to <a class="el" href="structmspack__system.html#a1a85cac5eeb55db6a432fe3824aa04a3" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>. </p>

</div>
</div>
<a class="anchor" id="aee5c029845e1ce6112c8d050d9b23fda"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">off_t mschmc_file::length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The length of the file, in bytes. </p>
<p>This will be adhered to strictly and a read error will be issued if this many bytes cannot be read from the real file at CHM generation time. </p>

</div>
</div>
<a class="anchor" id="a11c5bd77b0142d3c3a94c5a24126e030"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mschmc_file::section</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>One of <a class="el" href="mspack_8h.html#a80f996d3fbc7800630b9542d5e4620ec" title="mschmc_file::section value: end of CHM file list ">MSCHMC_ENDLIST</a>, <a class="el" href="mspack_8h.html#aa015256b5218d8a85f9be15dac719fa9" title="mschmc_file::section value: this file is in the Uncompressed section ">MSCHMC_UNCOMP</a> or <a class="el" href="mspack_8h.html#aa7b2bc5521ce3004703fd808662017be" title="mschmc_file::section value: this file is in the MSCompressed section ">MSCHMC_MSCOMP</a>. </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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>