summaryrefslogtreecommitdiff
path: root/pdf/fpdf/doc/output.htm
diff options
context:
space:
mode:
Diffstat (limited to 'pdf/fpdf/doc/output.htm')
-rw-r--r--[-rwxr-xr-x]pdf/fpdf/doc/output.htm36
1 files changed, 20 insertions, 16 deletions
diff --git a/pdf/fpdf/doc/output.htm b/pdf/fpdf/doc/output.htm
index b62291c..9a905a8 100755..100644
--- a/pdf/fpdf/doc/output.htm
+++ b/pdf/fpdf/doc/output.htm
@@ -7,35 +7,39 @@
</head>
<body>
<h1>Output</h1>
-<code><b>string</b> Output([<b>string</b> name, <b>string</b> dest])</code>
+<code><b>string</b> Output([<b>string</b> dest [, <b>string</b> name [, <b>boolean</b> isUTF8]]])</code>
<h2>Description</h2>
-Send the document to a given destination: browser, file or string. In the case of browser, the
-plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
+Send the document to a given destination: browser, file or string. In the case of a browser, the
+PDF viewer may be used or a download may be forced.
<br>
The method first calls Close() if necessary to terminate the document.
<h2>Parameters</h2>
<dl class="param">
-<dt><code>name</code></dt>
-<dd>
-The name of the file. If not specified, the document will be sent to the browser
-(destination <code>I</code>) with the name <code>doc.pdf</code>.
-</dd>
<dt><code>dest</code></dt>
<dd>
-Destination where to send the document. It can take one of the following values:
+Destination where to send the document. It can be one of the following:
<ul>
-<li><code>I</code>: send the file inline to the browser. The plug-in is used if available.
-The name given by <code>name</code> is used when one selects the "Save as" option on the
-link generating the PDF.</li>
-<li><code>D</code>: send to the browser and force a file download with the name given by
-<code>name</code>.</li>
+<li><code>I</code>: send the file inline to the browser. The PDF viewer is used if available.</li>
+<li><code>D</code>: send to the browser and force a file download with the name given by <code>name</code>.</li>
<li><code>F</code>: save to a local file with the name given by <code>name</code> (may include a path).</li>
-<li><code>S</code>: return the document as a string. <code>name</code> is ignored.</li>
+<li><code>S</code>: return the document as a string.</li>
</ul>
+The default value is <code>I</code>.
+</dd>
+<dt><code>name</code></dt>
+<dd>
+The name of the file. It is ignored in case of destination <code>S</code>.<br>
+The default value is <code>doc.pdf</code>.
+</dd>
+<dt><code>isUTF8</code></dt>
+<dd>
+Indicates if <code>name</code> is encoded in ISO-8859-1 (<code>false</code>) or UTF-8 (<code>true</code>).
+Only used for destinations <code>I</code> and <code>D</code>.<br>
+The default value is <code>false</code>.
</dd>
</dl>
<h2>See also</h2>
-<a href="close.htm">Close()</a>.
+<a href="close.htm">Close</a>
<hr style="margin-top:1.5em">
<div style="text-align:center"><a href="index.htm">Index</a></div>
</body>