libpconn(3)

NAME

libpconn - library for communicating with PalmOS devices

SYNOPSIS

#include <palm.h>
#include <pconn/pconn.h>
Function prototypes are given in their respective man pages.
If
libpconn  was  built with I18N support, you may need to link
with -lintl

DESCRIPTION

The libpconn library provides functions for communicating

with PalmOS devices. It supports serial, USB (under FreeBSD), and

TCP connections, though the latter are still greatly experimen

tal.

VARIABLES

libpconn defines the following variables:

int palm_errno

Very similar to errno, int palm_errno is set whenever

an error occurs in a libpconn function. The value indicates the

error. Possible values are the PALMERR_* values defined in

<pconn/palm_errno.h>.

const char *palm_errlist[]

An array of strings giving error messages corresponding

to the PALMERR_* values.

const int palm_numerrs

The number of entries in palm_errlist.

FUNCTIONS

libpconn includes the following functions, which are de

scribed in their respective manual pages:

PConnection * new_PConnection(char *fname, int listenType,

const unsigned short flags)

int PConnClose(PConnection *pconn)

int PConn_bind(PConnection *pconn, const void *addr, const

int addrlen)

int DlpReadUserInfo(PConnection *pconn, struct dlp_userinfo

*userinfo)

int DlpWriteUserInfo(PConnection *pconn, const struct

dlp_setuserinfo *userinfo)

int DlpReadSysInfo(PConnection *pconn, struct dlp_sysinfo

*sysinfo)

int DlpGetSysDateTime(PConnection *pconn, struct dlp_time

*ptime)

int DlpSetSysDateTime(PConnection *pconn, const struct

dlp_time *ptime)

int DlpReadStorageInfo(PConnection *pconn, const ubyte card,

ubyte *last_card, ubyte *more, struct dlp_cardinfo *cinfo)

int DlpReadDBList(PConnection *pconn, const ubyte iflags,

const int card, const uword start, uword *last_index, ubyte

*oflags, ubyte *num, struct dlp_dbinfo *dbs)

int DlpOpenDB(PConnection *pconn, int card, const char

*name, ubyte mode, ubyte *dbhandle)

int DlpCreateDB(PConnection *pconn, const struct

dlp_createdbreq *newdb, ubyte *dbhandle)

int DlpCloseDB(PConnection *pconn, ubyte dbhandle)

int DlpDeleteDB(PConnection *pconn, const int card, const

char *name)

int DlpReadAppBlock(PConnection *pconn, const ubyte handle,

const uword offset, const uword len, uword *size, const ubyte

**data)

int DlpWriteAppBlock(PConnection *pconn, const ubyte handle,

const uword len, const ubyte *data)

int DlpReadSortBlock(PConnection *pconn, const ubyte handle,

const uword offset, const uword len, uword *size, const ubyte

**data)

int DlpWriteSortBlock(PConnection *pconn, const ubyte

handle, const uword len, const ubyte *data)

int DlpReadNextModifiedRec(PConnection *pconn, const ubyte

handle, struct dlp_recinfo *recinfo, const ubyte **data)

int DlpReadRecordByID(PConnection *pconn, const ubyte

handle, const udword id, const uword offset, const uword len,

struct dlp_recinfo *recinfo, const ubyte **data)

int DlpReadRecordByIndex(PConnection *pconn, const ubyte

handle, const uword index, struct dlp_recinfo *recinfo)

int DlpWriteRecord(PConnection *pconn, const ubyte handle,

const ubyte flags, const udword id, const ubyte attributes, const

ubyte category, const udword len, const ubyte *data, udword

*recid)

int DlpDeleteRecord(PConnection *pconn, const ubyte handle,

const ubyte flags, const udword recid)

int DlpReadResourceByIndex(PConnection *pconn, const ubyte

handle, const uword index, const uword offset, const uword len,

struct dlp_resource *value, const ubyte **data)

