Functions
boolean	GetAsBoolean (BSTR NodeName)
	Gets the node's value with the given NodeName as a `boolean`. More...

DOUBLE	GetAsFloat (BSTR NodeName)
	Gets the node's value with the given NodeName as a `double`. More...

LONGLONG	GetAsInteger (BSTR NodeName)
	Gets the nodes value with the given NodeName as an `integer`. More...

BSTR	GetAsString (BSTR NodeName)
	Gets the nodes value with the given NodeName as a `string`. More...

boolean	GetInfoAsBoolean (BSTR NodeName, TNodeInfo Info)
	Gets an information of type TNodeInfo about the given NodeName as a `boolean`. More...

DOUBLE	GetInfoAsFloat (BSTR NodeName, TNodeInfo Info)
	Gets an information of type TNodeInfo about the given NodeName as a `double`. More...

LONGLONG	GetInfoAsInteger (BSTR NodeName, TNodeInfo Info)
	Gets an information of type TNodeInfo about the given NodeName as an `integer`. More...

BSTR	GetInfoAsString (BSTR NodeName, TNodeInfo Info)
	Gets an information of type TNodeInfo about the given NodeName as a `string`. More...

void	Invalidate (void)
	Invalidates the whole nodemap nodes' caches.

boolean	LoadSet (BSTR FileName)
	Loads the settings from the given FileName to the NodeMap. More...

boolean	LoadSetByDialog (void)
	Presents a dialog window to load a GenICam settings file (*.gcs). More...

void	Refresh (void)
	Refreshes everything and invalidates all nodes without invalidating the nodes' caches.

void	Reload (void)
	Reloads the current node tree. More...

boolean	SaveSet (BSTR FileName)
	Saves all streamable features to the given FileName. More...

boolean	SaveSetByDialog (void)
	Presents a dialog window to save all streamable features to a GenICam settings file (*.gcs). More...

void	SetAsBoolean (BSTR NodeName, boolean Value)
	Sets the nodes value with the given NodeName as a `boolean`. More...

void	SetAsFloat (BSTR NodeName, DOUBLE Value)
	Sets the nodes value with the given NodeName as a `double`. More...

void	SetAsInteger (BSTR NodeName, LONGLONG Value)
	Sets the nodes value with the given NodeName as an `integer`. More...

void	SetAsString (BSTR NodeName, BSTR Value)
	Sets the nodes value with the given NodeName as an `string`. More...

Detailed Description

Function Documentation

◆ GetAsBoolean()

boolean GetAsBoolean ( BSTR NodeName )

Gets the node's value with the given NodeName as a boolean.

Parameters

[in] NodeName Name of the node to get value as boolean.

Returns: Node value as boolean.

◆ GetAsFloat()

DOUBLE GetAsFloat ( BSTR NodeName )

Gets the node's value with the given NodeName as a double.

Parameters

[in] NodeName Name of the node to get value as double.

Returns: Node value as double.

◆ GetAsInteger()

LONGLONG GetAsInteger ( BSTR NodeName )

Gets the nodes value with the given NodeName as an integer.

Parameters

[in] NodeName Name of the node to get value as integer.

Returns: Node value as integer.

◆ GetAsString()

BSTR GetAsString ( BSTR NodeName )

Gets the nodes value with the given NodeName as a string.

Parameters

[in] NodeName Name of the node to get value as string.

Returns: Node value as string.

◆ GetInfoAsBoolean()

boolean GetInfoAsBoolean	(	BSTR	NodeName,
		TNodeInfo	Info
	)

Gets an information of type TNodeInfo about the given NodeName as a boolean.

Parameters

[in]	NodeName	Name of the node to get information for.
[in]	Info	Information to retrieve.

Returns: Required information as boolean.

◆ GetInfoAsFloat()

DOUBLE GetInfoAsFloat	(	BSTR	NodeName,
		TNodeInfo	Info
	)

Gets an information of type TNodeInfo about the given NodeName as a double.

Parameters

[in]	NodeName	Name of the node to get information for.
[in]	Info	Information to retrieve.

Returns: Required information as double.

◆ GetInfoAsInteger()

LONGLONG GetInfoAsInteger	(	BSTR	NodeName,
		TNodeInfo	Info
	)

Gets an information of type TNodeInfo about the given NodeName as an integer.

Parameters

