reference/filesystem/functions/readlink.xml
0c9c2dd669fe9395eaa73d487fbd160f9057429a
...
...
@@ -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.readlink">
3
+
<refentry xml:id="function.readlink" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>readlink</refname>
6
6
<refpurpose>Returns the target of a symbolic link</refpurpose>
...
...
@@ -9,7 +9,7 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>readlink</methodname>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>readlink</methodname>
13
13
<methodparam><type>string</type><parameter>path</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
...
...
@@ -33,36 +33,17 @@
33
33
</para>
34
34
</refsect1>
35
35

36
-
<refsect1 role="changelog">
37
-
&reftitle.changelog;
38
-
<para>
39
-
<informaltable>
40
-
<tgroup cols="2">
41
-
<thead>
42
-
<row>
43
-
<entry>&Version;</entry>
44
-
<entry>&Description;</entry>
45
-
</row>
46
-
</thead>
47
-
<tbody>
48
-
<row>
49
-
<entry>5.3.0</entry>
50
-
<entry>
51
-
This function is now available on Windows platforms (Vista, Server
52
-
2008 or greater).
53
-
</entry>
54
-
</row>
55
-
</tbody>
56
-
</tgroup>
57
-
</informaltable>
58
-
</para>
59
-
</refsect1>
60
-

61
36
<refsect1 role="returnvalues">
62
37
&reftitle.returnvalues;
63
38
<para>
64
39
Returns the contents of the symbolic link path or &false; on error.
65
40
</para>
41
+
<note>
42
+
<simpara>
43
+
The function fails if <parameter>path</parameter> is not a symlink,
44
+
except on Windows, where the normalized path will be returned.
45
+
</simpara>
46
+
</note>
66
47
</refsect1>
67
48

68
49
<refsect1 role="examples">
...
...
@@ -96,7 +77,6 @@ echo readlink('/vmlinuz');
96
77
</refsect1>
97
78

98
79
</refentry>
99
-

100
80
<!-- Keep this comment at the end of the file
101
81
Local variables:
102
82
mode: sgml
103
83