File: fdf-set-value.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (61 lines) | stat: -rw-r--r-- 2,163 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?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
-->