RtgvGetPayloadSize

RtgvGetPayloadSize gets the currently configured payload size on a camera.

Syntax

BOOL RtgvGetPayloadSize(
    [in]    HANDLE cameraHandle, 
    [out]   PUINT32 payloadSize
);

Parameters

[in] cameraHandle

The handle of the camera being queried.

[out] payloadSize

Pointer to an unsigned integer that receives the payload size of the camera specified by cameraHandle.

Return Values

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

Remarks

This function will fail if it is called before RtgvInitialize and RtgvInitCameraControl.

To find the camera to query, call RtgvInitialize and then call RtgvEnumerateCameras to get an RTGV_CAMERA_INFO array describing each camera found on the network, along with its handles.

Requirements