php-doc-en/reference/fdf/functions/fdf-set-value.xml
Jakub Vrana f803865331 Xmas typos 3/5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146654 c90b9560-bf6c-de11-be94-00142212c4b1
2003-12-17 14:32:39 +00:00

61 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.fdf-set-value">
<refnamediv>
<refname>fdf_set_value</refname>
<refpurpose>Set the value of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>fdf_set_value</methodname>
<methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam>
<methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice='opt'><type>int</type><parameter>isName</parameter></methodparam>
</methodsynopsis>
<para>
The <function>fdf_set_value</function> function sets the
<parameter>value</parameter> for a field named <parameter>fieldname</parameter>.
The <parameter>value</parameter> will be stored as a string unless it is an array.
In this case all array elements will be stored as a value array.
</para>
<note>
<para>
In older versions of the fdf toolkit last parameter determined if the field value
was to be converted to a PDF Name (<parameter>isName</parameter> = 1)
or set to a PDF String (<parameter>isName</parameter> = 0). The value is no
longer used in the current toolkit version 5.0. For compatibility reasons it is
still supported as an optional parameter beginning with PHP 4.3, but ignored internally.
</para>
<para>
Support for <parameter>value</parameter> arrays was added in PHP 4.3.
</para>
</note>
<para>
See also <function>fdf_get_value</function> and
<function>fdf_remove_item</function>.
</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
-->