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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="collator.geterrormessage" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Collator::getErrorMessage</refname>
<refname>collator_get_error_message</refname>
<refpurpose>Get text for collator's last error code</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
Object oriented style
</para>
<methodsynopsis>
<type>string</type>
<methodname>Collator::getErrorMessage</methodname>
<void />
</methodsynopsis>
<para>
Procedural style
</para>
<methodsynopsis>
<type>string</type>
<methodname>collator_get_error_message</methodname>
<methodparam><type>Collator</type><parameter>coll</parameter></methodparam>
</methodsynopsis>
<para>
Retrieves the message for the last error.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>coll</parameter></term>
<listitem>
<para>
<classname>Collator</classname> object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Description of an error occurred in the last Collator <acronym>API</acronym> function call.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>collator_get_error_message</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$coll = collator_create( 'lt' );
if( collator_compare( $coll, 'y', 'k' ) === false ) {
echo collator_get_error_message( $coll );
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>collator_get_error_code</function></member>
</simplelist>
</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
-->
|