int DlpReadResourceByType(PConnection *pconn, const ubyte

handle, const udword type, const uword id, const uword offset,

const uword len, struct dlp_resource *value, ubyte *data)

int DlpWriteResource(PConnection *pconn, const ubyte handle,

const udword type, const uword id, const uword size, const ubyte

*data)

int DlpDeleteResource(PConnection *pconn, const ubyte

handle, const ubyte flags, const udword type, const uword id)

int DlpCleanUpDatabase(PConnection *pconn, const ubyte

handle)

int DlpResetSyncFlags(PConnection *pconn, const ubyte

handle)

int DlpCallApplication(PConnection *pconn, const udword

version, const struct dlp_appcall *appcall, const udword

paramsize, const ubyte *param, struct dlp_appresult *appresult)

int DlpResetSystem(PConnection *pconn)

int DlpAddSyncLogEntry(PConnection *pconn, const char *msg)

int DlpReadOpenDBInfo(PConnection *pconn, ubyte handle,

struct dlp_opendbinfo *dbinfo)

int DlpMoveCategory(PConnection *pconn, const ubyte handle,

const ubyte from, const ubyte to)

int DlpOpenConduit(PConnection *pconn)

int DlpEndOfSync(PConnection *pconn, const ubyte status)

int DlpResetRecordIndex(PConnection *pconn, const ubyte

handle)

int DlpReadRecordIDList(PConnection *pconn, const ubyte

handle, const ubyte flags, const uword start, const uword max,

uword *numread, udword recids[])

int DlpReadNextRecInCategory(PConnection *pconn, const ubyte

handle, const ubyte category, struct dlp_recinfo *recinfo, const

ubyte **data)

int DlpReadNextModifiedRecInCategory(PConnection *pconn,

const ubyte handle, const ubyte category, struct dlp_recinfo

*recinfo, const ubyte **data)

int DlpReadAppPreference(PConnection *pconn, const udword

creator, const uword id, const uword len, const ubyte flags,

struct dlp_apppref *pref, ubyte *data)

int DlpWriteAppPreference(PConnection *pconn, const udword

creator, const uword id, const ubyte flags, const struct

dlp_apppref *pref, const ubyte *data)

int DlpReadNetSyncInfo(PConnection *pconn, struct

dlp_netsyncinfo *netsyncinfo)

int DlpWriteNetSyncInfo(PConnection *pconn, const ubyte

modflags, const struct dlp_netsyncinfo *newinfo)

int DlpReadFeature(PConnection *pconn, const udword creator,

const word featurenum, udword *value)

int DlpRPC(PConnection *pconn, uword trap, udword *D0,

udword *A0, int argc, struct DLPRPC_param *argv)

int RDLP_Backlight(PConnection *pconn, Bool set, Bool

newState)

int RDLP_BatteryLevel(PConnection *pconn)

int RDLP_PluggedIn(PConnection *pconn)

int RDLP_ROMToken(PConnection *pconn, uword cardno, udword

token, udword *data_ptr, uword *data_len)

int RDLP_MemHandleNew(PConnection *pconn, udword size)

int RDLP_GetOSVersionString(PConnection *pconn)

int RDLP_BatteryDialog(PConnection *pconn)

int RDLP_MemMove(PConnection *pconn, ubyte *dst, const

udword src, const udword len)

int RDLP_MemReadable(PConnection *pconn, udword addr)

time_t time_dlp2time_t(const struct dlp_time *dlpt)

udword time_dlp2palmtime(const struct dlp_time *dlpt)

void time_time_t2dlp(const time_t t, struct dlp_time *dlpt)

void time_palmtime2dlp(const udword palmt, struct dlp_time

*dlpt)

RETURN VALUES

When a libpconn function encounters an error, it sets

palm_errno to one of the PALMERR_* values defined in

<pconn/palm_errno.h>.

AUTHORS

Andrew Arensburger <arensb@ooblick.com>

POSIX July 10, 2001

POSIX