Properties

Variables
boolean	EnablePolling
	This property gets or sets the whether automatic polling is active or not.
TMaxVisibility	MaxVisibility
	Controls the maximum visibility for NodeMaps.
__int3264	NodeMap
	Gets or sets the current NODEMAP handle.
BSTR	SelectedNode
	This property gets the currently selected node name or sets the first occurrence of the given node name as selected.
boolean	ShowDescription
	Controls the setting whether or not the comments area is shown.
LONG	XMLDeviceMajor
	Gets the major version number of the device GenApi XML document.
LONG	XMLDeviceMinor
	Gets the minor version number of the device GenApi XML document.
LONG	XMLDeviceSubMinor
	Gets the sub minor version number of the device GenApi XML document.
BSTR	XMLModel
	Gets the XML model name.
BSTR	XMLNamespace
	Gets the XML namespace.
LONG	XMLSchemaMajor
	Gets the major version number of the GenApi XML schema used.
LONG	XMLSchemaMinor
	Gets the minor version number of the GenApi XML schema used.
LONG	XMLSchemaSubMinor
	Gets the sub minor version number of the GenApi XML schema used.
BSTR	XMLVendor
	Gets the XML vendor name.

Detailed Description

Variable Documentation

EnablePolling

boolean EnablePolling

property

This property gets or sets the whether automatic polling is active or not.

As long as a NodeMap is set and this property is TRUE all pollable feature nodes are automatically updated according to their polling time.

Parameters

[in]

EnablePolling

TRUE indicates that automatic polling is to be enabled, FALSE if not.

Returns

TRUE if automatic polling is enabled, FALSE otherwise.

MaxVisibility

TMaxVisibility MaxVisibility

property

Controls the maximum visibility for NodeMaps.

Parameters

[in]

MaxVisibility

New visibility maximum.

Returns

Maximum visibility.

Examples:

Delphi - Delphi GenICam Example
Visual Basic - VB GenICam Example
CSharp - C# GenICam Example

Sample Code in C#:

m_cvGenApiGrid.MaxVisibility = CVGenApiGridLib.TMaxVisibility.MV_BEGINNER;

NodeMap

__int3264 NodeMap

property

Gets or sets the current NODEMAP handle.

If a valid new NodeMap is set, the old one is removed. If no property grid is present yet (no window handle) this function still sets the nodemap handle.

Parameters

[in]

NodeMap

Handle of NodeMap.

Returns

Handle of NodeMap.

Examples:

Delphi - Delphi GenICam Example
Visual Basic - VB GenICam Example
Visual C++ - VC Simple GenICam Example
CSharp - C# GenICam Example

SelectedNode

BSTR SelectedNode

property

This property gets the currently selected node name or sets the first occurrence of the given node name as selected.

Parameters

[in]

SelectedNode

Name of the feature node to select.

Returns

String containing the full name of the selected feature node; empty for none.

Examples:

CSharp - C# GenICam Example

Sample Code in C#:

Sample Code to select the "PixelFormat" node.

m_cvGenApiGrid.SelectedNode = "PixelFormat";

ShowDescription

boolean ShowDescription

property

Controls the setting whether or not the comments area is shown.

Parameters

[in]

ShowDescription

TRUE indicates that the comments are shown. FALSE hide the comments.

Returns

TRUE if comments area is shown, FALSE otherwise.

Examples:

Delphi - Delphi GenICam Example
Visual Basic - VB GenICam Example
CSharp - C# GenICam Example

Sample Code in C#:

m_cvGenApiGrid.ShowDescription = true;

XMLDeviceMajor

LONG XMLDeviceMajor

property

Gets the major version number of the device GenApi XML document.

Returns

Major version number of the device GenApi XML document.

XMLDeviceMinor

LONG XMLDeviceMinor

property

Gets the minor version number of the device GenApi XML document.

Returns

Minor version number of the device GenApi XML document.

XMLDeviceSubMinor

LONG XMLDeviceSubMinor

property

Gets the sub minor version number of the device GenApi XML document.

Returns

Sub minor version number of the device GenApi XML document.

XMLModel

BSTR XMLModel

property

Gets the XML model name.

Returns

Return a string containing the XML model name; empty if no NodeMap is set.

XMLNamespace

BSTR XMLNamespace

property

Gets the XML namespace.

Returns

String containing the XML namespace, like GEV; empty if no NodeMap is set.

XMLSchemaMajor

LONG XMLSchemaMajor

property

Gets the major version number of the GenApi XML schema used.

Returns

Major version number of the GenApi XML schema.

XMLSchemaMinor

LONG XMLSchemaMinor

property

Gets the minor version number of the GenApi XML schema used.

Returns

Minor version number of the GenApi XML schema.

XMLSchemaSubMinor

LONG XMLSchemaSubMinor

property

Gets the sub minor version number of the GenApi XML schema used.

Returns

Sub minor version number of the GenApi XML schema.

XMLVendor

BSTR XMLVendor

property

Gets the XML vendor name.

Returns

Return a string containing the XML vendor name; empty if no NodeMap is set.