Packet Sniffer SDK DLL Edition

HNQueue :: Methods :: QueGetFullItem

 Previous Next

Returns an element with Full status from the queue.

Syntax:

HANDLE __stdcall QueGetFullItem(HANDLE hQue, DWORD Milliseconds);

Parameters:

hQue

[in] HNQueue object handle.

Milliseconds

[in] Specifies the time-out interval, in milliseconds. The function returns if the interval elapses, even if the object's state is nonsignaled. If Milliseconds is zero, the function tests the object's state and returns immediately. If Milliseconds is INFINITE(0xFFFFFFFF), the function's time-out interval never elapses.

Return values:

If this function succeeds, then an HNPacket object with Full status will be returned. If returned value is NULL, then there are no full elements or the status of the thread awaiting for packet enqueueing was changed by the QueUnblockWaitFull function.

Description:

Use QueGetFullItem to get free element from the queue. After this function is executed FullCount [Get] property is changed.

Also, please take in account, that after an element of the queue is processed, you should return it to the queue using QueReturnFullItem or QueReturnFreeItem functions.

See also:HNQueue, HNPacket, QueUnblockWaitFull, QueGetFullCount, QueReturnFreeItem, QueReturnFullItem