Palm::Address(3pm)

1Palm::Address(3)      User Contributed Perl Documentation     Palm::Address(3)
2
3
4

NAME

6       Palm::Address - Handler for Palm OS AddressBook databases
7

VERSION

9       This document describes version 1.400 of Palm::Address, released March
10       14, 2015 as part of Palm version 1.400.
11

SYNOPSIS

13           use Palm::Address;
14

DESCRIPTION

16       The Address PDB handler is a helper class for the Palm::PDB package.
17       It parses AddressBook databases.
18
19   AppInfo block
20       The AppInfo block begins with standard category support. See
21       Palm::StdAppInfo for details.
22
23       Other fields include:
24
25           $pdb->{appinfo}{lastUniqueID}
26           $pdb->{appinfo}{dirtyFields}
27
28       I don't know what these are.
29
30           $pdb->{appinfo}{fieldLabels}{name}
31           $pdb->{appinfo}{fieldLabels}{firstName}
32           $pdb->{appinfo}{fieldLabels}{company}
33           $pdb->{appinfo}{fieldLabels}{phone1}
34           $pdb->{appinfo}{fieldLabels}{phone2}
35           $pdb->{appinfo}{fieldLabels}{phone3}
36           $pdb->{appinfo}{fieldLabels}{phone4}
37           $pdb->{appinfo}{fieldLabels}{phone5}
38           $pdb->{appinfo}{fieldLabels}{phone6}
39           $pdb->{appinfo}{fieldLabels}{phone7}
40           $pdb->{appinfo}{fieldLabels}{phone8}
41           $pdb->{appinfo}{fieldLabels}{address}
42           $pdb->{appinfo}{fieldLabels}{city}
43           $pdb->{appinfo}{fieldLabels}{state}
44           $pdb->{appinfo}{fieldLabels}{zipCode}
45           $pdb->{appinfo}{fieldLabels}{country}
46           $pdb->{appinfo}{fieldLabels}{title}
47           $pdb->{appinfo}{fieldLabels}{custom1}
48           $pdb->{appinfo}{fieldLabels}{custom2}
49           $pdb->{appinfo}{fieldLabels}{custom3}
50           $pdb->{appinfo}{fieldLabels}{custom4}
51           $pdb->{appinfo}{fieldLabels}{note}
52
53       These are the names of the various fields in the address record.
54
55           $pdb->{appinfo}{country}
56
57       An integer: the code for the country for which these labels were
58       designed. The country name is available as
59
60               $Palm::Address::countries[$pdb->{appinfo}{country}];
61
62           $pdb->{appinfo}{misc}
63
64       An integer. The least-significant bit is a flag that indicates whether
65       the database should be sorted by company. The other bits are reserved.
66
67   Sort block
68           $pdb->{sort}
69
70       This is a scalar, the raw data of the sort block.
71
72   Records
73           $record = $pdb->{records}[N];
74
75           $record->{fields}{name}
76           $record->{fields}{firstName}
77           $record->{fields}{company}
78           $record->{fields}{phone1}
79           $record->{fields}{phone2}
80           $record->{fields}{phone3}
81           $record->{fields}{phone4}
82           $record->{fields}{phone5}
83           $record->{fields}{address}
84           $record->{fields}{city}
85           $record->{fields}{state}
86           $record->{fields}{zipCode}
87           $record->{fields}{country}
88           $record->{fields}{title}
89           $record->{fields}{custom1}
90           $record->{fields}{custom2}
91           $record->{fields}{custom3}
92           $record->{fields}{custom4}
93           $record->{fields}{note}
94
95       These are scalars, the values of the various address book fields.
96
97           $record->{phoneLabel}{phone1}
98           $record->{phoneLabel}{phone2}
99           $record->{phoneLabel}{phone3}
100           $record->{phoneLabel}{phone4}
101           $record->{phoneLabel}{phone5}
102
103       Most fields in an AddressBook record are straightforward: the "name"
104       field always gives the person's last name.
105
106       The "phoneN" fields, on the other hand, can mean different things in
107       different records. There are five such fields in each record, each of
108       which can take on one of eight different values: "Work", "Home", "Fax",
109       "Other", "E-mail", "Main", "Pager" and "Mobile".
110
111       The $record->{phoneLabel}{phone*} fields are integers. Each one is an
112       index into @Palm::Address::phoneLabels, and indicates which particular
113       type of phone number each of the $record->{phone*} fields represents.
114
115           $record->{phoneLabel}{display}
116
117       Like the phone* fields above, this is an index into
118       @Palm::Address::phoneLabels. It indicates which of the phone* fields to
119       display in the list view.
120
121           $record->{phoneLabel}{reserved}
122
123       I don't know what this is.
124

METHODS

126   new
127         $pdb = new Palm::Address;
128
129       Create a new PDB, initialized with the various Palm::Address fields and
130       an empty record list.
131
132       Use this method if you're creating an Address PDB from scratch.
133
134   new_Record
135         $record = $pdb->new_Record;
136
137       Creates a new Address record, with blank values for all of the fields.
138       The AppInfo block will contain only an "Unfiled" category, with ID 0.
139
140       "new_Record" does not add the new record to $pdb. For that, you want
141       "$pdb->append_Record".
142

CONFIGURATION AND ENVIRONMENT

149       Palm::Address requires no configuration files or environment variables.
150

INCOMPATIBILITIES

152       None reported.
153

BUGS AND LIMITATIONS

155       The "new()" method initializes the AppInfo block with English labels
156       and "United States" as the country.
157

AUTHORS

159       Andrew Arensburger "<arensb AT ooblick.com>"
160
161       Currently maintained by Christopher J. Madsen "<perl AT cjmweb.net>"
162
163       Please report any bugs or feature requests to
164       "<bug-Palm AT rt.cpan.org>" or through the web interface at
165       <http://rt.cpan.org/Public/Bug/Report.html?Queue=Palm>.
166
167       You can follow or contribute to p5-Palm's development at
168       <https://github.com/madsen/p5-Palm>.
169

COPYRIGHT AND LICENSE

171       This software is copyright (c) 2003 by Andrew Arensburger & Alessandro
172       Zummo.
173
174       This is free software; you can redistribute it and/or modify it under
175       the same terms as the Perl 5 programming language system itself.
176

DISCLAIMER OF WARRANTY

178       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
179       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
180       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
181       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
182       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
183       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
184       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
185       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
186       NECESSARY SERVICING, REPAIR, OR CORRECTION.
187
188       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
189       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
190       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE
191       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
192       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
193       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
194       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
195       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
196       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
197       DAMAGES.
198
199
200
201perl v5.32.0                      2020-07-28                  Palm::Address(3)