php-doc-en/reference/pdf/functions/pdf-open-image-file.xml

51 lines
1.8 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-image-file">
<refnamediv>
<refname>pdf_open_image_file</refname>
<refpurpose>Reads an image from a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_image_file</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>imagetype</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>stringparam</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>intparam</parameter></methodparam>
</methodsynopsis>
<para>
Open an image file. Supported types are <literal>jpeg</literal>,
<literal>tiff</literal>, <literal>gif</literal>, and <literal>png</literal>.
<parameter>stringparam</parameter> is either <literal></literal>,
<literal>mask</literal>, <literal>masked</literal>, or
<literal>page</literal>.
<parameter>intparam</parameter>is either 0, the image id
of the applied mask, or the page.
</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
-->