RtGVGetPayloadSize

RtGVGetPayloadSize gets the currently configured payload size on a camera.

Syntax

BOOL RtGVGetPayloadSize(
	HANDLE cameraHandle, 
	PUINT32 payloadSize
);

Parameters

cameraHandle

The handle of the camera being queried.

payloadSize

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

Return Values

Returns TRUE if the function succeeds, FALSE if the function fails. Call GetLastError for extended error information.

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 of the cameras found on the network, along with each of their handles.

Requirements

Minimum Supported Version	RTX64 4.1 Vision SDK
Header	RtGVApi.h
Library	RtGigEVision.lib