You are here: Start » Function Reference » GenApi » GenApi_GetParamExists

GenApi_GetParamExists

Header:	Genicam.h
Namespace:	fil
Module:	Genicam

Checks if parameter, category or command with specified name exists in GenApi set.

Syntax

bool fil::GenApi_GetParamExists
(
	GenApiHandle inHandle,
	const char* inParameterName
)

Parameters

	Name	Type	Default	Description
	inHandle	GenApiHandle		Handle to object providing GenApi interface.
	inParameterName	const char*		Textual name of the parameter, category or command that should be checked in GenICam naming convention or device specific name. Name is case sensitive.

Description

This function accesses the configuration of a device or software module using the GenICam GenApi interface. The actual GenApi interface is accessed through the handle of opened device or software module provided by other subsystem (like opened GigEVision device handle). A call to this function may result in time expensive (blocking) data exchange with device.

Return value

False, when GenApi description does not provide a parameter or command with specified name. True, when any kind of parameter or command exists in the referenced GenApi description, regardless of its interface, implementation state or availability (use GenApi_GetParamDescriptor function to retrieve more information about existing parameter).

Exceptions

This function will throw an exception in the following situations:

Object handle is invalid or does not provide the GenApi interface.