<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>get -- get the contents of a file</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_getc.html">next</a> | <a href="_genus_lp__Ring_rp.html">previous</a> | <a href="_getc.html">forward</a> | <a href="_genus_lp__Ring_rp.html">backward</a> | up | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<hr/>
<div><h1>get -- get the contents of a file</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>get f</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>f</tt>, <span>a <a href="___File.html">file</a></span> or <span>a <a href="___String.html">string</a></span>. If <tt>f</tt> is a string, then it is opened, as with <a href="_open__In_lp__String_rp.html" title="open an output file">openIn</a>. Filenames starting with <tt>!</tt> or with <tt>$</tt> are treated specially, see <a href="_open__In__Out.html" title="open an input output file">openInOut</a>.</span></li>
</ul>
</div>
</li>
<li><div class="single">Consequences:<ul><li>In the case where <tt>f</tt> is a file, its input side is closed.</li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span>a string containing the contents of the file. If the file was already open and partially read, the remainder of the contents of the file are returned.</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><table class="examples"><tr><td><pre>i1 : "test-file" << "hi there" << close
o1 = test-file
o1 : File</pre>
</td></tr>
<tr><td><pre>i2 : get "test-file"
o2 = hi there</pre>
</td></tr>
<tr><td><pre>i3 : removeFile "test-file"</pre>
</td></tr>
<tr><td><pre>i4 : get "!date"
o4 = Tue Feb 8 00:11:12 UTC 2011</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_read.html" title="read from a file">read</a> -- read from a file</span></li>
<li><span><a href="_remove__File.html" title="remove a file">removeFile</a> -- remove a file</span></li>
<li><span><a href="_close.html" title="close a file">close</a> -- close a file</span></li>
<li><span><a href="___File_sp_lt_lt_sp__Thing.html" title="print to a file">File << Thing</a> -- print to a file</span></li>
</ul>
</div>
<div class="waystouse"><h2>Ways to use <tt>get</tt> :</h2>
<ul><li>get(File)</li>
<li>get(String)</li>
</ul>
</div>
</div>
</body>
</html>
