Sign in Join
FPDoc Onlineexperiment

TLazFifoQueue.PushItem function

Member of TLazFifoQueuepublicIn unit LazCollections

Pushes an item of the specified type onto the tail of the queue.

Declaration

pascal
function PushItem(const AItem: T): Boolean; virtual

Arguments

AItem

Item added to the tail of the queue.

Function result

True if the specified item was added to the queue, or False when the queue is full.

Description

Pushitem is a Boolean function used to add the value in AItem to the tail of the queue. The return value is True if the queue was not full when the method was called. No actions are performed in the method when a slot is not available in the internal storage for the queue.

PushItem stores the value in AItem at the next element in the internal array, and increments the value in the TotalItemsPushed property.

Use PopItem to remove the item at the head of the queue.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.