Packet Sniffer SDK DLL Edition

HNQueue :: Methods :: QueGetFullItems

 Previous Next

Returns an elements with Full status from the queue.

Syntax:

DWORD __stdcall QueGetFullItems(HANDLE hQue, DWORD Milliseconds, PHANDLE hPackets, DWORD dwCount);

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.

hPackets

[in, out] Array of HNPacket objects handles.

dwCount

[in] The size of the array of HNPacket (see hPackets parameter). Means the quantity of objects which hPackets parameter contains.

Return values:

If this function succeeds, then the quantity of Full HNPacket objects copied to hPackets array will be returned. If returned value is equal to 0, then there are no free elements, or the status of the thread awaiting for packet enqueueing was changed by the QueUnblockWaitFree function.

Description:

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

Also, please take in account, that after an elements of the queue is processed, you should return them to the queue using QueReturnFullItem(QueReturnFullItems) or QueReturnFreeItem(QueReturnFreeItems) functions.

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