File: pdf-open-image-file.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (52 lines) | stat: -rw-r--r-- 1,938 bytes parent folder | download
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- 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><type>string</type><parameter>stringparam</parameter></methodparam>
      <methodparam><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 empty,
      <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.
      Parameters <parameter>stringparam</parameter> and
      <parameter>intparam</parameter> were optional before PHP 5.
    </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
-->