php-doc-en/reference/fdf/functions/fdf-open-string.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.fdf-open-string" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fdf_open_string</refname>
  <refpurpose>Read a FDF document from a string</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>fdf_open_string</methodname>
   <methodparam><type>string</type><parameter>fdf_data</parameter></methodparam>
  </methodsynopsis>
  <para>
   Reads form data from a string. 
  </para>
  <para>
   You can use <function>fdf_open_string</function> together with
   <varname>$HTTP_FDF_DATA</varname> to process FDF form input from a remote
   client.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>fdf_data</parameter></term>
     <listitem>
      <para>
       The data as returned from a PDF form or created using 
       <function>fdf_create</function> and 
       <function>fdf_save_string</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a FDF document handle, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Accessing the form data</title>
    <programlisting role="php">
<![CDATA[
<?php
$fdf = fdf_open_string($HTTP_FDF_DATA);
/* ... */
fdf_close($fdf);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fdf_open</function></member>
    <member><function>fdf_close</function></member>
    <member><function>fdf_create</function></member>
    <member><function>fdf_save_string</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
-->