← Back to branch summary

~ubuntu-branches/ubuntu/natty/gnome-keyring/natty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-10 21:37:48 UTC
  • mfrom: (1.1.59 upstream)
  • Revision ID: james.westby@ubuntu.com-20100310213748-imimrnfxu32ih4t3
Tags: 2.29.92-0ubuntu1
* New upstream version:
  - Fix various problems with not storing secret value properly.
  - Return no results when a search includes a bad collection identifier.
  - Don't raise error if ssh client disconnects early.
  - Allow running in a test environment.
  - Fix error when setting default keyring to NULL.
  - Autostart gnome-keyring-daemon in LXDE as well.
  - Rework the startup again, to use a singleton crontrolled via dbus, to help
    when no process was started by pam.
  - Display password and confirm prompts when creating keyring.
  - Allow specifying CKA_ID when creating collection.
  - Give translatable label to created login keyring.
  - When no default keyring set, use login keyring.
  - Fix problem initializing socket path in rpc module.
  - Fix endless loop in reading data.
  - Potential fix or sporadic crash.
  - Solaris build fixes.
  - Updated translations.
* debian/patches/05_git_no_read_looping.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gp11/xml/gp11-error.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
<refentry id="gp11-gp11-error">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="gp11-gp11-error.top_of_page">Errors</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>GP11 Library</refmiscinfo>
9
 
</refmeta>
10
 
 
11
 
<refnamediv>
12
 
<refname>Errors</refname>
13
 
<refpurpose>GP11 Errors and error codes.</refpurpose>
14
 
</refnamediv>
15
 
 
16
 
<refsynopsisdiv id="gp11-gp11-error.synopsis" role="synopsis">
17
 
<title role="synopsis.title">Synopsis</title>
18
 
 
19
 
<synopsis>
20
 
#define             <link linkend="GP11-VENDOR-CODE--CAPS">GP11_VENDOR_CODE</link>
21
 
#define             <link linkend="GP11-ERROR--CAPS">GP11_ERROR</link>
22
 
const <link linkend="gchar">gchar</link>*        <link linkend="gp11-message-from-rv">gp11_message_from_rv</link>                (<link linkend="CK-RV--CAPS">CK_RV</link> rv);
23
 
#define             <link linkend="CKR-GP11-MODULE-PROBLEM--CAPS">CKR_GP11_MODULE_PROBLEM</link>
24
 
</synopsis>
25
 
</refsynopsisdiv>
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
<refsect1 id="gp11-gp11-error.description" role="desc">
36
 
<title role="desc.title">Description</title>
37
 
<para>
38
 
GP11 errors are returned as GError structures. The code member of GError 
39
 
contains the raw PKCS11 CK_RV result value.</para>
40
 
<para>
41
 
</para>
42
 
</refsect1>
43
 
 
44
 
<refsect1 id="gp11-gp11-error.details" role="details">
45
 
<title role="details.title">Details</title>
46
 
<refsect2 id="GP11-VENDOR-CODE--CAPS" role="macro">
47
 
<title>GP11_VENDOR_CODE</title>
48
 
<indexterm zone="GP11-VENDOR-CODE--CAPS"><primary sortas="GP11_VENDOR_CODE">GP11_VENDOR_CODE</primary></indexterm><programlisting>#define             GP11_VENDOR_CODE                        0x47503131 /* GP11 */
49
 
</programlisting>
50
 
<para>
51
 
Custom PKCS11 errors that originate from the GP11 library, are 
52
 
based at this error code.</para>
53
 
<para>
54
 
</para></refsect2>
55
 
<refsect2 id="GP11-ERROR--CAPS" role="macro">
56
 
<title>GP11_ERROR</title>
57
 
<indexterm zone="GP11-ERROR--CAPS"><primary sortas="GP11_ERROR">GP11_ERROR</primary></indexterm><programlisting>#define             GP11_ERROR                              (gp11_get_error_quark ())
58
 
</programlisting>
59
 
<para>
60
 
The error domain for GP11 library errors.</para>
61
 
<para>
62
 
</para></refsect2>
63
 
<refsect2 id="gp11-message-from-rv" role="function">
64
 
<title>gp11_message_from_rv ()</title>
65
 
<indexterm zone="gp11-message-from-rv"><primary sortas="gp11_message_from_rv">gp11_message_from_rv</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gp11_message_from_rv                (<link linkend="CK-RV--CAPS">CK_RV</link> rv);</programlisting>
66
 
<para>
67
 
Get a message for a PKCS<link linkend="11--CAPS"><type>11</type></link> return value or error code. Do not 
68
 
pass CKR_OK or other such non errors to this function.</para>
69
 
<para>
70
 
</para><variablelist role="params">
71
 
<varlistentry><term><parameter>rv</parameter>&#160;:</term>
72
 
<listitem><simpara> The PKCS<link linkend="11--CAPS"><type>11</type></link> return value to get a message for.
73
 
</simpara></listitem></varlistentry>
74
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The user readable message. 
75
 
</simpara></listitem></varlistentry>
76
 
</variablelist></refsect2>
77
 
<refsect2 id="CKR-GP11-MODULE-PROBLEM--CAPS" role="macro">
78
 
<title>CKR_GP11_MODULE_PROBLEM</title>
79
 
<indexterm zone="CKR-GP11-MODULE-PROBLEM--CAPS"><primary sortas="CKR_GP11_MODULE_PROBLEM">CKR_GP11_MODULE_PROBLEM</primary></indexterm><programlisting>#define             CKR_GP11_MODULE_PROBLEM                 (CKR_VENDOR_DEFINED | (GP11_VENDOR_CODE + 1)) 
80
 
</programlisting>
81
 
<para>
82
 
A result code that signifies there was a problem loading a PKCS11
83
 
module, usually a shared library.
84
 
</para>
85
 
<para>
86
 
More details can be found in the error string.</para>
87
 
<para>
88
 
</para></refsect2>
89
 
 
90
 
</refsect1>
91
 
 
92
 
 
93
 
 
94
 
 
95
 
</refentry>