reference/strings/functions/convert-uuencode.xml
e095023e408c8cb6378ae16bb6870343a3946919
e095023e408c8cb6378ae16bb6870343a3946919
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.convert-uuencode">
3
+
<refentry xml:id="function.convert-uuencode" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>convert_uuencode</refname>
6
6
<refpurpose>Uuencode a string</refpurpose>
...
...
@@ -10,7 +10,7 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>string</type><methodname>convert_uuencode</methodname>
13
-
<methodparam><type>string</type><parameter>data</parameter></methodparam>
13
+
<methodparam><type>string</type><parameter>string</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>convert_uuencode</function> encodes a string using the uuencode
...
...
@@ -21,6 +21,12 @@
21
21
characters, making them safe for network transmissions. Uuencoded data is
22
22
about 35% larger than the original.
23
23
</para>
24
+
<note>
25
+
<simpara>
26
+
<function>convert_uuencode</function> neither produces the <literal>begin</literal>
27
+
nor the <literal>end</literal> line, which are part of uuencoded <emphasis>files</emphasis>.
28
+
</simpara>
29
+
</note>
24
30
</refsect1>
25
31
26
32
<refsect1 role="parameters">
...
...
@@ -28,7 +34,7 @@
28
34
<para>
29
35
<variablelist>
30
36
<varlistentry>
31
-
<term><parameter>data</parameter></term>
37
+
<term><parameter>string</parameter></term>
32
38
<listitem>
33
39
<para>
34
40
The data to be encoded.
...
...
@@ -42,10 +48,33 @@
42
48
<refsect1 role="returnvalues">
43
49
&reftitle.returnvalues;
44
50
<para>
45
-
Returns the uuencoded data &return.falseforfailure;.
51
+
Returns the uuencoded data.
46
52
</para>
47
53
</refsect1>
48
54
55
+
<refsect1 role="changelog">
56
+
&reftitle.changelog;
57
+
<informaltable>
58
+
<tgroup cols="2">
59
+
<thead>
60
+
<row>
61
+
<entry>&Version;</entry>
62
+
<entry>&Description;</entry>
63
+
</row>
64
+
</thead>
65
+
<tbody>
66
+
<row>
67
+
<entry>8.0.0</entry>
68
+
<entry>
69
+
Prior to this version, trying to convert an empty string returned &false;
70
+
for no particular reason.
71
+
</entry>
72
+
</row>
73
+
</tbody>
74
+
</tgroup>
75
+
</informaltable>
76
+
</refsect1>
77
+
49
78
<refsect1 role="examples">
50
79
&reftitle.examples;
51
80
<para>
...
...
@@ -60,6 +89,13 @@ echo convert_uuencode($some_string);
60
89
?>
61
90
]]>
62
91
</programlisting>
92
+
&example.outputs;
93
+
<screen>
94
+
<![CDATA[
95
+
0=&5S=`IT97AT('1E>'0-"@``
96
+
`
97
+
]]>
98
+
</screen>
63
99
</example>
64
100
</para>
65
101
</refsect1>
...
...
@@ -75,7 +111,6 @@ echo convert_uuencode($some_string);
75
111
</refsect1>
76
112
77
113
</refentry>
78
-
79
114
<!-- Keep this comment at the end of the file
80
115
Local variables:
81
116
mode: sgml
82
117