Philippe Chane You Kaye > Isam > Isam

Download:
Isam-0.2.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.2   Source  

NAME ^

Isam - Perl extension for ISAM files

SYNOPSIS ^

use Isam;

DESCRIPTION ^

Isam.pm is a thin wrapper to the C-ISAM functions calls. IsamData.pm is a facility to access the record's fields.

Exported constants ^

  AUDGETNAME
  AUDHEADSIZE
  AUDINFO
  AUDSETNAME
  AUDSTART
  AUDSTOP 
  CHARTYPE
  DECIMALTYPE
  DOUBLETYPE
  FLOATTYPE
  INTTYPE
  LONGTYPE
  MINTTYPE
  MLONGTYPE
  STRINGTYPE
  ISAUTOLOCK
  ISCLOSED
  ISCURR
  ISD1
  ISD2
  ISDD
  ISDESC
  ISDUPS
  ISEQUAL
  ISEXCLLOCK
  ISFIRST
  ISFIXLEN
  ISGREAT
  ISGTEQ
  ISINOUT
  ISINPUT
  ISLAST
  ISLCKW
  ISLOCK
  ISMANULOCK
  ISMASKED
  ISNEXT
  ISNOCARE
  ISNODUPS
  ISNOLOG
  ISOUTPUT
  ISPREV
  ISRDONLY
  ISSYNCWR
  ISTRANS
  ISVARCMP
  ISVARLEN
  ISWAIT

AUTHOR ^

Philippe Chane-You-Kaye, philippe.cyk@wanadoo.fr

METHODS ^

Isam.pm module include class methods indicated by Isam->method and object methods indicated by $fd->method where $fd is a reference to an instance obtained by isopen, isbuild or iscluster eg. my $fd = Isam->isopen("myfile",&ISINOUT);

Isam->iserrno([INTVALUE])

Returns the value of the global Isam variable iserrno unless INTVALUE is specified, in which case, sets the value of iserrno.

Isam->isrecnum([LONGVALUE])

Returns the value of the global Isam variable isrecnum unless LONGVALUE is specified, in which case, sets the value of isrecnum.

Isam->isreclen([INTVALUE])

Returns the value of the global Isam variable isreclen unless INTVALUE is specified, in which case, sets the value of isreclen.

Isam->iserrio([INTVALUE])

Returns the value of the global Isam variable iserrio unless INTVALUE is specified, in which case, sets the value of iserrio.

$fd->fd

Returns Isam file descriptor

$fd->name

Returns the filename

$fd->isaddindex(KEYDESC)

Returns TRUE if successfully adds an index to $fd

Isam->isbuild(NAME, LEN, KEYDESC, MODE)

Returns a reference to an Isam object or undef if unsuccessful

Isam->iscleanup

Returns TRUE if successful

$fd->isclose

Returns TRUE if successful

$fd->iscluster(KEYDESC)

KEYDESC is a reference to a Keydesc object. Returns a reference to an Isam object or undef if unsuccessful

Isam->iscommit

Returns TRUE if successful

$fd->isdelcurr

Returns TRUE if successful

$fd->isdelete(DATA)

DATA is a reference to a scalar. Returns TRUE if successful

$fd->isdelindex(KEYDESC)

KEYDESC is a reference to a Keydesc object. Returns TRUE if successful

$fd->isdelrec(RECNUM)

RECNUM is a long integer Returns TRUE if successful

Isam->iserase(NAME)

NAME is a filename. Returns TRUE if successful

$fd->isflush

Returns TRUE if successful

$fd->isindexinfo(IDX)

IDX is an integer. returns undef if unsuccessful. If IDX == 0, returns a reference to a Dictinfo object. If IDX > 0, returns a reference to a Keydesc object

$fd->islock

Returns TRUE if successful

Isam->islogclose

Returns TRUE if successful

Isam->islogopen

Returns TRUE if successful

Isam->isopen(NAME, MODE)

NAME is a filename, MODE is an integer Returns undef if unsuccessful, otherwise returns a reference to an Isam object

$fd->isread(DATA, MODE)

DATA is a reference to a scalar. MODE is an integer. Returns TRUE if successful

Isam->isrecover

Returns TRUE if successful

$fd->isrelease

Returns TRUE if successful

Isam->isrename(OLDNAME, NEWNAME)

Returns TRUE if successful

$fd->isrewcurr(DATA)

DATA is a reference to a scalar. Returns TRUE if successful

$fd->isrewrec(RECNUM, DATA)

RECNUM is the record number, DATA is a reference to the Data. Returns TRUE if successful

$fd->isrewrite(DATA)

DATA is a reference to the Data. Returns TRUE if successful

Isam->isrollback

Returns TRUE if successful

$fd->issetunique(UNIQUEID)

UNIQUEID is an integer scalar. Returns TRUE if successful

$fd->isstart(KEYDESC, LENGTH, DATA, MODE)

KEYDESC is a reference to a Keydesc object, LENGTH is 0 or the number of bytes of the key, DATA is a reference to a scalar, MODE is an integer value.

Returns TRUE if successful

$fd->isuniqueid

Returns undef if unsuccessful or an long value

$fd->isunlock

Returns TRUE if successful

$fd->iswrcurr(DATA)

DATA is a reference to a scalar. Returns TRUE if successful

$fd->iswrite(DATA)

DATA is a reference to a scalar. Returns TRUE if successful

SEE ALSO ^

SEE ALSO ^

perl(1). IsamData.

syntax highlighting: