RtgvSharedBufferPop

RtgvSharedBufferPop pops the oldest filled image off the front of a shared buffer.

Syntax

Copy
PRTGV_FRAME RtgvSharedBufferPop(
    [in]    HANDLE hBuffer
);

Parameters

[in] hBuffer

A handle to the shared buffer.

Return Values

Returns a pointer to the retrieved image if the function succeeds. Otherwise, it returns NULL. Call GetLastError to obtain an error code.

Remarks

If there are no filled images in the shared buffer (i.e. RtgvSharedBufferPush has never been called on the buffer, or all the filled images have already been popped off the buffer), this function will fail.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtgvComm.h

RtgvComm.lib

See Also: