<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libmspack
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 <<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:a11c5bd77b0142d3c3a94c5a24126e030"><td class="memItemLeft" align="right" valign="top">int </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"> </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"> </td></tr>
<tr class="memitem:a60dcb986ab210e9f9674daaa813c6ca6"><td class="memItemLeft" align="right" valign="top">const char * </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"> </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"> </td></tr>
<tr class="memitem:ab2979483302579db0111fe5cff3d4eb5"><td class="memItemLeft" align="right" valign="top">char * </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"> </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"> </td></tr>
<tr class="memitem:aee5c029845e1ce6112c8d050d9b23fda"><td class="memItemLeft" align="right" valign="top">off_t </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"> </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"> </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#adee7fe634e4745b010bd8f71ad7777b0" 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 id="ab2979483302579db0111fe5cff3d4eb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2979483302579db0111fe5cff3d4eb5">◆ </a></span>chm_filename</h2>
<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 id="a60dcb986ab210e9f9674daaa813c6ca6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60dcb986ab210e9f9674daaa813c6ca6">◆ </a></span>filename</h2>
<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#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">mspack_system::open()</a>. </p>
</div>
</div>
<a id="aee5c029845e1ce6112c8d050d9b23fda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee5c029845e1ce6112c8d050d9b23fda">◆ </a></span>length</h2>
<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 id="a11c5bd77b0142d3c3a94c5a24126e030"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11c5bd77b0142d3c3a94c5a24126e030">◆ </a></span>section</h2>
<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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
5e58c3b49fd1e75d37317298900a6262
>
files
>
140