[in]	NodeName	Name of the node to get information for.
[in]	Info	Information to retrieve.

Returns: Required information as integer.

◆ GetInfoAsString()

BSTR GetInfoAsString	(	BSTR	NodeName,
		TNodeInfo	Info
	)

Gets an information of type TNodeInfo about the given NodeName as a string.

Parameters

[in]	NodeName	Name of the node to get information for.
[in]	Info	Information to retrieve.

Returns: Required information as string.

◆ LoadSet()

boolean LoadSet ( BSTR FileName )

Loads the settings from the given FileName to the NodeMap.

Parameters

[in] FileName Full path of settings file to be loaded.

Returns: TRUE if set loaded successful, FALSE otherwise.

Related Topics:: SaveSet, SaveSetByDialog, LoadSetByDialog

For testing of saving and loading features please use the CVB Management Console Options Save Properties and Load Properties.

◆ LoadSetByDialog()

boolean LoadSetByDialog ( void )

Presents a dialog window to load a GenICam settings file (*.gcs).

Returns: FALSE on error or operation was canceled, TRUE otherwise.

Related Topics:: SaveSet, SaveSetByDialog, LoadSet

For testing of saving and loading features please use the CVB Management Console Options Save Properties and Load Properties.

◆ Reload()

void Reload ( void )

Reloads the current node tree.

Behaves like assigning 0 to the NodeMap property and reassigning the current node map.

The difference is that this function saves the current selection and tries to reselect it after the reload.

Attention: This function doesn't invalidate the node map.

◆ SaveSet()

boolean SaveSet ( BSTR FileName )

Saves all streamable features to the given FileName.

If you want to save other features please use the DLL function NMSaveSetEx. An easy way to find out if a feature is streamable is to use the the property page of the CVGenApiGrid.

Parameters

[in] FileName Full filename of set file where the data is to be saved.

Returns: FALSE on error, TRUE otherwise.

Related Topics:: SaveSetByDialog, LoadSet, LoadSetByDialog

For testing of saving and loading features please use the CVB Management Console Options Save Properties and Load Properties.

◆ SaveSetByDialog()

boolean SaveSetByDialog ( void )

Presents a dialog window to save all streamable features to a GenICam settings file (*.gcs).

If no streamable features are present no file is written. An easy way to find out if a feature is streamable is to use the the property page of the CV GenApi Grid.

Returns: FALSE on error or operation was canceled, TRUE otherwise.

Related Topics:: SaveSet, LoadSet, LoadSetByDialog

For testing of saving and loading features please use the CVB Management Console Options Save Properties and Load Properties.

◆ SetAsBoolean()

void SetAsBoolean	(	BSTR	NodeName,
		boolean	Value
	)

Sets the nodes value with the given NodeName as a boolean.

Parameters

[in]	NodeName	Name of the node to set value as `boolean`.
[in]	Value	New value to be set.

◆ SetAsFloat()

void SetAsFloat	(	BSTR	NodeName,
		DOUBLE	Value
	)

Sets the nodes value with the given NodeName as a double.

Parameters

[in]	NodeName	Name of the node to set value as `double`.
[in]	Value	New value to be set.

◆ SetAsInteger()

void SetAsInteger	(	BSTR	NodeName,
		LONGLONG	Value
	)

Sets the nodes value with the given NodeName as an integer.

Parameters

[in]	NodeName	Name of the node to set value as `integer`.
[in]	Value	New value to be set.

◆ SetAsString()

void SetAsString	(	BSTR	NodeName,
		BSTR	Value
	)

Sets the nodes value with the given NodeName as an string.

Parameters

[in]	NodeName	Name of the node to set value as `string`.
[in]	Value	New value to be set.


Contact Legal Privacy Statement	Copyright © 2023.
	All rights reserved.

Functions

Detailed Description

Function Documentation

◆ GetAsBoolean()

◆ GetAsFloat()

◆ GetAsInteger()

◆ GetAsString()

◆ GetInfoAsBoolean()

◆ GetInfoAsFloat()

◆ GetInfoAsInteger()

◆ GetInfoAsString()

◆ LoadSet()

◆ LoadSetByDialog()

◆ Reload()

◆ SaveSet()

◆ SaveSetByDialog()

◆ SetAsBoolean()

◆ SetAsFloat()

◆ SetAsInteger()

◆ SetAsString()