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
106
107
108
109
110
111
112
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Errors</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GP11 Reference Manual">
<link rel="up" href="ch01.html" title="PKCS#11 GObject Bindings">
<link rel="prev" href="gp11-gp11-attributes.html" title="GP11Attributes">
<link rel="next" href="gp11-gp11-misc.html" title="Miscellaneous Functions">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="PKCS#11 GObject Bindings">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gp11-gp11-attributes.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GP11 Reference Manual</th>
<td><a accesskey="n" href="gp11-gp11-misc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gp11-gp11-error.synopsis" class="shortcut">Top</a>
|
<a href="#gp11-gp11-error.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Errors">
<a name="gp11-gp11-error"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gp11-gp11-error.top_of_page"></a>Errors</span></h2>
<p>Errors — GP11 Errors and error codes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gp11-gp11-error.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="gp11-gp11-error.html#GP11-VENDOR-CODE:CAPS" title="GP11_VENDOR_CODE">GP11_VENDOR_CODE</a>
#define <a class="link" href="gp11-gp11-error.html#GP11-ERROR:CAPS" title="GP11_ERROR">GP11_ERROR</a>
const <span class="returnvalue">gchar</span>* <a class="link" href="gp11-gp11-error.html#gp11-message-from-rv" title="gp11_message_from_rv ()">gp11_message_from_rv</a> (<span class="returnvalue">CK_RV</span> rv);
#define <a class="link" href="gp11-gp11-error.html#CKR-GP11-MODULE-PROBLEM:CAPS" title="CKR_GP11_MODULE_PROBLEM">CKR_GP11_MODULE_PROBLEM</a>
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gp11-gp11-error.description"></a><h2>Description</h2>
<p>
GP11 errors are returned as GError structures. The code member of GError
contains the raw PKCS11 CK_RV result value.</p>
</div>
<div class="refsect1" title="Details">
<a name="gp11-gp11-error.details"></a><h2>Details</h2>
<div class="refsect2" title="GP11_VENDOR_CODE">
<a name="GP11-VENDOR-CODE:CAPS"></a><h3>GP11_VENDOR_CODE</h3>
<pre class="programlisting">#define GP11_VENDOR_CODE 0x47503131 /* GP11 */
</pre>
<p>
Custom PKCS11 errors that originate from the GP11 library, are
based at this error code.</p>
</div>
<hr>
<div class="refsect2" title="GP11_ERROR">
<a name="GP11-ERROR:CAPS"></a><h3>GP11_ERROR</h3>
<pre class="programlisting">#define GP11_ERROR (gp11_get_error_quark ())
</pre>
<p>
The error domain for GP11 library errors.</p>
</div>
<hr>
<div class="refsect2" title="gp11_message_from_rv ()">
<a name="gp11-message-from-rv"></a><h3>gp11_message_from_rv ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span>* gp11_message_from_rv (<span class="returnvalue">CK_RV</span> rv);</pre>
<p>
Get a message for a PKCS<span class="type">11</span> return value or error code. Do not
pass CKR_OK or other such non errors to this function.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rv</code></em> :</span></p></td>
<td> The PKCS<span class="type">11</span> return value to get a message for.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The user readable message.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="CKR_GP11_MODULE_PROBLEM">
<a name="CKR-GP11-MODULE-PROBLEM:CAPS"></a><h3>CKR_GP11_MODULE_PROBLEM</h3>
<pre class="programlisting">#define CKR_GP11_MODULE_PROBLEM (CKR_VENDOR_DEFINED | (GP11_VENDOR_CODE + 1))
</pre>
<p>
A result code that signifies there was a problem loading a PKCS11
module, usually a shared library.
</p>
<p>
More details can be found in the error string.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|