Little Database (LDB) Action Plugin Help File

Little Database (LDB) Action Plugin Help File

Plugin Name:

Little Database (LDB) Action Plugin

Current Version:

1.0.0.1

Description:

Little Database (LDB) Action Plugin for managing little local Database ( Little DataBase = LDB )

Licence:

Freeware

Author:

RizlaUK @ D-Net Software

Web:

www.dnet-software.com

E-mail:

support@dnet-software.com

Copyright:

D-Net Software


Table of Contents

LDB.Open
LDB.Create
LDB.InsertRecord
LDB.Save
LDB.Write
LDB.CountRecords
LDB.Read
LDB.SetPointer
LDB.GetPointer
LDB.DeleteRecord
LDB.CountFields
LDB.GetFieldName
LDB.NextRecord
LDB.PrevRecord
LDB.Close
LDB.WriteCell
LDB.ReadCell

LDB.Open


(boolean) LDB.Open ( 

(string) File )

Description

Open an existing LDB file.

Parameters

File

(string) The full path to the LDB file.

Returns

(boolean)


LDB.Create


(boolean) LDB.Create ( 

(string) File,

(string) Fields )

Description

Create a new empty database with the given fields

Parameters

File

(string) Full path to a LDB file, if the file exists it will be over written.

Fields

(string) Comma separated string of header fields.

Returns

(boolean)


LDB.InsertRecord


LDB.InsertRecord ( 

(number) Index )

Description

Insert a record at position 'Index', -1 add a record as the last record

Parameters

Index

(number) The index where to insert the record, use -1 for last record.

Returns

This action dose not return any value.


LDB.Save


LDB.Save ()

Description

Saves the current LDB file to disk.

Returns

This action dose not return any value.


LDB.Write


LDB.Write ( 

(number) Field,

(string) Text )

Description

Write text in the field 'Field'

Parameters

Field

(number) The index of the field to write to

Text

(string) The text to write.

Returns

This action dose not return any value.


LDB.CountRecords


(number) LDB.CountRecords ()

Description

Return the number of records in the LDB file

Returns

(number)


LDB.Read


(string) LDB.Read ( 

(number) Field )

Description

Read the specified field in the current record ( 0 return "" )

Parameters

Field

(number) The index of the field to read

Returns

(string)


LDB.SetPointer


LDB.SetPointer ( 

(number) Index )

Description

Set the index of the current record

Parameters

Index

(number) The index of the current record.

Returns

This action dose not return any value.


LDB.GetPointer


(number) LDB.GetPointer ()

Description

Get the index of the current record.

Returns

(number)


LDB.DeleteRecord


LDB.DeleteRecord ( 

(number) Index )

Description

Delete the record at the given index.

Parameters

Index

(number) The index of the record to delete

Returns

This action dose not return any value.


LDB.CountFields


(number) LDB.CountFields ()

Description

Count the number of Fields

Returns

(number)


LDB.GetFieldName


(string) LDB.GetFieldName ( 

(number) Index )

Description

Get a field name

Parameters

Index

(number) The index of the feild to get the name of.

Returns

(string)


LDB.NextRecord


LDB.NextRecord ()

Description

Set the pointer to the next record

Returns

This action dose not return any value.


LDB.PrevRecord


LDB.PrevRecord ()

Description

Set the pointer to the previous record.

Returns

This action dose not return any value.


LDB.Close


LDB.Close ()

Description

Close the open Database

Returns

This action dose not return any value.


LDB.WriteCell


LDB.WriteCell ( 

(number) Row,

(number) Cell,

(string) Text )

Description

Write text in the indecated Cell.

Parameters

Row

(number) The index of the row the cell is in.

Cell

(number) The index of the cell to write to.

Text

(string) The text to write.

Returns

This action dose not return any value.


LDB.ReadCell


(string) LDB.ReadCell ( 

(number) Row,

(number) Cell )

Description

Reads text from the indecated Cell.

Parameters

Row

(number) The index of the row the cell is in.

Cell

(number) The index of the cell to write to.

Returns

(string)



D-Net Software
This File Was Generated With AMS ActionFile Editor