php-doc-en/reference/cpdf/functions/cpdf-global-set-document-limits.xml
Mehdi Achour 5025f5fb34 cpdf: Switch to new style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@226968 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-11 00:17:19 +00:00

106 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<refentry id="function.cpdf-global-set-document-limits">
<refnamediv>
<refname>cpdf_global_set_document_limits</refname>
<refpurpose>Sets document limits for any pdf document</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>cpdf_global_set_document_limits</methodname>
<methodparam><type>int</type><parameter>maxpages</parameter></methodparam>
<methodparam><type>int</type><parameter>maxfonts</parameter></methodparam>
<methodparam><type>int</type><parameter>maximages</parameter></methodparam>
<methodparam><type>int</type><parameter>maxannotations</parameter></methodparam>
<methodparam><type>int</type><parameter>maxobjects</parameter></methodparam>
</methodsynopsis>
<para>
Sets several document limits. This function has to be called before
<function>cpdf_open</function> to take effect. It sets the limits for any
document open afterwards.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>maxPages</parameter></term>
<listitem>
<para>
The maximum number of pages
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>maxFonts</parameter></term>
<listitem>
<para>
The maximum number of fonts
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>maxImages</parameter></term>
<listitem>
<para>
The maximum number of images
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>maxAnnots</parameter></term>
<listitem>
<para>
The maximum number of annotations
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>maxObjects</parameter></term>
<listitem>
<para>
The maximum number of objects
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cpdf_open</function></member>
</simplelist>
</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
-->