RtGVGetCameraID

RtGVGetCameraID returns the ID of a camera.

Syntax

BOOL RtGVGetCameraID(
	HANDLE 	cameraHandle, 
	LPTSTR pCameraID,
	LPDWORD pSize
);

Parameters

cameraHandle

The handle of the camera being queried.

pCameraID

A pointer to the buffer that receives the ID of the camera specified by cameraHandle. If this is NULL, the value pointed to by pSize is set to the size needed.

pSize

A pointer to a value that specifies the size of pCameraID in bytes.  If the size is not large enough, or if pCameraID is NULL, the function returns FALSE and the value is set to the size needed and last error is set to ERROR_INSUFFICIENT_BUFFER.

Return Values

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

Remarks

The camera ID is a string that contains the Manufacturer Name, Model Name, and IP Address of the camera.

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 3.7 Vision SDK

Header

RtGVApi.h

Library

RtGigEVision.lib

See Also:

RtGVEnumerateCameras