RtgvSharedBufferPush

RtgvSharedBufferPush pushes a filled image onto the end of a shared buffer.

Syntax

Copy
BOOL RtgvSharedBufferPush(
    [in]    HANDLE hBuffer, 
    [in]    PRTGV_FRAME pImage
);

Parameters

[in] hBuffer

A handle to the shared buffer onto which the RTGV_FRAME will be pushed.

[in] pImage

A pointer to the RTGV_FRAME that will be pushed onto the shared buffer. This should be retrieved by calling RtgvSharedBufferGetEmptyFrame

Return Values

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Remarks

If RtgvSharedBufferGetEmptyFrame fails, meaning there are no empty frames, then RtgvSharedBufferPop can be called instead, which will return a pointer to the oldest image in the shared buffer.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtgvComm.h

RtgvComm.lib

See Also: