Public methods

The opt parameter

Many methods have the same parameter, opt, which is described under the abendCode method inabendCode.

clear

virtual void clear()

A synonym for empty. See Polymorphic Behavior for information on polymorphism.

empty

void empty()

Deletes all the temporary data associated with the IccTempStore object and deletes the associated TD queue.

Conditions

INVREQ, ISCINVREQ, NOTAUTH, QIDERR, SYSIDERR

get

virtual const IccBuf& get()

A synonym for readNextItem. See Polymorphic Behavior for information on polymorphism.

numberOfItems

unsigned short numberOfItems() const

Returns the number of items in temporary storage. This is only valid after a successful writeItem call.

put

virtual void put(const IccBuf& buffer)

buffer
A reference to an IccBuf object that contains the data that is to be added to the end of the temporary storage queue.

A synonym for writeItem. See Polymorphic Behavior for information on polymorphism.

readItem

const IccBuf& readItem(unsigned short itemNum)

itemNum
Specifies the item number of the logical record to be retrieved from the queue.

Reads the specified item from the temporary storage queue and returns a reference to the IccBuf object that contains the information.

Conditions

INVREQ, IOERR, ISCINVREQ, ITEMERR, LENGERR, NOTAUTH, QIDERR, SYSIDERR

readNextItem

const IccBuf& readNextItem()

Reads the next item from a temporary storage queue and returns a reference to the IccBuf object that contains the information.

Conditions

INVREQ, IOERR, ISCINVREQ, ITEMERR, LENGERR, NOTAUTH, QIDERR, SYSIDERR

rewriteItem

void rewriteItem (unsigned short itemNum,
                  const IccBuf& item,
                  NoSpaceOpt opt =
suspend)

The parameters are:

itemNum
Specifies the item number of the logical record that is to be modified
item
The name of the IccBuf object that contains the update data.
opt
An enumeration, defined in this class, that indicates whether the application program is to be suspended if a shortage of space in the queue prevents the record being added. suspend is the default.

This method updates the specified item in the temporary storage queue.

Conditions

INVREQ, IOERR, ISCINVREQ, ITEMERR, LENGERR, NOSPACE, NOTAUTH, QIDERR, SYSIDERR

writeItem (1)

unsigned short writeItem (const IccBuf& item,
                          NoSpaceOpt opt =
suspend)
item
The name of the IccBuf object that contains the data that is to added to the end of the temporary storage queue.
opt
An enumeration, defined in this class, that indicates whether the application program is to be suspended if a shortage of space in the queue prevents the record being added. suspend is the default.

writeItem (2)

unsigned short writeItem (const char* text,
                          NoSpaceOpt opt =
suspend)
text
The text string that is to added to the end of the temporary storage queue.
opt
An enumeration, defined in this class, that indicates whether the application program is to be suspended if a shortage of space in the queue prevents the record being added. suspend is the default.

This method adds a new record at the end of the temporary storage queue. The returned value is the item number that was created (if this was done successfully).

Conditions

INVREQ, IOERR, ISCINVREQ, ITEMERR, LENGERR, NOSPACE, NOTAUTH, QIDERR, SYSIDERR

[[ Contents Previous Page | Next Page Index ]]