Mercurial > projects > libpws

annotate pws3_file_create.3.xml @ 1:e1309515d111

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add README file and manpages
author Guido Berhoerster <guido+libpws@berhoerster.name>
date Wed, 25 Mar 2015 17:10:23 +0100
parents
children b3fc9f7e2b43
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1 <?xml version="1.0"?>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
2 <!--
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
3
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
4 Copyright (C) 2015 Guido Berhoerster <guido+libpws@berhoerster.name>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
5
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
6 Permission is hereby granted, free of charge, to any person obtaining
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
7 a copy of this software and associated documentation files (the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
8 "Software"), to deal in the Software without restriction, including
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
9 without limitation the rights to use, copy, modify, merge, publish,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
10 distribute, sublicense, and/or sell copies of the Software, and to
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
11 permit persons to whom the Software is furnished to do so, subject to
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
12 the following conditions:
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
13
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
14 The above copyright notice and this permission notice shall be included
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
15 in all copies or substantial portions of the Software.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
16
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
24
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
25 -->
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
26 <refentry xmlns="http://docbook.org/ns/docbook"
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
27 xmlns:xlink="http://www.w3.org/1999/xlink" xml:lang="en">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
28 <info>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
29 <author>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
30 <personname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
31 <firstname>Guido</firstname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
32 <surname>Berhoerster</surname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
33 </personname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
34 <email>guido+libpws@berhoerster.name</email>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
35 <personblurb/>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
36 </author>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
37 <date>21 March, 2015</date>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
38 </info>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
39 <refmeta>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
40 <refentrytitle>libpws</refentrytitle>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
41 <manvolnum>3</manvolnum>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
42 <refmiscinfo class="source"/>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
43 <refmiscinfo class="version"/>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
44 <refmiscinfo class="manual">Library Functions</refmiscinfo>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
45 </refmeta>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
46 <refnamediv>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
47 <refname>pws3_file_create</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
48 <refname>pws3_file_destroy</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
49 <refname>pws3_file_get_error_code</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
50 <refname>pws3_file_get_error_message</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
51 <refname>pws3_file_read_mem</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
52 <refname>pws3_file_read_stream</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
53 <refname>pws3_file_write_mem</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
54 <refname>pws3_file_write_stream</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
55 <refname>pws3_file_set_header_field</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
56 <refname>pws3_file_get_header_field</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
57 <refname>pws3_file_remove_header_field</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
58 <refname>pws3_file_insert_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
59 <refname>pws3_file_get_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
60 <refname>pws3_file_remove_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
61 <refname>pws3_file_first_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
62 <refname>pws3_file_last_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
63 <refname>pws3_file_next_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
64 <refname>pws3_file_prev_empty_group</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
65 <refname>pws3_file_insert_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
66 <refname>pws3_file_get_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
67 <refname>pws3_file_remove_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
68 <refname>pws3_file_first_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
69 <refname>pws3_file_last_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
70 <refname>pws3_file_next_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
71 <refname>pws3_file_prev_record</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
72 <refname>pws3_field_create</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
73 <refname>pws3_field_destroy</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
74 <refname>pws3_field_is_header</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
75 <refname>pws3_field_get_type</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
76 <refname>pws3_field_get_data_type</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
77 <refname>pws3_field_set_uuid</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
78 <refname>pws3_field_set_text</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
79 <refname>pws3_field_set_time</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
80 <refname>pws3_field_set_uint8</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
81 <refname>pws3_field_set_uint16</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
82 <refname>pws3_field_set_uint32</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
83 <refname>pws3_field_set_bytes</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
84 <refname>pws3_field_get_uuid</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
85 <refname>pws3_field_get_text</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
86 <refname>pws3_field_get_time</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
87 <refname>pws3_field_get_uint8</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
88 <refname>pws3_field_get_uint16</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
89 <refname>pws3_field_get_uint32</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
90 <refname>pws3_field_get_bytes</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
91 <refname>pws3_record_create</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
92 <refname>pws3_record_destroy</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
93 <refname>pws3_record_set_field</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
94 <refname>pws3_record_get_field</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
95 <refname>pws3_record_remove_field</refname>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
96 <refpurpose>create and manipulate Password Safe File Version 3
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
97 files</refpurpose>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
98 </refnamediv>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
99 <refsynopsisdiv>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
100 <cmdsynopsis>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
101 <command>cc</command>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
102 <arg choice="opt" rep="repeat">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
103 <option>flag</option>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
104 </arg>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
105 <arg choice="plain" rep="repeat">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
106 <option>file</option>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
107 </arg>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
108 <arg choice="plain">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
109 <option>-lpws</option>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
110 </arg>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
111 <arg choice="plain">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
112 <option>-lnettle</option>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
113 </arg>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
114 <arg choice="opt" rep="repeat">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
115 <option>library</option>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
116 </arg>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
117 </cmdsynopsis>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
118 <funcsynopsis>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
119 <funcsynopsisinfo>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
120 #include &lt;pws.h&gt;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
121 </funcsynopsisinfo>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
122 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
123 <funcdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
124 *<function>pws3_file_create</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
125 <void/>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
126 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
127 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
128 <funcdef>void <function>pws3_file_destroy</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
129 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
130 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
131 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
132 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
133 <funcdef>enum pws_error_code
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
134 <function>pws3_file_get_error_code</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
135 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
136 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
137 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
138 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
139 <funcdef>const char *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
140 <function>pws3_file_get_error_message</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
141 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
142 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
143 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
144 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
145 <funcdef>int <function>pws3_file_read_mem</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
146 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
147 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
148 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
149 *<parameter><replaceable>password</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
150 <paramdef>unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
151 *<parameter><replaceable>s</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
152 <paramdef>size_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
153 <parameter><replaceable>n</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
154 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
155 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
156 <funcdef>int <function>pws3_file_read_stream</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
157 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
158 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
159 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
160 *<parameter><replaceable>password</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
161 <paramdef>FILE
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
162 *<parameter><replaceable>fp</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
163 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
164 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
165 <funcdef>int <function>pws3_file_write_mem</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
166 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
167 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
168 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
169 *<parameter><replaceable>password</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
170 <paramdef>uint32_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
171 <parameter><replaceable>n_iter</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
172 <paramdef>unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
173 **<parameter><replaceable>memp</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
174 <paramdef>size_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
175 *<parameter><replaceable>mem_sizep</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
176 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
177 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
178 <funcdef>int <function>pws3_file_write_stream</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
179 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
180 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
181 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
182 *<parameter><replaceable>password</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
183 <paramdef>uint32_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
184 <parameter><replaceable>n_iter</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
185 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
186 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
187 <funcdef>void <function>pws3_file_set_header_field</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
188 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
189 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
190 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
191 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
192 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
193 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
194 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
195 <function>pws3_file_get_header_field</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
196 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
197 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
198 <paramdef>uint8_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
199 <parameter><replaceable>field_type</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
200 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
201 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
202 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
203 <function>pws3_file_remove_header_field</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
204 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
205 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
206 <paramdef>uint8_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
207 <parameter><replaceable>field_type</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
208 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
209 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
210 <funcdef>void
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
211 <function>pws3_file_insert_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
212 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
213 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
214 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
215 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
216 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
217 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
218 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
219 <function>pws3_file_get_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
220 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
221 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
222 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
223 *<parameter><replaceable>group_name</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
224 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
225 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
226 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
227 <function>pws3_file_remove_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
228 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
229 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
230 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
231 *<parameter><replaceable>group_name</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
232 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
233 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
234 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
235 <function>pws3_file_first_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
236 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
237 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
238 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
239 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
240 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
241 <function>pws3_file_last_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
242 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
243 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
244 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
245 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
246 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
247 <function>pws3_file_next_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
248 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
249 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
250 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
251 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
252 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
253 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
254 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
255 <function>pws3_file_prev_empty_group</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
256 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
257 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
258 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
259 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
260 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
261 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
262 <funcdef>void <function>pws3_file_insert_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
263 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
264 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
265 <paramdef>struct pws3_record
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
266 *<parameter><replaceable>record</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
267 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
268 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
269 <funcdef>struct pws3_record *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
270 <function>pws3_file_get_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
271 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
272 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
273 <paramdef>const unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
274 <parameter><replaceable>uuid</replaceable>[static
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
275 PWS3_UUID_SIZE]</parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
276 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
277 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
278 <funcdef>struct pws3_record *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
279 <function>pws3_file_remove_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
280 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
281 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
282 <paramdef>const unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
283 <parameter><replaceable>uuid</replaceable>[static
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
284 PWS3_UUID_SIZE]</parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
285 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
286 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
287 <funcdef>struct pws3_record *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
288 <function>pws3_file_first_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
289 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
290 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
291 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
292 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
293 <funcdef>struct pws3_record *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
294 <function>pws3_file_last_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
295 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
296 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
297 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
298 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
299 <funcdef>struct pws3_record *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
300 <function>pws3_file_next_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
301 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
302 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
303 <paramdef>struct pws3_record
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
304 *<parameter><replaceable>record</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
305 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
306 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
307 <funcdef>struct pws3_record *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
308 <function>pws3_file_prev_record</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
309 <paramdef>struct pws3_file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
310 *<parameter><replaceable>pws_file</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
311 <paramdef>struct pws3_record
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
312 *<parameter><replaceable>record</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
313 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
314 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
315 <funcdef>struct pws3_field *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
316 <function>pws3_field_create</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
317 <paramdef>int
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
318 <parameter><replaceable>is_header</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
319 <paramdef>uint8_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
320 <parameter><replaceable>field_type</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
321 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
322 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
323 <funcdef>void <function>pws3_field_destroy</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
324 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
325 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
326 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
327 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
328 <funcdef>int
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
329 <function>pws3_field_is_header</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
330 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
331 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
332 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
333 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
334 <funcdef>uint8_t *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
335 <function>pws3_field_get_type</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
336 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
337 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
338 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
339 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
340 <funcdef>enum pws_data_type *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
341 <function>pws3_field_get_data_type</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
342 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
343 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
344 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
345 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
346 <funcdef>int <function>pws3_field_set_uuid</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
347 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
348 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
349 <paramdef>const unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
350 <parameter><replaceable>uuid</replaceable>[static
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
351 PWS3_UUID_SIZE]</parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
352 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
353 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
354 <funcdef>int <function>pws3_field_set_text</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
355 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
356 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
357 <paramdef>const char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
358 <parameter><replaceable>s</replaceable>[static 1]</parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
359 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
360 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
361 <funcdef>int <function>pws3_field_set_time</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
362 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
363 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
364 <paramdef>time_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
365 <parameter><replaceable>time</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
366 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
367 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
368 <funcdef>int <function>pws3_field_set_uint8</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
369 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
370 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
371 <paramdef>uint8_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
372 <parameter><replaceable>u8</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
373 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
374 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
375 <funcdef>int <function>pws3_field_set_uint16</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
376 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
377 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
378 <paramdef>uint16_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
379 <parameter><replaceable>u16</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
380 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
381 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
382 <funcdef>int <function>pws3_field_set_uint32</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
383 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
384 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
385 <paramdef>uint32_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
386 <parameter><replaceable>u32</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
387 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
388 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
389 <funcdef>int <function>pws3_field_set_bytes</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
390 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
391 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
392 <paramdef>const unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
393 <parameter><replaceable>s</replaceable>[static 1]</parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
394 <paramdef>size_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
395 <parameter><replaceable>n</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
396 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
397 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
398 <funcdef>const unsigned char *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
399 <function>pws3_field_get_uuid</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
400 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
401 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
402 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
403 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
404 <funcdef>const char *
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
405 <function>pws3_field_get_text</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
406 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
407 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
408 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
409 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
410 <funcdef>time_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
411 <function>pws3_field_get_time</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
412 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
413 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
414 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
415 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
416 <funcdef>uint8_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
417 <function>pws3_field_get_uint8</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
418 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
419 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
420 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
421 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
422 <funcdef>uint16_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
423 <function>pws3_field_get_uint16</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
424 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
425 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
426 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
427 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
428 <funcdef>uint32_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
429 <function>pws3_field_get_uint32</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
430 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
431 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
432 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
433 <funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
434 <funcdef>void <function>pws3_field_get_bytes</function></funcdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
435 <paramdef>struct pws3_field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
436 *<parameter><replaceable>field</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
437 <paramdef>const unsigned char
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
438 **<parameter><replaceable>pp</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
439 <paramdef>size_t
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
440 *<parameter><replaceable>np</replaceable></parameter></paramdef>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
441 </funcprototype>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
442 </funcsynopsis>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
443 <synopsis>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
444 <constant>PWS3_VERSION</constant>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
445
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
446 <constant>PWS3_MAX_FIELD_LEN</constant>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
447
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
448 <constant>PWS3_MAX_PASSWORD_LEN</constant>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
449
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
450 <constant>PWS3_UUID_SIZE</constant>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
451
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
452 struct pws3_field;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
453
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
454 struct pws3_record;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
455
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
456 struct pws3_file;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
457
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
458 enum pws_error_code;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
459
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
460 enum pws_data_type;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
461
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
462 enum pws3_header_field_type;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
463
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
464 enum pws3_record_field_type;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
465 </synopsis>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
466 </refsynopsisdiv>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
467 <refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
468 <title>Description</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
469 <refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
470 <title>Introduction</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
471 <para>The <function>pws3_*()</function> family of functions allows
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
472 creating, reading, writing, and manipulating Password Safe version 3
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
473 files. Password Safe version 3 files consist of a header and a body part.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
474 The header is comprised of both mandatory and optional typed header
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
475 fields which hold file-wide metadata. The body consists of records which
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
476 in turn hold passwords and associated metadata in typed record
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
477 fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
478 <para>A header or record field value can be of one of seven basic data
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
479 types defined below:
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
480 <table xml:id="table-data-types">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
481 <title>Header and Record Field Value Data Types</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
482 <tgroup cols="3" align="left" colsep="1" rowsep="1">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
483 <thead>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
484 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
485 <entry>Data Type</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
486 <entry>C Type</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
487 <entry>Description</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
488 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
489 </thead>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
490 <tbody>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
491 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
492 <entry><constant>PWS_DATA_TYPE_UUID</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
493 <entry><code>unsigned char [PWS3_UUID_SIZE]</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
494 <entry>UUID</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
495 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
496 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
497 <entry><constant>PWS_DATA_TYPE_TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
498 <entry><code>char *</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
499 <entry>NUL-delimited UTF-8 encoded string</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
500 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
501 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
502 <entry><constant>PWS_DATA_TYPE_TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
503 <entry><code>time_t</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
504 <entry>system-specific representation of time</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
505 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
506 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
507 <entry><constant>PWS_DATA_TYPE_UINT8</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
508 <entry><code>uint8_t</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
509 <entry>8-bit wide unsigned integer</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
510 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
511 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
512 <entry><constant>PWS_DATA_TYPE_UINT16</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
513 <entry><code>uint16_t</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
514 <entry>16-bit wide unsigned integer</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
515 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
516 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
517 <entry><constant>PWS_DATA_TYPE_UINT32</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
518 <entry><code>uint32_t</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
519 <entry>32-bit wide unsigned integer</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
520 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
521 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
522 <entry><constant>PWS_DATA_TYPE_BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
523 <entry><code>unsigned char *</code></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
524 <entry>array of bytes</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
525 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
526 </tbody>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
527 </tgroup>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
528 </table>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
529 </para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
530 <para>The data type of each header field is defined in
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
531 <xref linkend="table-header-fields"/> and the data type of each record
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
532 field is defined in <xref linkend="table-record-fields"/>. Each header
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
533 field, with the exception of the empty groups header field, can only
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
534 occur once. The version header field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
535 (<constant>PWS3_HEADER_FIELD_VERSION</constant>) is mandatory and must
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
536 not be removed. When reading a file its value is checked and an error is
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
537 returned if the file format version newer than the one supported by
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
538 <citerefentry><refentrytitle>libpws</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
539 The supported version is defined by the <constant>PWS3_VERSION</constant>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
540 macro, when creating a new file structure the version header field will be
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
541 set to its value by default. Non-standard header and record fields will
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
542 be preserved when a file is read and subsequently written again, they may
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
543 be read and manipulated as if they had
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
544 <constant>PWS_DATA_TYPE_BYTES</constant> data type. All strings are
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
545 expected to be in UTF-8 encoding.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
546 <para>The only mandatory record field is the UUID field which uniquely
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
547 identifies a record in the file.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
548 <para>The complete and authoritative specification of the file format is
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
549 included with the original Password Safe application available from <link
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
550 xlink:href="https://pwsafe.org/"/>.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
551 </refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
552 <refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
553 <title>Password Safe File Data Structure</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
554 <para>The <function>pws3_file_create()</function> function allocates and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
555 intializes a Password Safe file data structure representing a Password
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
556 Safe version 3 file. It automatically creates the mandatory version header
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
557 field and initializes it to the value of the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
558 <constant>PWS3_VERSION</constant> macro.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
559 <para>The <function>pws3_file_destroy()</function> function deallocates
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
560 all header fields and records of the file structure passed to it and then
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
561 deallocates the file structure itself.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
562 <para>The <function>pws3_file_read_mem()</function> and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
563 <function>pws3_file_read_stream()</function> functions read and parse a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
564 Password Safe file into the given data structure passed via the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
565 <parameter>pws_file</parameter> argument, replacing any existing header
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
566 fields and records. The key used to decrypt the file is derived from the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
567 given <parameter>password</parameter> parameter. The
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
568 <function>pws3_file_read_mem()</function> function reads the file from a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
569 block of memory <parameter>s</parameter> with the size of
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
570 <parameter>n</parameter> bytes. The
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
571 <function>pws3_file_read_stream()</function> reads the file from the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
572 stream of the <parameter>fp</parameter> file pointer.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
573 <para>The <function>pws3_file_write_mem()</function> and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
574 <function>pws3_file_write_stream()</function> functions write a new
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
575 Password Safe file from the given datat structure. The key used to
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
576 encrypt the file is derived from the <parameter>password</parameter>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
577 argument using the number of iterations to stretch the key determined by
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
578 the <parameter>n_iter</parameter> argument. The
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
579 <function>pws3_file_write_mem()</function> will allocate and place the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
580 file contents into memory and return the location and size to the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
581 locations <parameter>sp</parameter> and <parameter>np</parameter>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
582 point to. The <function>pws3_file_write_stream()</function> will write the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
583 file contents to the stream of the <parameter>fp</parameter> file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
584 pointer.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
585 </refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
586 <refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
587 <title>Fields</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
588 <para>Both header and record fields are stored in
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
589 <varname>pws3_field</varname> structures which are allocated and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
590 initialized with the <function>pws3_field_create()</function> function.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
591 Depending on whether <parameter>is_header</parameter> is non-zero either
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
592 a header field or a record field data structure of the given field type
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
593 will be created.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
594 <para>The <function>pws3_field_destroy()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
595 deallocates the given field data structure and its content.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
596 <para>The <function>pws3_field_is_header()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
597 can be used to test whether the given field data structure refers to a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
598 header field or a record field.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
599 <para>The <function>pws3_field_get_type()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
600 returns the field type of the given field data structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
601 <para>The <function>pws3_field_get_data_type()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
602 returns the data type of the given field structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
603 <para>The <function>pws3_field_set_uuid()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
604 <function>pws3_field_set_text()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
605 <function>pws3_field_set_time()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
606 <function>pws3_field_set_uint8()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
607 <function>pws3_field_set_uint16()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
608 <function>pws3_field_set_uint32()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
609 <function>pws3_field_set_bytes()</function> functions set the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
610 content of the given field. The given data is always copied and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
611 existing content is replaced. The data type used by the function must
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
612 match the data type of the field specified in <xref
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
613 linkend="table-header-fields"/> in case of header fields or that in <xref
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
614 linkend="table-record-fields"/> in case of record fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
615 <para>The <function>pws3_field_get_time()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
616 <function>pws3_field_get_uint8()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
617 <function>pws3_field_get_uint16()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
618 <function>pws3_field_get_uint32()</function> functions return the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
619 value of the given field. The
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
620 <function>pws3_field_get_uuid()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
621 <function>pws3_field_get_text()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
622 <function>pws3_field_get_bytes()</function> functions return a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
623 pointer to the data of the given field if it has been set. The data type
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
624 used by the function must match the data type of the field specified in
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
625 <xref linkend="table-header-fields"/> in case of header fields and that
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
626 in <xref linkend="table-record-fields"/> in case of record fields.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
627 Returned pointers are only valid until a field is modified or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
628 deallocated.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
629 </refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
630 <refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
631 <title>Header Fields</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
632 <para>Header fields are used to store metadata for the whole file, each
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
633 type of header field with the exception of the empty groups header field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
634 only occurs once. The following header fields are supported:
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
635 <table xml:id="table-header-fields">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
636 <title>Header Fields</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
637 <tgroup cols="4" align="left" colsep="1" rowsep="1">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
638 <thead>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
639 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
640 <entry>Header Field Type</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
641 <entry>Numeric Value</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
642 <entry>Data Type</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
643 <entry>Description</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
644 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
645 </thead>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
646 <tbody>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
647 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
648 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;VERSION</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
649 <entry><literal>0x00</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
650 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;UINT16</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
651 <entry>file format version</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
652 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
653 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
654 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;UUID</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
655 <entry><literal>0x01</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
656 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;UUID</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
657 <entry>UUID</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
658 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
659 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
660 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;NON_&#8203;DEFAULT_&#8203;PREFERENCES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
661 <entry><literal>0x02</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
662 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
663 <entry>non-default preferences</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
664 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
665 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
666 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;TREE_&#8203;DISPLAY_&#8203;STATUS</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
667 <entry><literal>0x03</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
668 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
669 <entry>expandended/&#8203;collapsed state of the tree of groups</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
670 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
671 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
672 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;SAVE_&#8203;TIMESTAMP</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
673 <entry><literal>0x04</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
674 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
675 <entry>time when the file was last saved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
676 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
677 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
678 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;SAVE_&#8203;USER_&#8203;HOST</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
679 <entry><literal>0x05</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
680 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
681 <entry>name of the user who last saved the file and name of the host where the file was saved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
682 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
683 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
684 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;SAVE_&#8203;APPLICATION</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
685 <entry><literal>0x06</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
686 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
687 <entry>name of the application used to save the file</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
688 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
689 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
690 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;SAVE_&#8203;USER</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
691 <entry><literal>0x07</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
692 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
693 <entry>name of the user who last saved the file</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
694 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
695 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
696 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;SAVE_&#8203;HOST</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
697 <entry><literal>0x08</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
698 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
699 <entry>name of the host where the file was last saved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
700 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
701 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
702 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;DATABASE_&#8203;NAME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
703 <entry><literal>0x09</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
704 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
705 <entry>logical name for referring to the file</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
706 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
707 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
708 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;DATABASE_&#8203;DESCRIPTION</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
709 <entry><literal>0x0a</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
710 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
711 <entry>description of the file</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
712 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
713 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
714 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;DATABASE_&#8203;FILTERS</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
715 <entry><literal>0x0b</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
716 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
717 <entry>filters for this file</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
718 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
719 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
720 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;RESERVED_&#8203;1</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
721 <entry><literal>0x0c</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
722 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
723 <entry>reserved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
724 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
725 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
726 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;RESERVED_&#8203;2</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
727 <entry><literal>0x0d</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
728 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
729 <entry>reserved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
730 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
731 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
732 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;RESERVED_&#8203;3</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
733 <entry><literal>0x0e</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
734 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
735 <entry>reseved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
736 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
737 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
738 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;RECENTLY_&#8203;USED_&#8203;ENTRIES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
739 <entry><literal>0x0f</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
740 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
741 <entry>list of recently used entries</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
742 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
743 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
744 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;NAMED_&#8203;PASSWORD_&#8203;POLICIES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
745 <entry><literal>0x10</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
746 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
747 <entry>named password policies</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
748 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
749 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
750 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;EMPTY_&#8203;GROUPS</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
751 <entry><literal>0x11</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
752 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
753 <entry>empty groups which contain no entries</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
754 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
755 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
756 <entry><constant>PWS3_&#8203;HEADER_&#8203;FIELD_&#8203;YUBICO</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
757 <entry><literal>0x12</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
758 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
759 <entry>reserved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
760 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
761 </tbody>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
762 </tgroup>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
763 </table>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
764 </para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
765 <para>The <function>pws3_file_set_header_field()</function> function sets
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
766 the header field on the given file. An existing field of the same type is
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
767 replaced with the exception of fields of type
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
768 <constant>PWS3_HEADER_FIELD_EMPTY_GROUPS</constant> for which
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
769 <function>pws3_file_set_header_field()</function> has the same effect as
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
770 calling the <function>pws3_file_insert_empty_group()</function>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
771 function.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
772 <para>The <function>pws3_file_get_header_field()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
773 returns a pointer to the header field data structure of the given header
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
774 field type. In case of the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
775 <constant>PWS3_HEADER_FIELD_EMPTY_GROUPS</constant> field type a pointer
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
776 to the first empty group field is returned.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
777 <para>The <function>pws3_file_remove_header_field()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
778 removes the header field from the given file and returns a pointer to it.
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
779 It is the responsibility of the caller to deallocate the header field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
780 data structure. In case of the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
781 <constant>PWS3_HEADER_FIELD_EMPTY_GROUPS</constant> field type the first
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
782 empty group is removed.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
783 <para>The <function>pws3_file_insert_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
784 inserts the given empty groups field into the file, an existing field for
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
785 a group of the same name is replaced.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
786 <para>The <function>pws3_file_get_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
787 returns a pointer to the header field datat structure representing an
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
788 empty group of the given name.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
789 <para>The <function>pws3_file_remove_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
790 removes the field representing the empty group of the given name from the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
791 file and returns a pointer to the header field data structure. It is the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
792 responsibility of the caller to deallocate the header field data
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
793 structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
794 <para>The <function>pws3_file_first_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
795 returns a pointer to the first empty group header field.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
796 <para>The <function>pws3_file_last_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
797 returns a pointer to the last empty group header field.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
798 <para>The <function>pws3_file_next_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
799 returns a pointer to the next empty group header filed data structure
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
800 following the given <parameter>field</parameter>.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
801 <para>The <function>pws3_file_prev_empty_groupious()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
802 returns a pointer to the previous empty group header filed data structure
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
803 preceding the given <parameter>field</parameter>.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
804 </refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
805 <refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
806 <title>Records</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
807 <para>Records consist of at least one or more typed fields, they are
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
808 identified by an UUID which is the only mandatory field and must not be
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
809 removed. For presentational purposes records may be organized in
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
810 hierarchical groups. The following record fields are supported:
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
811 <table xml:id="table-record-fields">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
812 <title>Record Fields</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
813 <tgroup cols="4" align="left" colsep="1" rowsep="1">
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
814 <thead>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
815 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
816 <entry>Record Field Type</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
817 <entry>Numeric Value</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
818 <entry>Data Type</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
819 <entry>Description</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
820 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
821 </thead>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
822 <tbody>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
823 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
824 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;UUID</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
825 <entry><literal>0x01</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
826 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;UUID</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
827 <entry>UUID identifying the record</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
828 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
829 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
830 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;GROUP</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
831 <entry><literal>0x02</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
832 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
833 <entry>group name the record is a member of</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
834 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
835 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
836 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;TITLE</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
837 <entry><literal>0x03</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
838 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
839 <entry>title</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
840 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
841 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
842 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;USERNAME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
843 <entry><literal>0x04</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
844 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
845 <entry>username</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
846 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
847 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
848 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;NOTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
849 <entry><literal>0x05</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
850 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
851 <entry>notes</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
852 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
853 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
854 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
855 <entry><literal>0x06</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
856 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
857 <entry>password</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
858 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
859 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
860 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;CREATION_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
861 <entry><literal>0x07</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
862 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
863 <entry>time when the record was created</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
864 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
865 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
866 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD_&#8203;MODIFICATION_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
867 <entry><literal>0x08</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
868 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
869 <entry>time when the password was last modified</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
870 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
871 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
872 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;ACCESS_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
873 <entry><literal>0x09</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
874 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
875 <entry>time when the record was last accessed</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
876 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
877 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
878 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD_&#8203;EXPIRY_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
879 <entry><literal>0x0a</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
880 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
881 <entry>time when the password expires</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
882 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
883 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
884 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;RESERVED_&#8203;1</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
885 <entry><literal>0x0b</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
886 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
887 <entry>reserved</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
888 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
889 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
890 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;MODIFICATION_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
891 <entry><literal>0x0c</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
892 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TIME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
893 <entry>time at whcih the record was last modified</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
894 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
895 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
896 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;URL</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
897 <entry><literal>0x0d</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
898 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
899 <entry>URL</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
900 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
901 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
902 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;AUTOTYPE</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
903 <entry><literal>0x0e</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
904 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
905 <entry>text to be typed when using the autotype feature</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
906 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
907 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
908 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD_&#8203;HISTORY</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
909 <entry><literal>0x0f</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
910 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
911 <entry>creation time and values of previously used passwords</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
912 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
913 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
914 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD_&#8203;POLICY</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
915 <entry><literal>0x10</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
916 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
917 <entry>password policy</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
918 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
919 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
920 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD_&#8203;EXPIRY_&#8203;INTERVAL</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
921 <entry><literal>0x11</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
922 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;UINT32</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
923 <entry>days until the password expires</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
924 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
925 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
926 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;RUN_&#8203;COMMAND</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
927 <entry><literal>0x12</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
928 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
929 <entry>command</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
930 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
931 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
932 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;DOUBLE_&#8203;CLICK_&#8203;ACTION</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
933 <entry><literal>0x13</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
934 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
935 <entry>action on double clicking</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
936 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
937 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
938 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;EMAIL_&#8203;ADDRESS</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
939 <entry><literal>0x14</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
940 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
941 <entry>email address</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
942 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
943 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
944 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PROTECTED</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
945 <entry><literal>0x15</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
946 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;UINT8</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
947 <entry>flag whether the record is protected from modification</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
948 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
949 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
950 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;ALLOWED_&#8203;PASSWORD_&#8203;SYMBOLS</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
951 <entry><literal>0x16</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
952 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
953 <entry>allowed symbols for generating passwords</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
954 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
955 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
956 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;SHIFT_&#8203;DOUBLE_&#8203;CLICK_&#8203;ACTION</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
957 <entry><literal>0x17</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
958 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
959 <entry>action on pressing shift and double clicking</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
960 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
961 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
962 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;PASSWORD_&#8203;POLICY_&#8203;NAME</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
963 <entry><literal>0x18</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
964 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;TEXT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
965 <entry>name of password policy saved in the header</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
966 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
967 <row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
968 <entry><constant>PWS3_&#8203;RECORD_&#8203;FIELD_&#8203;KEYBOARD_&#8203;SHORTCUT</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
969 <entry><literal>0x19</literal></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
970 <entry><constant>PWS_&#8203;DATA_&#8203;TYPE_&#8203;BYTES</constant></entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
971 <entry>keyboard shortcut</entry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
972 </row>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
973 </tbody>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
974 </tgroup>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
975 </table>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
976 </para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
977 <para>The <function>pws3_record_create()</function> function allocates
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
978 and creates a record data structure, generates an UUID record field and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
979 adds it to the record.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
980 <para>The <function>pws3_record_destroy()</function> function deallocates
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
981 the given record data structure and all its record fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
982 <para>The <function>pws3_file_record_field_set()</function> function sets
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
983 the record field on the given record, replacing an existing field of the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
984 same type.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
985 <para>The <function>pws3_file_record_field_get()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
986 returns a pointer to the record field data structure of the given record
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
987 field type.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
988 <para>The <function>pws3_file_record_field_remove()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
989 removes the record field from the given record and returns a pointer to
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
990 it. It is the responsibility of the caller to deallocate the record field
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
991 data structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
992 <para>The <function>pws3_file_insert_record()</function> function inserts
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
993 the given record into the file, an existing record with the same UUID is
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
994 replaced.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
995 <para>The <function>pws3_file_get_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
996 pointer to the record structure representing a record with the given
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
997 UUID.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
998 <para>The <function>pws3_file_remove_record()</function> function removes
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
999 the record with the given UUID from the file and returns a pointer to the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1000 record data structure. It is the responsibility of the caller to
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1001 deallocate the record data structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1002 <para>The <function>pws3_file_first_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1003 pointer to the first record.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1004 <para>The <function>pws3_file_last_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1005 pointer to the last record.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1006 <para>The <function>pws3_file_next_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1007 pointer to the next record following the given
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1008 <parameter>record</parameter>.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1009 <para>The <function>pws3_file_prev_record()</function>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1010 function returns a pointer to the previous group preceding the given
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1011 <parameter>record</parameter>.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1012 </refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1013 <refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1014 <title>Macros</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1015 <para>The macro <constant>PWS3_VERSION</constant> contains the supported
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1016 version of the Password Safe version 3 file format.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1017 <para>The macro <constant>PWS3_MAX_FIELD_SIZE</constant> contains the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1018 maxium size for header and record fields in bytes and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1019 <constant>PWS3_MAX_PASSWORD_LEN</constant> contains the maxium password
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1020 length in bytes.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1021 <para>The macro <constant>PWS3_UUID_SIZE</constant> contains the size of
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1022 UUIDs in bytes.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1023 </refsect2>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1024 </refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1025 <refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1026 <title>Return Values</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1027 <para>The <function>pws3_file_create()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1028 pointer to a Password Safe file data structure if successful and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1029 <constant>NULL</constant> in case of an error.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1030 <para>The <function>pws3_file_read_mem()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1031 <function>pws3_file_read_stream()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1032 <function>pws3_file_write_mem()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1033 <function>pws3_file_write_stream()</function> functions return
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1034 <returnvalue>0</returnvalue> on success and <returnvalue>-1</returnvalue>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1035 to indicate an error.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1036 <para>The <function>pws3_file_get_header_field()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1037 returns a pointer to the header field data structure of the requested type
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1038 and <constant>NULL</constant> if such a field does not exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1039 <para>The <function>pws3_file_remove_header_field()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1040 returns a pointer to the header field data structure which was removed from
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1041 the file or <constant>NULL</constant> if such a field does not exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1042 <para>The <function>pws3_file_get_empty_group()</function> function returns
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1043 a pointer to the header field data structure corresponding to the requested
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1044 empty group and <constant>NULL</constant> if a group of that name does not
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1045 exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1046 <para>The <function>pws3_file_remove_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1047 returns a pointer to the header field data structure of the empty group
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1048 which was removed from the file or <constant>NULL</constant> if a group of
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1049 that name does not exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1050 <para>The <function>pws3_file_first_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1051 returns a pointer to the first of the empty group header fields or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1052 <constant>NULL</constant> if there are no such fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1053 <para>The <function>pws3_file_last_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1054 returns a pointer to the last of the empty group header fields or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1055 <constant>NULL</constant> if there are no such fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1056 <para>The <function>pws3_file_next_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1057 returns a pointer to the next empty group header field or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1058 <constant>NULL</constant> if there are no more such fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1059 <para>The <function>pws3_file_prev_empty_group()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1060 returns a pointer to the previous empty group header field or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1061 <constant>NULL</constant> if there are no more such fields.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1062 <para>The <function>pws3_file_get_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1063 pointer to the record data structure of the requested record or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1064 <constant>NULL</constant> if that record does not exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1065 <para>The <function>pws3_file_remove_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1066 pointer to the record data structure which was removed from the file or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1067 <constant>NULL</constant> if no such record exists.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1068 <para>The <function>pws3_file_first_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1069 pointer to the record data structure of the first record or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1070 <constant>NULL</constant> if no records exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1071 <para>The <function>pws3_file_last_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1072 pointer to the record data structure of the last record or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1073 <constant>NULL</constant> if no records exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1074 <para>The <function>pws3_file_next_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1075 pointer to the record data structure of the next record or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1076 <constant>NULL</constant> if no records exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1077 <para>The <function>pws3_file_prev_record()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1078 pointer to the record data structure of the previous record or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1079 <constant>NULL</constant> if no records exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1080 <para>The <function>pws3_field_create()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1081 pointer to the new header field data structure on success and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1082 <constant>NULL</constant> on failure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1083 <para>The <function>pws3_field_get_type()</function> function returns
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1084 the field type of the header field structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1085 <para>The <function>pws3_field_get_data_type()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1086 returns the data type of the header field structure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1087 <para>The <function>pws3_field_set_uuid()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1088 <function>pws3_field_set_text()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1089 <function>pws3_field_set_time()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1090 <function>pws3_field_set_uint8()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1091 <function>pws3_field_set_uint16()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1092 <function>pws3_field_set_uint32()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1093 <function>pws3_field_set_bytes()</function> functions return
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1094 <returnvalue>0</returnvalue> on success and <returnvalue>-1</returnvalue>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1095 on failure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1096 <para>The <function>pws3_field_get_time()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1097 <function>pws3_field_get_uint8()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1098 <function>pws3_field_get_uint16()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1099 <function>pws3_field_get_uint32()</function> functions return a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1100 value of the type corresponding to the type of header field.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1101 <para>The <function>pws3_field_get_uuid()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1102 returns a pointer to a UUID.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1103 <para>The <function>pws3_field_get_text()</function> function
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1104 returns a pointer to a string or <constant>NULL</constant> if no value has
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1105 been set.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1106 <para>The <function>pws3_record_create()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1107 pointer to a record data structure if successful and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1108 <constant>NULL</constant> on failure.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1109 <para>The <function>pws3_record_get_field()</function> function returns a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1110 pointer to the record field data structure of the requested type or
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1111 <constant>NULL</constant> if such a field does not exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1112 <para>The <function>pws3_record_remove_field()</function> function returns
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1113 a pointer to the record field data structure which was removed from the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1114 record or <constant>NULL</constant> if such a field does not exist.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1115 </refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1116 <refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1117 <title>Errors</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1118 <para>If the <function>pws3_file_read_mem()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1119 <function>pws3_file_read_stream()</function>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1120 <function>pws3_file_write_mem()</function>, and
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1121 <function>pws3_file_write_stream()</function> functions fail, an error code
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1122 indicating the nature of the error may be obtained using the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1123 <function>pws3_file_get_error_code()</function> function and a pointer to a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1124 detailed error message may be retrieved using the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1125 <function>pws3_file_get_error_message()</function> function. The above
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1126 functions may fail if:</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1127 <variablelist>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1128 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1129 <term><errorname>PWS_ERR_GENERIC_ERROR</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1130 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1131 <para>An unknown error occurred.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1132 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1133 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1134 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1135 <term><errorname>PWS_ERR_NO_MEMORY</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1136 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1137 <para>There was not enough space to allocate memory.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1138 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1139 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1140 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1141 <term><errorname>PWS_ERR_IO_ERROR</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1142 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1143 <para>An I/O error occurred.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1144 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1145 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1146 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1147 <term><errorname>PWS_ERR_TRUNCATED_FILE</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1148 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1149 <para>The file appears to be truncated.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1150 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1151 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1152 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1153 <term><errorname>PWS_ERR_INVALID_CHECKSUM</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1154 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1155 <para>The calculated checksum does not match the checksum of the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1156 file.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1157 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1158 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1159 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1160 <term><errorname>PWS_ERR_INVALID_RECORD</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1161 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1162 <para>A record is invalid.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1163 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1164 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1165 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1166 <term><errorname>PWS_ERR_INVALID_HEADER</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1167 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1168 <para>A header is invalid.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1169 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1170 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1171 <varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1172 <term><errorname>PWS_ERR_UNSUPPORTED_VERSION</errorname></term>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1173 <listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1174 <para>The file format version is not supported.</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1175 </listitem>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1176 </varlistentry>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1177 </variablelist>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1178 </refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1179 <refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1180 <title>Examples</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1181 <example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1182 <title>Creating a Password Safe file</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1183 <para>The following code creates a new Password Safe file and sets the
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1184 save application header field:</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1185 <programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1186 <![CDATA[
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1187 #include <pws.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1188
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1189 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1190
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1191 struct pws3_file *file;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1192 struct pws3_field *application_field;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1193
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1194 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1195
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1196 /* initialize libpws */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1197 if (pws_init() != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1198 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1199 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1200
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1201 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1202
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1203 /* create a new empty file structure */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1204 file = pws3_file_create();
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1205 if (file == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1206 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1207 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1208 /* create new empty save application field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1209 application_field = pws3_field_create(1, PWS3_HEADER_FIELD_SAVE_APPLICATION);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1210 if (application_field == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1211 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1212 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1213 /* set the value of the field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1214 if (pws3_field_set_text(application_field, "PasswordManager 2.0") != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1215 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1216 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1217 /* set the header save application field in the file to the new field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1218 pws3_file_set_field(file, application_field);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1219 ]]>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1220 </programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1221 </example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1222 <example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1223 <title>Print the title of each record</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1224 <para>The following code loops over each record of an existing Password
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1225 Safe file and prints the content of the title field if it exists:</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1226 <programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1227 <![CDATA[
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1228 #include <stdio.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1229 #include <pws.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1230
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1231 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1232
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1233 struct pws3_file *file;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1234 struct pws3_record *record;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1235 struct pws3_field *title_field;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1236
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1237 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1238
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1239 /* interate over each record */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1240 for (record = pws3_file_first_record(file); record != NULL;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1241 record = pws3_file_next_record(file, record)) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1242 /* retrieve title field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1243 title_field = pws3_record_get_field(record, PWS3_RECORD_FIELD_TITLE);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1244 /* print the title field or "No title" if it does not exitst */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1245 printf("Title: %s\n", (title_field != NULL) ?
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1246 pws3_record_field_get_text(PWS3_RECORD_FIELD_TITLE) : "No title");
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1247 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1248 ]]>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1249 </programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1250 </example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1251 <example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1252 <title>Add a new record to a file</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1253 <para>The following code creates a new record with a password field, a
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1254 title field, and a creation time field and adds it to an existing
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1255 Password Safe file:</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1256 <programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1257 <![CDATA[
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1258 #include <time.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1259 #include <pws.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1260
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1261 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1262
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1263 struct pws3_file *file;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1264 struct pws3_record *record;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1265 struct pws3_field *password_field;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1266 struct pws3_field *title_field;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1267 struct pws3_field *ctime_field;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1268 time_t now;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1269
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1270 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1271
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1272 /* create new record */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1273 record = pws3_record_create();
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1274 if (record == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1275 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1276 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1277
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1278 /* create a password field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1279 password_field = pws3_record_field_create(PWS3_RECORD_FIELD_PASSWORD);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1280 if (password_field == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1281 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1282 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1283 /* set the value of the password field to "PaSsWoRd" */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1284 if (pws3_record_field_set_text(password_field, "PaSsWoRd") != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1285 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1286 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1287 /* set the password field of the record to the new field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1288 pws3_record_set_field(record, password_field);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1289
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1290 /* create a title field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1291 title_field = pws3_record_field_create(PWS3_RECORD_FIELD_TITLE);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1292 if (title_field == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1293 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1294 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1295 /* set the value of the title field to "Foo Bar" */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1296 if (pws3_record_field_set_text(title_field, "Foo Bar") != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1297 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1298 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1299 /* set the title field of the record to the new field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1300 pws3_record_set_field(record, title_field);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1301
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1302 /* create a new creation time field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1303 ctime_field = pws3_record_field_create(PWS3_RECORD_FIELD_CREATION_TIME);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1304 if (ctime_field == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1305 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1306 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1307 /* set the value of the creation time field to the current time */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1308 pws3_record_field_set_time(ctime_field, time(NULL));
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1309 /* set the creation time field of the record to the new field */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1310 pws3_record_set_field(record, ctime_field);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1311
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1312 /* insert the new record into the file */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1313 pws3_file_insert_record(file, record);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1314 ]]>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1315 </programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1316 </example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1317 <example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1318 <title>Reading a Password Safe file</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1319 <para>The following code opens a Password Safe file named
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1320 <filename>example.pwsafe3</filename> and parses it:</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1321 <programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1322 <![CDATA[
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1323 #include <stdio.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1324 #include <pws.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1325
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1326 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1327
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1328 FILE *fp;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1329 struct pws3_file *file;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1330
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1331 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1332
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1333 /* initialize libpws */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1334 if (pws_init() != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1335 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1336 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1337
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1338 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1339
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1340 /* create a new empty file structure */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1341 file = pws3_file_create();
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1342 if (file == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1343 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1344 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1345
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1346 /* open the file */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1347 fp = fopen("example.pwsafe3", "r");
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1348 if (fp == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1349 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1350 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1351
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1352 /* read and parse the file contents into the file structure */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1353 if (pws3_file_read_stream(file, "PaSsWoRd", fp) != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1354 fprintf(stderr, "error: %s\n",
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1355 pws3_file_get_error_message(file));
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1356 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1357 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1358 ]]>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1359 </programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1360 </example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1361 <example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1362 <title>Writing a Password Safe file</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1363 <para>The following code writes a Password Safe file to a file
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1364 named <filename>example.pwsafe3</filename>:</para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1365 <programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1366 <![CDATA[
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1367 #include <stdio.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1368 #include <pws.h>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1369
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1370 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1371
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1372 FILE *fp;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1373 struct pws3_file *file;
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1374
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1375 /* ... */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1376
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1377 fp = fopen("example.pwsafe3", "w");
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1378 if (fp == NULL) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1379 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1380 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1381
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1382 if (pws3_file_write_stream(file, "FoOBaR", 10000, fp) != 0) {
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1383 /* handle error */
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1384 }
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1385
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1386 fflush(fp);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1387 fclose(fp);
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1388 ]]>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1389 </programlisting>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1390 </example>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1391 </refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1392 <refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1393 <title>See Also</title>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1394 <para><citerefentry><refentrytitle>libpws</refentrytitle>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1395 <manvolnum>3</manvolnum></citerefentry>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1396 <citerefentry><refentrytitle>pws_init</refentrytitle>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1397 <manvolnum>3</manvolnum></citerefentry>,
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1398 <link xlink:href="https://pwsafe.org/"/></para>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1399 </refsect1>
e1309515d111 Add README file and manpages
Guido Berhoerster <guido+libpws@berhoerster.name>
parents:
diff changeset
1400 </refentry>