← Back to branch summary

~ubuntu-branches/ubuntu/wily/libuser/wily

« back to all changes in this revision

Viewing changes to docs/reference/xml/error.xml

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Habouzit
  • Date: 2006-09-03 21:58:15 UTC
  • mto: (2.1.1 edgy) (1.1.5 upstream) (3.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20060903215815-rtvvfzhaer8ymyp4
Tags: upstream-0.54.6-2.1.dfsg.1
Import upstream version 0.54.6-2.1.dfsg.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/error.xml
1
1
<refentry id="libuser-error">
2
2
<refmeta>
3
 
<refentrytitle>error</refentrytitle>
 
3
<refentrytitle id="top_of_page">error</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>LIBUSER Library</refmiscinfo>
6
6
</refmeta>
7
7
 
8
8
<refnamediv>
9
 
<refname>error</refname><refpurpose>Functions for allocating and manipulating <link linkend="lu-error"><type>lu_error</type></link> structures.</refpurpose>
 
9
<refname>error</refname>
 
10
<refpurpose>Functions for allocating and manipulating <link linkend="lu-error"><type>lu_error</type></link> structures.</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
10
12
</refnamediv>
11
13
 
12
 
<refsynopsisdiv><title>Synopsis</title>
 
14
<refsynopsisdiv id="synopsis">
 
15
<title id="synopsis.title">Synopsis</title>
13
16
 
14
17
<synopsis>
15
18
 
36
39
 
37
40
 
38
41
 
39
 
<refsect1>
40
 
<title>Description</title>
 
42
<refsect1 id="desc">
 
43
<title id="desc.title">Description</title>
41
44
<para>
42
45
<filename>error.h</filename> includes declarations for allocating and
43
46
manipulating <link linkend="lu-error"><type>lu_error</type></link> structures.  These structures hold error and status
47
50
<para>
48
51
A struct <link linkend="lu-error"><type>lu_error</type></link> contains an error code and a human-readable, possibly
49
52
translated error string.  The error string is using the encoding specified
50
 
by <literal>LC_CTYPE</literal> locale category.
 
53
by <link linkend="LC-CTYPE:CAPS"><literal>LC_CTYPE</literal></link> locale category.
51
54
</para>
52
55
</refsect1>
53
56
 
54
 
<refsect1>
55
 
<title>Details</title>
 
57
<refsect1 id="details">
 
58
<title id="details.title">Details</title>
56
59
<refsect2>
57
 
<title><anchor id="LU-ERROR-CHECK:CAPS"/>LU_ERROR_CHECK()</title>
 
60
<title><anchor id="LU-ERROR-CHECK:CAPS" role="macro"/>LU_ERROR_CHECK()</title>
58
61
<indexterm><primary>LU_ERROR_CHECK</primary></indexterm><programlisting>#define     LU_ERROR_CHECK(err_p_p)</programlisting>
59
62
<para>
60
63
Checks that the given pointer to a pointer to a struct does not already point
68
71
</simpara></listitem></varlistentry>
69
72
</variablelist></refsect2>
70
73
<refsect2>
71
 
<title><anchor id="lu-error-new"/>lu_error_new ()</title>
 
74
<title><anchor id="lu-error-new" role="function"/>lu_error_new ()</title>
72
75
<indexterm><primary>lu_error_new</primary></indexterm><programlisting><link linkend="void">void</link>        lu_error_new                    (<link linkend="lu-error-t">lu_error_t</link> **error,
73
76
                                             <link linkend="lu-status-t">lu_status_t</link> code,
74
77
                                             const <link linkend="char">char</link> *fmt,
93
96
</simpara></listitem></varlistentry>
94
97
</variablelist></refsect2>
95
98
<refsect2>
96
 
<title><anchor id="lu-error-free"/>lu_error_free ()</title>
 
99
<title><anchor id="lu-error-free" role="function"/>lu_error_free ()</title>
97
100
<indexterm><primary>lu_error_free</primary></indexterm><programlisting><link linkend="void">void</link>        lu_error_free                   (<link linkend="lu-error-t">lu_error_t</link> **error);</programlisting>
98
101
<para>
99
102
Frees an <link linkend="lu-error"><type>lu_error</type></link> structure.
106
109
</simpara></listitem></varlistentry>
107
110
</variablelist></refsect2>
108
111
<refsect2>
109
 
<title><anchor id="lu-error-is-success"/>lu_error_is_success ()</title>
 
112
<title><anchor id="lu-error-is-success" role="function"/>lu_error_is_success ()</title>
110
113
<indexterm><primary>lu_error_is_success</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_error_is_success             (<link linkend="lu-status-t">lu_status_t</link> status);</programlisting>
111
114
<para>
112
115
Check if the error code held by an error structure is a success code.
120
123
</simpara></listitem></varlistentry>
121
124
</variablelist></refsect2>
122
125
<refsect2>
123
 
<title><anchor id="lu-error-is-warning"/>lu_error_is_warning ()</title>
 
126
<title><anchor id="lu-error-is-warning" role="function"/>lu_error_is_warning ()</title>
124
127
<indexterm><primary>lu_error_is_warning</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_error_is_warning             (<link linkend="lu-status-t">lu_status_t</link> status);</programlisting>
125
128
<para>
126
129
Check if the error code held by an error structure is a warning code.
134
137
</simpara></listitem></varlistentry>
135
138
</variablelist></refsect2>
136
139
<refsect2>
137
 
<title><anchor id="lu-error-is-error"/>lu_error_is_error ()</title>
 
140
<title><anchor id="lu-error-is-error" role="function"/>lu_error_is_error ()</title>
138
141
<indexterm><primary>lu_error_is_error</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_error_is_error               (<link linkend="lu-status-t">lu_status_t</link> status);</programlisting>
139
142
<para>
140
143
Check if the error code held by an error structure is an error code.
148
151
</simpara></listitem></varlistentry>
149
152
</variablelist></refsect2>
150
153
<refsect2>
151
 
<title><anchor id="lu-strerror"/>lu_strerror ()</title>
 
154
<title><anchor id="lu-strerror" role="function"/>lu_strerror ()</title>
152
155
<indexterm><primary>lu_strerror</primary></indexterm><programlisting>const <link linkend="char">char</link>* lu_strerror                     (<link linkend="lu-error-t">lu_error_t</link> *error);</programlisting>
153
156
<para>
154
157
Converts an <link linkend="lu-error"><type>lu_error</type></link> structure to a string describing the error.
155
 
If the <parameter>error->string</parameter> is <literal>NULL</literal>, returns a text representation of
 
158
If the <parameter>error->string</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, returns a text representation of
156
159
 <parameter>error->code</parameter>.
157
160
</para><variablelist role="params">
158
161
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>