Sign in Join
FPDoc Onlineexperiment

TLazThreadedQueue.PopItem function

Member of TLazThreadedQueuepublicIn unit LazCollections

Pops the next item from the queue.

Declaration

pascal
function PopItem(out AItem: T): TWaitResult

Arguments

AItem

Item removed from the queue.

Function result

Contains the status for the dequeue request.

Description

PopItem is a TWaitResult function used remove the next item available in the thread-safe queue. PopItem calls the PopItemTimeout method using the value in the PopTimeout property as an argument.

AItem is an output variable that is updated with the item removed from the queue in the method.

The return value contains a TWaitResult enumeration value that indicates the status for the dequeue request. See TWaitResult for more information about enumeration values and their meanings.

See also

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