194 lines
10 KiB
HTML
194 lines
10 KiB
HTML
<!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.7"/>
|
|
<title>post quantum cryptography: /home/travis/build/hasufell/pqc/src/ntru_file.h File 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">post quantum cryptography
|
|
</div>
|
|
<div id="projectbrief">Highly optimized implementation of the NTRUEncrypt algorithm</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.7 -->
|
|
<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><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ntru_file.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>header for <a class="el" href="ntru__file_8c.html" title="file operations ">ntru_file.c</a>
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="ntru__common_8h_source.html">ntru_common.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="ntru__string_8h_source.html">ntru_string.h</a>"</code><br />
|
|
<code>#include <stdbool.h></code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for ntru_file.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="ntru__file_8h__incl.png" border="0" usemap="#_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__file_8h" alt=""/></div>
|
|
<map name="_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__file_8h" id="_2home_2travis_2build_2hasufell_2pqc_2src_2ntru__file_8h">
|
|
<area shape="rect" id="node3" href="ntru__common_8h.html" title="common macros/functions " alt="" coords="5,117,117,147"/><area shape="rect" id="node7" href="ntru__string_8h.html" title="header for ntru_string.c " alt="" coords="141,117,235,147"/></map>
|
|
</div>
|
|
</div>
|
|
<p><a href="ntru__file_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a348c2a56837571f410d44631abc09dc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structstring.html">string</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__file_8h.html#a348c2a56837571f410d44631abc09dc4">read_file</a> (char const *const filename)</td></tr>
|
|
<tr class="separator:a348c2a56837571f410d44631abc09dc4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f8eef5ea12c77ed2491d96864eb0d43"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="ntru__file_8h.html#a1f8eef5ea12c77ed2491d96864eb0d43">write_file</a> (<a class="el" href="structstring.html">string</a> const *wstring, char const *const filename)</td></tr>
|
|
<tr class="separator:a1f8eef5ea12c77ed2491d96864eb0d43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>header for <a class="el" href="ntru__file_8c.html" title="file operations ">ntru_file.c</a> </p>
|
|
<p>Header for the external API of <a class="el" href="ntru__file_8c.html" title="file operations ">ntru_file.c</a>. </p>
|
|
|
|
<p>Definition in file <a class="el" href="ntru__file_8h_source.html">ntru_file.h</a>.</p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="a348c2a56837571f410d44631abc09dc4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structstring.html">string</a>* read_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char const *const </td>
|
|
<td class="paramname"><em>filename</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Reads a file and returns a newly allocated string.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>file to open </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a newly allocated string which must be freed by the caller or NULL on failure (e.g. if the file could not be opened/closed) </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="ntru__file_8c_source.html#l00050">50</a> of file <a class="el" href="ntru__file_8c_source.html">ntru_file.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1f8eef5ea12c77ed2491d96864eb0d43"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool write_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structstring.html">string</a> const * </td>
|
|
<td class="paramname"><em>wstring</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char const *const </td>
|
|
<td class="paramname"><em>filename</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write a string to a file. The file will be pruned or created if it does not exist.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">wstring</td><td>the string to write to the file </td></tr>
|
|
<tr><td class="paramname">filename</td><td>the name of the file to write to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true for success or false for failure if fopen or fclose failed </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="ntru__file_8c_source.html#l00107">107</a> of file <a class="el" href="ntru__file_8c_source.html">ntru_file.c</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Sun Jun 8 2014 23:33:23 for post quantum cryptography by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|