<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.getimageproperties">
 <refnamediv>
  <refname>Imagick::getImageProperties</refname>
  <refpurpose>Returns the image properties</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>Imagick::getImageProperties</methodname>
   <methodparam choice="opt"><type>string</type><parameter>pattern</parameter><initializer>"*"</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>include_values</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>

  <para>
   Returns all associated properties that match the pattern. If &false; is passed as second parameter
   only the property names are returned. &imagick.method.available.0x636;
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pattern</parameter></term>
     <listitem>
      <para>
      The pattern for property names.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>include_values</parameter></term>
     <listitem>
      <para>
      Whether to return only property names. If &false; then only property names will be returned.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
  Returns an array containing the image properties or property names.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Using <function>Imagick::getImageProperties</function>:</title>
    <para>
     An example of extracting EXIF information.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

/* Create the object */
$im = new imagick("/path/to/example.jpg");

/* Get the EXIF information */
$exifArray = $im->getImageProperties("exif:*");

/* Loop trough the EXIF properties */
foreach ($exifArray as $name => $property)
{
    echo "{$name} => {$property}<br />\n"; 
}

?>
]]>
    </programlisting>
   </example>
  </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:"~/.phpdoc/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
-->
