ReadNote()

Reads the contents of a note pad.

Syntax

ReadNote(<cTable>, <cNotepad>, [cRecordKey], [cRecordKey2]) --> cNotepad

Arguments

<cTable> --> is the name of the database that contains the note pad.

<cNotePad> --> is the name of the note pad to read. You are not required to pass this parameter when accessing transaction based note pads, such as ORDERS or QUOTES. Or if accessing the stock note pad.

<cRecordKey> --> is the optionally specified record key to locate.

<cRecordKey2> --> is an optional second record key reference. This is used only with Back Order Control Centre notes when you wish to specify which line item to specifically retrieve a note for. it is not used when accessing transaction notes.

Returns

The contents of the note pad or an empty string "" if the read failed.

Description

This function is used to read information from a selected CAPITAL note pad.

Not all databases have note pads. These may be used:

The note pad name <cNotepad> must exist in the specified database.

When extracting Back Order Control Centre comments/notes, specify "O" for sales orders or "I" for invoices for the note pad name. Specify the transaction number as the record key. For example:

cNotes := ReadNote("Bonotes", "O", "1005")

Comments

The table you wish to access must be opened before calling this function.

Example #1

The following script reads the value of the note pad "Schedule" found in the card file database "Dockets" and stores the result in the string cNotes:

cNotes := ReadNote("Docket", "Schedule")

Example #2

The following script reads the value of the note pad for the Back Order Control Centre.

cNotes := ReadNote("BONotes", Borders->Invoiceno)

This script reads it for a specific line item of a back order:

cNotes := ReadNote("BONotes", Borders->Invoiceno, Borders->Lineref)

____________________________

Related Topics

Business Function List

WriteNote()