1Pilot(3)              User Contributed Perl Documentation             Pilot(3)
2
3
4
5
6       Commands include:
7
8       Notice! This information is out of date, and potentially quite
9       misleading.
10
11       PDA::Pilot::Appointment::Unpack(buffer)
12           Returns hash reference containing appointment (datebook entry) in a
13           usable format, given a record from a .pdb file or a Pilot database.
14
15       PDA::Pilot::Appointment::Pack(buffer)
16           Given a hash reference in the form that the previous call
17           generates, returns a single string suitable for storing in a
18           Pilot's database.
19
20       PDA::Pilot::Appointment::UnpackAppInfo(buffer)
21           Returns hash reference containing appointment (datebook entry) in a
22           usable format, given the AppInfo record from a .pdb file or a Pilot
23           database.
24
25       PDA::Pilot::Appointment::PackAppInfo(buffer)
26           Given a hash reference in the form that the previous call
27           generates, returns a single string suitable for storing in a
28           Pilot's database AppInfo block.
29
30       PDA::Pilot::Memo::Unpack(buffer)
31           Returns hash reference containing appointment (datebook entry) in a
32           usable format, given a record from a .pdb file or a Pilot database.
33
34       PDA::Pilot::Memo::Pack(buffer)
35           Given a hash reference in the form that the previous call
36           generates, returns a single string suitable for storing in a
37           Pilot's database.
38
39       PDA::Pilot::Memo::UnpackAppInfo(buffer)
40           Returns hash reference containing appointment (datebook entry) in a
41           usable format, given the AppInfo record from a .pdb file or a Pilot
42           database.
43
44       PDA::Pilot::Memo::PackAppInfo(buffer)
45           Given a hash reference in the form that the previous call
46           generates, returns a single string suitable for storing in a
47           Pilot's database AppInfo block.
48
49       PDA::Pilot::ToDo::Unpack(buffer)
50           Returns hash reference containing appointment (datebook entry) in a
51           usable format, given a record from a .pdb file or a Pilot database.
52
53       PDA::Pilot::ToDo::Pack(buffer)
54           Given a hash reference in the form that the previous call
55           generates, returns a single string suitable for storing in a
56           Pilot's database.
57
58       PDA::Pilot::ToDo::UnpackAppInfo(buffer)
59           Returns hash reference containing appointment (datebook entry) in a
60           usable format, given the AppInfo record from a .pdb file or a Pilot
61           database.
62
63       PDA::Pilot::ToDo::PackAppInfo(buffer)
64           Given a hash reference in the form that the previous call
65           generates, returns a single string suitable for storing in a
66           Pilot's database AppInfo block.
67
68       PDA::Pilot::Address::Unpack(buffer)
69           Returns hash reference containing appointment (datebook entry) in a
70           usable format, given a record from a .pdb file or a Pilot database.
71
72       PDA::Pilot::Address::Pack(buffer)
73           Given a hash reference in the form that the previous call
74           generates, returns a single string suitable for storing in a
75           Pilot's database.
76
77       PDA::Pilot::Address::UnpackAppInfo(buffer)
78           Returns hash reference containing appointment (datebook entry) in a
79           usable format, given the AppInfo record from a .pdb file or a Pilot
80           database.
81
82       PDA::Pilot::Address::PackAppInfo(buffer)
83           Given a hash reference in the form that the previous call
84           generates, returns a single string suitable for storing in a
85           Pilot's database AppInfo block.
86
87       PDA::Pilot::Mail::Unpack(buffer)
88           Returns hash reference containing appointment (datebook entry) in a
89           usable format, given a record from a .pdb file or a Pilot database.
90
91       PDA::Pilot::Mail::Pack(buffer)
92           Given a hash reference in the form that the previous call
93           generates, returns a single string suitable for storing in a
94           Pilot's database.
95
96       PDA::Pilot::Mail::UnpackAppInfo(buffer)
97           Returns hash reference containing appointment (datebook entry) in a
98           usable format, given the AppInfo record from a .pdb file or a Pilot
99           database.
100
101       PDA::Pilot::Mail::PackAppInfo(buffer)
102           Given a hash reference in the form that the previous call
103           generates, returns a single string suitable for storing in a
104           Pilot's database AppInfo block.
105
106       PDA::Pilot::Socket::socket(domain, type, protocol)
107           Same as pi-link routine called pi_socket.
108
109       PDA::Pilot::Socket::close(socket)
110           Same as pi-link routine called pi_close.
111
112       PDA::Pilot::Socket::write(socket, string)
113           Same as pi-link routine called pi_write.
114
115       PDA::Pilot::Socket::read(socket, len)
116           Same as pi-link routine called pi_write (returns read data as
117           result.)
118
119       PDA::Pilot::Socket::listen(socket, backlog)
120           Same as pi-link routine called pi_listen.
121
122       PDA::Pilot::Socket::bind(socket, sockaddr)
123           Same as pi-link routine called pi_bind. Sockaddr may either be a
124           packed string containing a pi_sockaddr structure, or a hash
125           reference containing "device", "family", and "port" keys.
126
127       PDA::Pilot::Socket::accept(socket)
128           Same as pi-link routine called pi_accept. If connection is
129           successfull, returns reference to hash containing remote address,
130           as described above. If failed, returns undef.
131
132       PDA::Pilot::DLP::errno()
133           Returns last DLP error, resetting error to zero.
134
135       PDA::Pilot::DLP::GetSysDateTime(socket)
136           Same as DLP call dlp_GetSysDateTime. If successfull, returns time,
137           otherwise returns undef.
138
139       PDA::Pilot::DLP::SetSysDateTime(socket, time)
140           Same as DLP call dlp_SetSysDateTime. time must be a time_t value.
141
142       PDA::Pilot::DLP::ReadSysInfo(socket)
143           Same as DLP call dlp_ReadSysInfo. If successfull, returns reference
144           to hash containing system information.
145
146       PDA::Pilot::DLP::ReadStorageInfo(socket, cardno)
147           Same as DLP call dlp_ReadStorageInfo. If successfull, returns
148           reference to hash containing information on given memory card.
149
150       PDA::Pilot::DLP::ReadUserInfo(socket)
151           Same as DLP call dlp_ReadUserInfo. If successfull, returns
152           reference to hash containing information about user settings.
153
154       PDA::Pilot::DLP::WriteUserInfo(socket, info)
155           Same as DLP call dlp_WriteUserInfo. info must be a reference to a
156           hash containing data similar to that returned by ReadUserInfo
157           (Note: the password can not be set through this call.)
158
159       PDA::Pilot::DLP::OpenDB(socket, cardno, mode, name)
160           Same as DLP call dlp_OpenDB. If successfull returns database
161           handle, otherwise returns undef.
162
163       PDA::Pilot::DLP::CloseDB(socket, handle)
164           Same as DLP call dlp_CloseDB.
165
166       PDA::Pilot::DLP::EndOfSync(socket, status)
167           Same as DLP call dlp_EndOfSync.
168
169       PDA::Pilot::DLP::AbortSync(socket)
170           Same as DLP call dlp_AbortSync.
171
172       PDA::Pilot::DLP::MoveCategory(socket, handle, fromcat, tocat)
173           Same as DLP call dlp_MoveCategory.
174
175       PDA::Pilot::DLP::ResetSystem(socket)
176           Same as DLP call dlp_ResetSystem.
177
178       PDA::Pilot::DLP::OpenConduit(socket)
179           Same as DLP call dlp_OpenConduit.
180
181       PDA::Pilot::DLP::AddSyncLogEntry(socket, message)
182           Same as DLP call dlp_AddSyncLogEntry
183
184       PDA::Pilot::DLP::CleanUpDatabase(socket, handle)
185           Same as DLP call dlp_CleanUpDatabase.
186
187       PDA::Pilot::DLP::ResetSyncFlags(socket, handle)
188           Same as DLP call dlp_ResetSyncFlags.
189
190       PDA::Pilot::DLP::ResetDBIndex(socket, handle)
191           Same as DLP call dlp_ResetDBIndex.
192
193       PDA::Pilot::DLP::ResetLastSyncPC(socket)
194           Same as DLP call dlp_ResetLastSyncPC.
195
196       PDA::Pilot::DLP::DeleteCategory(socket, handle, category)
197           Same as DLP call dlp_DeleteCategory.
198
199       PDA::Pilot::DLP::DeleteRecord(socket, handle, all, id)
200           Same as DLP call dlp_DeleteRecord.
201
202       PDA::Pilot::DLP::ReadDBList(socket, cardno, flags, start)
203           Same as DLP call dlp_ReadDBList. If successfull, returns reference
204           to hash containing DB information. If failed, returns undef.
205
206       PDA::Pilot::DLP::FindDBInfo(socket, cardno, flags, name, type, creator)
207           Same as DLP call dlp_FindDBInfo. If successfull, returns reference
208           to hash containing DB information. If failed, returns undef.
209
210       PDA::Pilot::DLP::ReadFeature(socket, creator, number)
211           Same as DLP call dlp_ReadFeature. If successfull, returns feature
212           value. If failed, returns undef.
213
214       PDA::Pilot::DLP::ReadAppBlock(socket, handle)
215           Same as DLP call dlp_ReadAppBlock. If successfull, returns app
216           block. If failed, returns undef.
217
218       PDA::Pilot::DLP::ReadSortBlock(socket, handle)
219           Same as DLP call dlp_ReadSortBlock. If successfull, returns app
220           block. If failed, returns undef.
221
222       PDA::Pilot::DLP::WriteAppBlock(socket, handle, block)
223           Same as DLP call dlp_WriteAppBlock.
224
225       PDA::Pilot::DLP::WriteSortBlock(socket, handle, block)
226           Same as DLP call dlp_WriteSortBlock.
227
228       PDA::Pilot::DLP::ReadOpenDBInfo(socket, handle)
229           Same as DLP call dlp_ReadOpenDBInfo.
230
231       PDA::Pilot::DLP::ReadRecordByIndex(socket, handle, index)
232           Same as DLP call dlp_ReadRecordByIndex. If call fails, it returns
233           undef.  Otherwise, in scalar context it returns the read record, in
234           array it returns the record, id, index, attr, and category, in that
235           order.
236
237       PDA::Pilot::DLP::ReadRecordById(socket, handle, id)
238           Same as DLP call dlp_ReadRecordById. If call fails, it returns
239           undef.  Otherwise, in scalar context it returns the read record, in
240           array it returns the record, id, index, attr, and category, in that
241           order.
242
243       PDA::Pilot::DLP::ReadNextModifiedRec(socket, handle)
244           Same as DLP call dlp_ReadNextModifiedRec. If call fails, it returns
245           undef.  Otherwise, in scalar context it returns the read record, in
246           array it returns the record, id, index, attr, and category, in that
247           order.
248
249       PDA::Pilot::DLP::ReadNextRecInCategory(socket, handle, category)
250           Same as DLP call dlp_ReadNextRecInCategory. If call fails, it
251           returns undef.  Otherwise, in scalar context it returns the read
252           record, in array it returns the record, id, index, attr, and
253           category, in that order.
254
255       PDA::Pilot::DLP::ReadNextModifiedRecInCategory(socket, handle,
256       category)
257           Same as DLP call dlp_ReadNextModifiedRecInCategory. If call fails,
258           it returns undef.  Otherwise, in scalar context it returns the read
259           record, in array it returns the record, id, index, attr, and
260           category, in that order.
261
262       PDA::Pilot::DLP::WriteRecord(socket, handle, record, id, attr,
263       category)
264           Same as DLP call dlp_WriteRecord.
265
266       PDA::Pilot::DLP::ReadResourceByType(socket, handle, type, id)
267           Same as DLP call dlp_ReadResourceByType. If call fails, it returns
268           undef.  Otherwise, in scalar context it returns the read record, in
269           array it returns the record, type, id, and index, in that order.
270
271       PDA::Pilot::DLP::ReadResourceByIndex(socket, handle, index)
272           Same as DLP call dlp_ReadResourceByIndex. If call fails, it returns
273           undef.  Otherwise, in scalar context it returns the read record, in
274           array it returns the record, type, id, and index, in that order.
275
276       PDA::Pilot::DLP::WriteResource(socket, handle, record, type, id)
277           Same as DLP call dlp_WriteResource.
278
279       PDA::Pilot::DLP::DeleteResource(socket, handle, all, type, id)
280           Same as DLP call dlp_DeleteResource.
281
282       PDA::Pilot::DLP::CallApplication(socket, creator, type, action, data)
283           Same as DLP call dlp_CallApplication.
284
285       PDA::Pilot::File::open(name)
286           Same as pi_file_open. Returns a PDA::Pilot::File object on success.
287
288       PDA::Pilot::File::close(file)
289           Same as pi_file_close.
290
291       PDA::Pilot::File::get_app_info(file)
292           Same as pi_file_get_app_info.
293
294       PDA::Pilot::File::get_sort_info(file)
295           Same as pi_file_get_sort_info.
296
297       PDA::Pilot::File::get_entries(file)
298           Same as pi_file_get_entries.
299
300       PDA::Pilot::File::read_resource(file, index)
301           Same as pi_file_read_resource. Returns (record, type, id, index).
302
303       PDA::Pilot::File::read_record(file, index)
304           Same as pi_file_read_record. Returns (record, id, index, attr,
305           category).
306
307       PDA::Pilot::File::read_record_by_id(file, type, id)
308           Same as pi_file_read_record_by_id. Returns (record, id, index,
309           attr, category).
310
311       PDA::Pilot::File::create(name, info)
312           Same as pi_file_create. Info is reference to hash containg dbinfo
313           data.
314
315       PDA::Pilot::File::get_info(file)
316           Same as pi_file_get_info.
317
318       PDA::Pilot::File::set_info(file, info)
319           Same as pi_file_set_info.
320
321       PDA::Pilot::File::set_app_info(file, data)
322           Same as pi_file_set_app_info.
323
324       PDA::Pilot::File::set_sort_info(file, data)
325           Same as pi_file_set_sort_info.
326
327       PDA::Pilot::File::append_resource(file, data, type, id)
328           Same as pi_file_append_resource.
329
330       PDA::Pilot::File::append_record(file, data, attr, category, id)
331           Same as pi_file_append_record.
332
333       PDA::Pilot::File::install(file, socket, cardno)
334           Same as pi_file_install.
335
336       PDA::Pilot::File::retrieve(file, socket, cardno)
337           Same as pi_file_retrieve.
338
339
340
341perl v5.28.1                      2006-05-31                          Pilot(3)