File: pdb_Read.3

package info (click to toggle)
coldsync 3.0%2Bpre3-3
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 3,188 kB
  • ctags: 2,033
  • sloc: ansic: 20,386; perl: 2,302; cpp: 1,640; yacc: 1,102; lex: 802; makefile: 533; sh: 177
file content (59 lines) | stat: -rw-r--r-- 1,337 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.\" pdb_Read.3
.\" 
.\" Copyright 2001, Andrew Arensburger.
.\" You may distribute this file under the terms of the Artistic
.\" License, as specified in the README file.
.\"
.\" $Id: pdb_Read.3,v 1.1 2001/11/20 14:35:26 arensb Exp $
.\"
.\" This man page uses the 'mdoc' formatting macros. If your 'man' uses
.\" the old 'man' package, you may run into problems.
.\"
.Dd Aug 16, 2001
.Dt pdb_Read 3
.Sh NAME
.Nm pdb_Read
.Nm pdb_Write
.Nd read, write Palm database files
.Sh LIBRARY
.Pa libpdb
.Sh SYNOPSIS
.Fd #include <pdb.h>
.Ft struct pdb *
.Fn pdb_Read "int fd"
.Ft int
.Fn pdb_Write "const struct pdb *db" "int fd"
.Sh DESCRIPTION
.Nm pdb_Read
reads a Palm PDB or PRC file from the file descriptor
.Fa fd ,
which must already have been opened for reading.
.Fa fd
must be seekable.
.Pp
.Nm pdb_Read
allocates a new
.Ft struct pdb
and returns a pointer to it. This should later be freed using
.Fn free_pdb .
.Pp
.Fn pdb_Write
writes the PDB pointed to by
.Fa db
to the file descriptor
.Fa fd ,
which must already be opened for writing.
.Fa fd
need not be seekable.
.Sh RETURN VALUE
.Nm pdb_Read
returns a pointer to a newly-allocated
.Ft struct pdb
if successful, or NULL in case of error.
.Pp
.Nm pdb_Write
returns 0 if successful, or a negative value in case of error.
.Sh SEE ALSO
.Xr libpdb 3 ,
.Xr new_pdb 3 ,
.Xr free_pdb 3 .