<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domnode.c14nfile" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DOMNode::C14NFile</refname>
  <refpurpose>Canonicalize nodes to a file</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMNode">
   <modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>DOMNode::C14NFile</methodname>
   <methodparam><type>string</type><parameter>uri</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>exclusive</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>withComments</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>xpath</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>nsPrefixes</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Canonicalize nodes to a file.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>uri</parameter></term>
    <listitem>
     <para>
      Path to write the output to.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>exclusive</parameter></term>
    <listitem>
     <para>
      Enable exclusive parsing of only the nodes matched by the provided
      xpath or namespace prefixes.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>withComments</parameter></term>
    <listitem>
     <para>
      Retain comments in output.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>xpath</parameter></term>
    <listitem>
     <para>
      An array of <literal>xpath</literal>s to filter the nodes by.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>nsPrefixes</parameter></term>
    <listitem>
     <para>
      An array of namespace prefixes to filter the nodes by.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Number of bytes written&return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMNode::C14N</methodname></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:"~/.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
-->
