mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
108 lines
3.0 KiB
XML
108 lines
3.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fdf-set-value">
|
|
<refnamediv>
|
|
<refname>fdf_set_value</refname>
|
|
<refpurpose>Set the value of a field</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
<simpara>
|
|
Sets the <parameter>value</parameter> for the given field.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>fdf_document</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
The FDF document handle, returned by <function>fdf_create</function>,
|
|
<function>fdf_open</function> or <function>fdf_open_string</function>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>fieldname</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
Name of the FDF field, as a string.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<simpara>
|
|
This 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.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>isName</parameter></term>
|
|
<listitem>
|
|
<note>
|
|
<simpara>
|
|
In older versions of the FDF toolkit last parameter determined if the
|
|
field value was to be converted to a PDF Name (= 1) or set to a PDF
|
|
String (= 0).
|
|
</simpara>
|
|
<simpara>
|
|
The value is no longer used in the current toolkit version 5.0. For
|
|
compatibility reasons it is still supported as an optional parameter,
|
|
but ignored internally.
|
|
</simpara>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<simpara>
|
|
&return.success;
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>fdf_get_value</function></member>
|
|
<member><function>fdf_remove_item</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|