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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 -->
<refentry id="function.cpdf-open">
<refnamediv>
<refname>cpdf_open</refname>
<refpurpose>Opens a new pdf document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>cpdf_open</methodname>
<methodparam><type>int</type><parameter>compression</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>doc_limits</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cpdf_open</function> function opens
a new pdf document. The first parameter turns document compression
on if it is unequal to 0. The second optional parameter sets the
file in which the document is written. If it is omitted the document
is created in memory and can either be written into a file with
the <function>cpdf_save_to_file</function> or written to standard
output with <function>cpdf_output_buffer</function>.
<note>
<simpara>
The return value will be needed in further versions of ClibPDF
as the first parameter in all other functions which are writing
to the pdf document.
</simpara>
<simpara>
The ClibPDF library takes the filename "-" as a synonym for
stdout. If PHP is compiled as an apache module this will not
work because the way ClibPDF outputs to stdout does not work
with apache. You can solve this problem by skipping the
filename and using <function>cpdf_output_buffer</function> to
output the pdf document.
</simpara>
</note>
</para>
<para>
See also <function>cpdf_close</function> and
<function>cpdf_output_buffer</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
