Image Manager (CVGenApi.dll) 14.1
Node Map

Typedefs

typedef void * NODEMAP
 Handle to object holding all nodes of a device.
 
typedef cvbbool_t(__stdcall * TFNodeProc) (NODE Node, cvbres_t Reason, void *pPrivate)
 Callback function when several nodes are processed. More...
 

Enumerations

enum  TFirmwareUpdateInfo { FWUI_Key = 0 , FWUI_Value , FWUI_LanguageCode }
 Defines commands to retrieve firmware information from a GUF file. More...
 
enum  TNodeMapInfo {
  NMI_Vendor = 0 , NMI_Model , NMI_SchemaVersionMajor , NMI_SchemaVersionMinor ,
  NMI_SchemaVersionSubMinor , NMI_DeviceVersionMajor , NMI_DeviceVersionMinor , NMI_DeviceVersionSubMinor ,
  NMI_Namespace , NMI_ProductGUID , NMI_VersionGUID , NMI_Tooltip ,
  NMI_Last
}
 Defines commands to retrieve information about a Node Map. More...
 

Functions

cvbres_t cvbGenApi::CreateFirmwareUpdater (const char *Filename, cvbbool_t Verify, FWUPDATER &Updater)
 Creates a firmware updater, Validates a guf file and sets the location of the guf file as C string. More...
 
cvbres_t cvbGenApi::CreateFirmwareUpdaterW (const wchar_t *Filename, cvbbool_t Verify, FWUPDATER &Updater)
 Creates a firmware updater, Validates a guf file and sets the location of the guf file as wide string. More...
 
cvbres_t cvbGenApi::FWUpdate (FWUPDATER Updater, NODEMAP NodeMap, const size_t UpdateFileSelection, TFDeviceReset Callback, void *pPrivate)
 Runs the firmware update process for a device. More...
 
cvbres_t cvbGenApi::FWUpdateFileCount (FWUPDATER Updater, size_t &FileCount)
 Gets the number of available update files in a guf file. More...
 
cvbres_t cvbGenApi::FWUpdateFileInfo (FWUPDATER Updater, size_t FileIndex, size_t InfoIndex, TFirmwareUpdateInfo Cmd, char *Info, size_t &InfoSize)
 Identifies a single firmware update and gets information about the firmware update as C string. More...
 
cvbres_t cvbGenApi::FWUpdateFileInfoCount (FWUPDATER Updater, size_t FileIndex, size_t &InfoCount)
 Gets the number of available update infos in a guf file. More...
 
cvbres_t cvbGenApi::FWUpdateFileInfoW (FWUPDATER Updater, size_t FileIndex, size_t InfoIndex, TFirmwareUpdateInfo Cmd, wchar_t *Info, size_t &InfoSize)
 Identifies a single firmware update and gets information about the firmware update as wide string. More...
 
cvbres_t GetGenApiVersion (cvbval_t &VersionMajor, cvbval_t &VersionMinor, cvbval_t &VersionSubMinor)
 Gets the version of the underlying GenICam GenApi. More...
 

NODE Access

cvbres_t NMGetNode (NODEMAP NodeMap, const char *NodeName, NODE &Node)
 Gets the Node object with the given NodeName. More...
 
cvbres_t NMGetNodeW (NODEMAP NodeMap, const wchar_t *NodeName, NODE &Node)
 Gets the Node object with the given NodeName. More...
 
cvbres_t NMListNode (NODEMAP NodeMap, cvbdim_t Index, char *NodeName, size_t &NodeNameSize)
 Gets the name of the Node at the given Index. More...
 
cvbres_t NMListNodeW (NODEMAP NodeMap, cvbdim_t Index, wchar_t *NodeName, size_t &NodeNameSize)
 Gets the name of the Node at the given Index. More...
 
cvbres_t NMNodeCount (NODEMAP NodeMap, cvbdim_t &NodeCount)
 Gets the number of nodes in the given NodeMap. More...
 
cvbres_t NMPollNodes (NODEMAP NodeMap, cvbval_t DeltaMS)
 Polls all pollable nodes in the given NodeMap. More...
 

NODEMAP Information

cvbbool_t IsNodeMap (NODEMAP NodeMap)
 Checks whether the given NodeMap handle is valid. More...
 
cvbres_t NMInfoAsBoolean (NODEMAP NodeMap, TNodeMapInfo Cmd, cvbbool_t &Info)
 Gets information about the given NodeMap as a Boolean value. More...
 
cvbres_t NMInfoAsFloat (NODEMAP NodeMap, TNodeMapInfo Cmd, double &Info)
 Gets information about the given NodeMap as a double value. More...
 
cvbres_t NMInfoAsInteger (NODEMAP NodeMap, TNodeMapInfo Cmd, cvbint64_t &Info)
 Gets information about the given NodeMap as a int64 value. More...
 
cvbres_t NMInfoAsString (NODEMAP NodeMap, TNodeMapInfo Cmd, char *Info, size_t &InfoSize)
 Gets information about the given NodeMap as a C string value. More...
 
cvbres_t NMInfoAsStringW (NODEMAP NodeMap, TNodeMapInfo Cmd, wchar_t *Info, size_t &InfoSize)
 Gets information about the given NodeMap as a wide C string value. More...
 

NODEMAP Functions

cvbres_t NMLoadSetEx (NODEMAP NodeMap, const char *Filename, cvbbool_t Validate, TFNodeProc Callback, void *pPrivate)
 Loads the settings from the given Filename to the NodeMap. More...
 
cvbres_t NMLoadSetExW (NODEMAP NodeMap, const wchar_t *Filename, cvbbool_t Validate, TFNodeProc Callback, void *pPrivate)
 Loads the settings from the given Filename to the NodeMap. More...
 
cvbres_t NMLoadSet (NODEMAP NodeMap, const char *Filename, TFNodeProc Callback, void *pPrivate)
 Loads the settings from the given Filename to the NodeMap. More...
 
cvbres_t NMLoadSetW (NODEMAP NodeMap, const wchar_t *Filename, TFNodeProc Callback, void *pPrivate)
 Loads the settings from the given Filename to the NodeMap. More...
 
cvbres_t NMLoadSetString (NODEMAP NodeMap, const char *Settings, cvbbool_t Validate, TFNodeProc Callback, void *pPrivate)
 Loads the settings from the given Settings buffer to the NodeMap. More...
 
cvbres_t NMLoadSetStringW (NODEMAP NodeMap, const wchar_t *Settings, cvbbool_t Validate, TFNodeProc Callback, void *pPrivate)
 Loads the settings from the given Settings buffer to the NodeMap. More...
 
cvbres_t NMSaveSet (NODEMAP NodeMap, const char *Filename, TFNodeProc Callback, void *pPrivate)
 Saves all streamable features with values in the given NodeMap to the given Filename. More...
 
cvbres_t NMSaveSetW (NODEMAP NodeMap, const wchar_t *Filename, TFNodeProc Callback, void *pPrivate)
 Saves all streamable features with values in the given NodeMap to the given Filename. More...
 
cvbres_t NMSaveSetEx (NODEMAP NodeMap, const char *Filename, const char *NodeList, TFNodeProc Callback, void *pPrivate)
 Saves the features given in NodeList with values from the given NodeMap to the given Filename. More...
 
cvbres_t NMSaveSetExW (NODEMAP NodeMap, const wchar_t *Filename, const wchar_t *NodeList, TFNodeProc Callback, void *pPrivate)
 Saves the features given in NodeList with values from the given NodeMap to the given Filename. More...
 
cvbres_t NMSaveSetString (NODEMAP NodeMap, char *Settings, size_t &SettingsSize, TFNodeProc Callback, void *pPrivate)
 Saves all streamable features with values in the given NodeMap to the given Settings buffer. More...
 
cvbres_t NMSaveSetStringW (NODEMAP NodeMap, wchar_t *Settings, size_t &SettingsSize, TFNodeProc Callback, void *pPrivate)
 Saves all streamable features with values in the given NodeMap to the given Settings buffer. More...
 
cvbres_t NMSaveSetStringEx (NODEMAP NodeMap, char *Settings, size_t &SettingsSize, const char *NodeList, TFNodeProc Callback, void *pPrivate)
 Saves the features given in NodeList with values from the given NodeMap to the given Settings buffer. More...
 
cvbres_t NMSaveSetStringExW (NODEMAP NodeMap, wchar_t *Settings, size_t &SettingsSize, const wchar_t *NodeList, TFNodeProc Callback, void *pPrivate)
 Saves the features given in NodeList with values from the given NodeMap to the given Settings buffer. More...
 
cvbres_t NMDownloadFile (NODEMAP NodeMap, const char *FileSelectorEntryName, const char *Filename)
 Downloads a file from the device which is present in the Std::FileSelector and saves it do disk. More...
 
cvbres_t NMDownloadFileW (NODEMAP NodeMap, const wchar_t *FileSelectorEntryName, const wchar_t *Filename)
 Downloads a file from the device which is present in the Std::FileSelector and saves it do disk. More...
 
cvbres_t NMDownloadFileMemory (NODEMAP NodeMap, const char *FileSelectorEntryName, void *pBuffer, size_t &BufferSize)
 Downloads a file from the device which is present in the Std::FileSelector and saves it do memory. More...
 
cvbres_t NMDownloadFileMemoryW (NODEMAP NodeMap, const wchar_t *FileSelectorEntryName, void *pBuffer, size_t &BufferSize)
 Downloads a file from the device which is present in the Std::FileSelector and saves it do memory. More...
 
cvbres_t NMUploadFile (NODEMAP NodeMap, const char *FileSelectorEntryName, const char *Filename)
 Uploads a file to the device which is present in the Std::FileSelector from disk. More...
 
cvbres_t NMUploadFileW (NODEMAP NodeMap, const wchar_t *FileSelectorEntryName, const wchar_t *Filename)
 Uploads a file to the device which is present in the Std::FileSelector from disk. More...
 
cvbres_t NMUploadFileMemory (NODEMAP NodeMap, const char *FileSelectorEntryName, const void *pBuffer, size_t BufferSize)
 Uploads a file to the device which is present in the Std::FileSelector and loads it from memory. More...
 
cvbres_t NMUploadFileMemoryW (NODEMAP NodeMap, const wchar_t *FileSelectorEntryName, const void *pBuffer, size_t BufferSize)
 Uploads a file to the device which is present in the Std::FileSelector and loads it from memory. More...
 
cvbres_t NMCreateStream (NODEMAP NodeMap, TStreamType StreamType, NODEMAPSTREAM &NodeMapStream)
 Create the node map stream form a given node map. More...
 
cvbres_t NMStreamPush (NODEMAPSTREAM NodeMapStream, NODE Node)
 Update the node information such as display name, type of node and value of node. More...
 
cvbres_t NMStreamDump (NODEMAPSTREAM NodeMapStream, char *Settings, size_t &SettingsSize)
 Dump the node information in the stream to a string. More...
 
cvbres_t NMStreamDumpW (NODEMAPSTREAM NodeMapStream, wchar_t *Settings, size_t &SettingsSize)
 Dump the node information in the stream to a string. More...
 

Detailed Description

Typedef Documentation

◆ TFNodeProc

cvbbool_t(* TFNodeProc)(NODE Node, cvbres_t Reason, void *pPrivate)

Callback function when several nodes are processed.

This callback is given as a parameter in node 'processing' functions. So far the load and save settings function use this callback for error reporting.

Attention
The call of this function does not necessarily mean that the given Node is currently accessible or even valid.
Parameters
[in]NodeCurrent node object.
[in]ReasonReason why the error occurred (CVC error code).
[in]pPrivatePointer to user data given in the register function.
Returns
true if the current operation is to be continued; false to cancel the whole operation.

Enumeration Type Documentation

◆ TFirmwareUpdateInfo

Defines commands to retrieve firmware information from a GUF file.

These commands define which kind of information is retrieved from a GUF file.

Enumerator
FWUI_Key 

Gets the key name for a given index.
This is a string value.

FWUI_Value 

Gets the value for an info key name.
This is a string value.

FWUI_LanguageCode 

Gets the language code for the given update info number. This is a string value.

◆ TNodeMapInfo

Defines commands to retrieve information about a Node Map.

These commands define which kind of information is retrieved from a Node Map.

Enumerator
NMI_Vendor 

Gets the name of the device vendor.
This is a string value.

NMI_Model 

Gets the name of the device model.
This is a string value.

NMI_SchemaVersionMajor 

Gets the XML schema major version number.
Increased numbers indicate possible incompatibilities. This is an integer value.

NMI_SchemaVersionMinor 

Gets the XML schema minor version number.
Increased numbers indicate extended features and bug fixes. This is an integer value.

NMI_SchemaVersionSubMinor 

Gets the XML schema sub-minor version number.
Increased numbers indicate bug fixes. This is an integer value.

NMI_DeviceVersionMajor 

Gets the device XML major version number.
Increased numbers indicate possible incompatibilities. This is an integer value.

NMI_DeviceVersionMinor 

Gets the device XML minor version number.
Increased numbers indicate extended features and bug fixes. This is an integer value.

NMI_DeviceVersionSubMinor 

Gets the device XML sub-minor version number.
Increased numbers indicate bug fixes. This is an integer value.

NMI_Namespace 

Gets the description namespace (e.g. GEV).
This is a string value.

NMI_ProductGUID 

Gets the product GUID.
This is a string value.

NMI_VersionGUID 

Gets the version GUID.
This is a string value.

NMI_Tooltip 

Gets the XML description tool tip.
This is a string value.

Function Documentation

◆ CreateFirmwareUpdater()

cvbres_t cvbGenApi::CreateFirmwareUpdater ( const char *  Filename,
cvbbool_t  Verify,
FWUPDATER &  Updater 
)

Creates a firmware updater, Validates a guf file and sets the location of the guf file as C string.

Note
Unused files ore procedures that are part of the guf file are currently tolerated.
Parameters
[in]FilenamePath and name of the guf file to be applied to the camera as C string.
[in]VerifyIf true the guf file will be validated.
[out]UpdaterNewly created firmware updater object.
Returns
CVC error code: Smaller than zero on error.

◆ CreateFirmwareUpdaterW()

cvbres_t cvbGenApi::CreateFirmwareUpdaterW ( const wchar_t *  Filename,
cvbbool_t  Verify,
FWUPDATER &  Updater 
)

Creates a firmware updater, Validates a guf file and sets the location of the guf file as wide string.

Note
Unused files ore procedures that are part of the guf file are currently tolerated.
Parameters
[in]FilenamePath and name of the guf file to be applied to the camera as wide string.
[in]VerifyIf true the guf file will be validated.
[out]UpdaterNewly created firmware updater object.
Returns
CVC error code: Smaller than zero on error.

◆ FWUpdate()

cvbres_t cvbGenApi::FWUpdate ( FWUPDATER  Updater,
NODEMAP  NodeMap,
const size_t  UpdateFileSelection,
TFDeviceReset  Callback,
void *  pPrivate 
)

Runs the firmware update process for a device.

Double checks if the device can be updated by firmware update info. Can update another device after failure.

Attention
The callback will be called during or after the device firmware update. Make sure to release all device handles, re-discover and open the device and set the new device node map.
Parameters
[in]UpdaterHandle to the updater object.
[in]NodeMapCVB Node Map to access.
[in]UpdateFileSelectionIndex of the update from a guf file to apply to the camera.
[in]CallbackFunction pointer to function to be called on to reset the device, re-discover it and set the new node map.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ FWUpdateFileCount()

cvbres_t cvbGenApi::FWUpdateFileCount ( FWUPDATER  Updater,
size_t &  FileCount 
)

Gets the number of available update files in a guf file.

Parameters
[in]UpdaterFirmware updater object.
[in,out]FileCountNumber of available firmware update files in guf.
Returns
CVC error code: Smaller than zero on error.

◆ FWUpdateFileInfo()

cvbres_t cvbGenApi::FWUpdateFileInfo ( FWUPDATER  Updater,
size_t  FileIndex,
size_t  InfoIndex,
TFirmwareUpdateInfo  Cmd,
char *  Info,
size_t &  InfoSize 
)

Identifies a single firmware update and gets information about the firmware update as C string.

Parameters
[in]UpdaterFirmware updater object.
[in]FileIndexIndex of update file within guf file.
[in]InfoIndexIndex of the update info to use.
[in]CmdCommand to identify the information to be retrieved.
[out]InfoC string to be filled with requested information; NULL for size inquiry (see InfoSize).
[in,out]InfoSizeGives the buffer size of Info or receives the needed size if Info is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ FWUpdateFileInfoCount()

cvbres_t cvbGenApi::FWUpdateFileInfoCount ( FWUPDATER  Updater,
size_t  FileIndex,
size_t &  InfoCount 
)

Gets the number of available update infos in a guf file.

Parameters
[in]UpdaterFirmware updater object.
[in]FileIndexIndex of update file within guf to read infos from.
[in,out]InfoCountNumber of available firmware update infos.
Returns
CVC error code: Smaller than zero on error.

◆ FWUpdateFileInfoW()

cvbres_t cvbGenApi::FWUpdateFileInfoW ( FWUPDATER  Updater,
size_t  FileIndex,
size_t  InfoIndex,
TFirmwareUpdateInfo  Cmd,
wchar_t *  Info,
size_t &  InfoSize 
)

Identifies a single firmware update and gets information about the firmware update as wide string.

Parameters
[in]UpdaterFirmware updater object.
[in]FileIndexIndex of update file within guf file.
[in]CmdCommand to identify the information to be retrieved.
[in]InfoIndexIndex of the update info to use.
[out]InfoWide string to be filled with requested information; NULL for size inquiry (see InfoSize).
[in,out]InfoSizeGives the buffer size of Info or receives the needed size if Info is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ GetGenApiVersion()

cvbres_t GetGenApiVersion ( cvbval_t &  VersionMajor,
cvbval_t &  VersionMinor,
cvbval_t &  VersionSubMinor 
)

Gets the version of the underlying GenICam GenApi.

Parameters
[out]VersionMajorMajor version number.
[out]VersionMinorMinor version number.
[out]VersionSubMinorSub-minor version number.
Returns
Always CVC_E_OK.

◆ IsNodeMap()

cvbbool_t IsNodeMap ( NODEMAP  NodeMap)

Checks whether the given NodeMap handle is valid.

Parameters
[in]NodeMapHandle to be checked.
Returns
true if the given handle is valid; false otherwise.

◆ NMCreateStream()

cvbres_t NMCreateStream ( NODEMAP  NodeMap,
TStreamType  StreamType,
NODEMAPSTREAM &  NodeMapStream 
)

Create the node map stream form a given node map.

Parameters
[in]NodeMapNode map to create the stream from.
[in]StreamTypeThe format to of the stream.
[out]NodeMapStreamNew node map stream object.
Returns
CVC error code: Smaller than zero on error.

◆ NMDownloadFile()

cvbres_t NMDownloadFile ( NODEMAP  NodeMap,
const char *  FileSelectorEntryName,
const char *  Filename 
)

Downloads a file from the device which is present in the Std::FileSelector and saves it do disk.

Parameters
[in]NodeMapCVB NodeMap from which the file is downloaded.
[in]FileSelectorEntryNameFile to download.
[in]FilenamePath to save FileSelectorEntryName to.
Returns
CVC error code: Smaller than zero on error.

◆ NMDownloadFileMemory()

cvbres_t NMDownloadFileMemory ( NODEMAP  NodeMap,
const char *  FileSelectorEntryName,
void *  pBuffer,
size_t &  BufferSize 
)

Downloads a file from the device which is present in the Std::FileSelector and saves it do memory.

Parameters
[in]NodeMapCVB NodeMap from which the file is downloaded.
[in]FileSelectorEntryNameFile to download.
[in]pBufferMemory to write file to; NULL to query file size.
[in,out]BufferSizeThe size of the pBuffer in bytes if pBuffer is not NULL and will receive number of bytes actually filled after successful operation; if pBuffer is NULL the minimal buffer size is written here.
Returns
CVC error code: Smaller than zero on error.

◆ NMDownloadFileMemoryW()

cvbres_t NMDownloadFileMemoryW ( NODEMAP  NodeMap,
const wchar_t *  FileSelectorEntryName,
void *  pBuffer,
size_t &  BufferSize 
)

Downloads a file from the device which is present in the Std::FileSelector and saves it do memory.

Parameters
[in]NodeMapCVB NodeMap from which the file is downloaded.
[in]FileSelectorEntryNameFile to download.
[in]pBufferMemory to write file to; NULL to query file size.
[in,out]BufferSizeThe size of the pBuffer in bytes if pBuffer is not NULL and will receive number of bytes actually filled after successful operation; if pBuffer is NULL the minimal buffer size is written here.
Returns
CVC error code: Smaller than zero on error.

◆ NMDownloadFileW()

cvbres_t NMDownloadFileW ( NODEMAP  NodeMap,
const wchar_t *  FileSelectorEntryName,
const wchar_t *  Filename 
)

Downloads a file from the device which is present in the Std::FileSelector and saves it do disk.

Parameters
[in]NodeMapCVB NodeMap from which the file is downloaded.
[in]FileSelectorEntryNameFile to download.
[in]FilenamePath to save FileSelectorEntryName to.
Returns
CVC error code: Smaller than zero on error.

◆ NMGetNode()

cvbres_t NMGetNode ( NODEMAP  NodeMap,
const char *  NodeName,
NODE Node 
)

Gets the Node object with the given NodeName.

If no namespace is given with the name (Cust or Standard separated with a double colon (::) ), this function first tries to get the node from the Standard namespace. If it is not available it tries to get it from the Cust namespace. If the name can not be found either, an error is returned.

Only value types defined in TNodeType are supported.

Use ShareObject and ReleaseObject for lifetime management.

Parameters
[in]NodeMapCVB Node Map to access.
[in]NodeNameName of the node to retrieve. This string must be 0 terminated.
[out]NodeReference to handle to receive the Node.
Returns
CVC error code: Smaller than zero on error.

◆ NMGetNodeW()

cvbres_t NMGetNodeW ( NODEMAP  NodeMap,
const wchar_t *  NodeName,
NODE Node 
)

Gets the Node object with the given NodeName.

If no namespace is given with the name (Cust or Standard separated with a double colon (::) ), this function first tries to get the node from the Standard namespace. If it is not available it tries to get it from the Cust namespace. If the name can not be found either, an error is returned.

Only value types defined in TNodeType are supported.

Use ShareObject and ReleaseObject for lifetime management.

Parameters
[in]NodeMapCVB Node Map to access.
[in]NodeNameName of the node to retrieve. This string must be 0 terminated.
[out]NodeReference to handle to receive the Node.
Returns
CVC error code: Smaller than zero on error.

◆ NMInfoAsBoolean()

cvbres_t NMInfoAsBoolean ( NODEMAP  NodeMap,
TNodeMapInfo  Cmd,
cvbbool_t &  Info 
)

Gets information about the given NodeMap as a Boolean value.

If a requested information is not available as a Boolean the function returns an error.

Parameters
[in]NodeMapCVB Node Map to access.
[in]CmdCommand to identify the information to be retrieved.
[out]InfoRequested information.
Returns
CVC error code: Smaller than zero on error.

◆ NMInfoAsFloat()

cvbres_t NMInfoAsFloat ( NODEMAP  NodeMap,
TNodeMapInfo  Cmd,
double &  Info 
)

Gets information about the given NodeMap as a double value.

If a requested information is not available as a double the function returns an error.

Parameters
[in]NodeMapCVB Node Map to access.
[in]CmdCommand to identify the information to be retrieved.
[out]InfoRequested information.
Returns
CVC error code: Smaller than zero on error.

◆ NMInfoAsInteger()

cvbres_t NMInfoAsInteger ( NODEMAP  NodeMap,
TNodeMapInfo  Cmd,
cvbint64_t &  Info 
)

Gets information about the given NodeMap as a int64 value.

If a requested information is not available as an int64 the function returns an error.

Parameters
[in]NodeMapCVB Node Map to access.
[in]CmdCommand to identify the information to be retrieved.
[out]InfoRequested information.
Returns
CVC error code: Smaller than zero on error.

◆ NMInfoAsString()

cvbres_t NMInfoAsString ( NODEMAP  NodeMap,
TNodeMapInfo  Cmd,
char *  Info,
size_t &  InfoSize 
)

Gets information about the given NodeMap as a C string value.

If a requested information is not available as a C string the function returns an error.

Parameters
[in]NodeMapCVB NodeMap to access.
[in]CmdCommand to identify the information to be retrieved.
[out]InfoC string to be filled with requested information; NULL for size inquiry (see InfoSize).
[in,out]InfoSizeGives the buffer size of Info or receives the needed size if Info is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NMInfoAsStringW()

cvbres_t NMInfoAsStringW ( NODEMAP  NodeMap,
TNodeMapInfo  Cmd,
wchar_t *  Info,
size_t &  InfoSize 
)

Gets information about the given NodeMap as a wide C string value.

If a requested information is not available as a wide C string the function returns an error.

Parameters
[in]NodeMapCVB NodeMap to access.
[in]CmdCommand to identify the information to be retrieved.
[out]InfoC string to be filled with requested information; NULL for size inquiry (see InfoSize).
[in,out]InfoSizeGives the buffer size of Info or receives the needed size if Info is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NMListNode()

cvbres_t NMListNode ( NODEMAP  NodeMap,
cvbdim_t  Index,
char *  NodeName,
size_t &  NodeNameSize 
)

Gets the name of the Node at the given Index.

Use this function to inquire the names of available nodes. With the returned name the node can be acquired by calling NMGetNode.

All nodes in the NodeMap are listed. Even those which are not supported by this interface. You will get an error for these nodes.

Parameters
[in]NodeMapCVB Node Map to access.
[in]IndexIndex of node to access [0 ... NMNodeCount - 1].
[out]NodeNameC string to be filled with name; NULL for size inquiry (see NodeNameSize).
[in,out]NodeNameSizeGives the buffer size of NodeName or receives the needed size if NodeName is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NMListNodeW()

cvbres_t NMListNodeW ( NODEMAP  NodeMap,
cvbdim_t  Index,
wchar_t *  NodeName,
size_t &  NodeNameSize 
)

Gets the name of the Node at the given Index.

Use this function to inquire the names of available nodes. With the returned name the node can be acquired by calling NMGetNodeW.

All nodes in the NodeMap are listed. Even those which are not supported by this interface. You will get an error for these nodes.

Parameters
[in]NodeMapCVB Node Map to access.
[in]IndexIndex of node to access [0 ... NMNodeCount - 1].
[out]NodeNameWide C string to be filled with name; NULL for size inquiry (see NodeNameSize).
[in,out]NodeNameSizeGives the buffer size of NodeName or receives the needed size if NodeName is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NMLoadSet()

cvbres_t NMLoadSet ( NODEMAP  NodeMap,
const char *  Filename,
TFNodeProc  Callback,
void *  pPrivate 
)

Loads the settings from the given Filename to the NodeMap.

The features are written in the order they appear in the given Filename and without software verification. If the device supports streaming also the device validation is disabled for the individual writes. After writing the settings the device will validate the values.

The device supports streaming if the following features are present:

  • Std::DeviceRegistersStreamingStart
  • Std::DeviceRegistersStreamingEnd
  • Std::DeviceRegistersCheck
  • Std::DeviceRegistersValid

If only a subset of the listed features are available only these are used.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap to write settings to.
[in]FilenameFilename of settings file to load.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMLoadSetEx()

cvbres_t NMLoadSetEx ( NODEMAP  NodeMap,
const char *  Filename,
cvbbool_t  Validate,
TFNodeProc  Callback,
void *  pPrivate 
)

Loads the settings from the given Filename to the NodeMap.

This function works like the NMLoadSet function except that software validation after writing to the device is performed if Validate is true. The settings in the Filename are compared against the settings in the device.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Attention
Some values may be adjusted by the device. This can happen if values are changed manually in the settings file. Floating point numbers are compared as strings: E.g. the value 1.5 is represented as 1.50, thus enter 1.50 in the settings file to ensure the value is validated correctly.
Parameters
[in]NodeMapCVB NodeMap to write settings to.
[in]FilenameFilename of settings file to load.
[in]Validatetrue if software validation is to be done; false otherwise.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMLoadSetExW()

cvbres_t NMLoadSetExW ( NODEMAP  NodeMap,
const wchar_t *  Filename,
cvbbool_t  Validate,
TFNodeProc  Callback,
void *  pPrivate 
)

Loads the settings from the given Filename to the NodeMap.

This function works like the NMLoadSet function except that software validation after writing to the device is performed if Validate is true. The settings in the Filename are compared against the settings in the device.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Attention
Some values may be adjusted by the device. This can happen if values are changed manually in the settings file. Floating point numbers are compared as strings: E.g. the value 1.5 is represented as 1.50, thus enter 1.50 in the settings file to ensure the value is validated correctly.
Parameters
[in]NodeMapCVB NodeMap to write settings to.
[in]FilenameFilename of settings file to load.
[in]Validatetrue if software validation is to be done; false otherwise.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMLoadSetString()

cvbres_t NMLoadSetString ( NODEMAP  NodeMap,
const char *  Settings,
cvbbool_t  Validate,
TFNodeProc  Callback,
void *  pPrivate 
)

Loads the settings from the given Settings buffer to the NodeMap.

This function works like the NMLoadSet function except that software validation after writing to the device is performed if Validate is true. The settings in the Filename are compared against the settings in the device.

Attention
Some values may be adjusted by the device. This can happen if values are changed manually in the settings file. Floating point numbers are compared as strings: E.g. the value 1.5 is represented as 1.50, thus enter 1.50 in the settings file to ensure the value is validated correctly.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap to write settings to.
[in]SettingsPointer to Buffer of settings to load.
[in]Validatetrue if software validation is to be done; false otherwise.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMLoadSetStringW()

cvbres_t NMLoadSetStringW ( NODEMAP  NodeMap,
const wchar_t *  Settings,
cvbbool_t  Validate,
TFNodeProc  Callback,
void *  pPrivate 
)

Loads the settings from the given Settings buffer to the NodeMap.

This function works like the NMLoadSet function except that software validation after writing to the device is performed if Validate is true. The settings in the Filename are compared against the settings in the device.

Attention
Some values may be adjusted by the device. This can happen if values are changed manually in the settings file. Floating point numbers are compared as strings: E.g. the value 1.5 is represented as 1.50, thus enter 1.50 in the settings file to ensure the value is validated correctly.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap to write settings to.
[in]SettingsPointer to Buffer of settings to load.
[in]Validatetrue if software validation is to be done; false otherwise.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMLoadSetW()

cvbres_t NMLoadSetW ( NODEMAP  NodeMap,
const wchar_t *  Filename,
TFNodeProc  Callback,
void *  pPrivate 
)

Loads the settings from the given Filename to the NodeMap.

The features are written in the order they appear in the given Filename and without software verification. If the device supports streaming also the device validation is disabled for the individual writes. After writing the settings the device will validate the values.

The device supports streaming if the following features are present:

  • Std::DeviceRegistersStreamingStart
  • Std::DeviceRegistersStreamingEnd
  • Std::DeviceRegistersCheck
  • Std::DeviceRegistersValid

If only a subset of the listed features are available only these are used.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap to write settings to.
[in]FilenameFilename of settings file to load.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMNodeCount()

cvbres_t NMNodeCount ( NODEMAP  NodeMap,
cvbdim_t &  NodeCount 
)

Gets the number of nodes in the given NodeMap.

All nodes in the NodeMap are counted. Even those which are not supported by this interface. Use the NMListNode function to get the full name of a node for an index.

Parameters
[in]NodeMapCVB Node Map to access.
[out]NodeCountNumber of nodes in the NodeMap.
Returns
CVC error code: Smaller than zero on error.

◆ NMPollNodes()

cvbres_t NMPollNodes ( NODEMAP  NodeMap,
cvbval_t  DeltaMS 
)

Polls all pollable nodes in the given NodeMap.

This function scans for pollable (auto-update) feature in the NodeMap and invalidates them if necessary.

Parameters
[in]NodeMapCVB Node Map to access.
[in]DeltaMSTime since last call of this function in milliseconds.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSet()

cvbres_t NMSaveSet ( NODEMAP  NodeMap,
const char *  Filename,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves all streamable features with values in the given NodeMap to the given Filename.

If Filename exists it is overwritten.

The streamable features must be readable and writable.

Streamable features are features for which the NInfoAsBoolean with the NI_Streamable command returns a non zero value.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[in]FilenameName of the file in which the settings are written.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetEx()

cvbres_t NMSaveSetEx ( NODEMAP  NodeMap,
const char *  Filename,
const char *  NodeList,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves the features given in NodeList with values from the given NodeMap to the given Filename.

If Filename exists it is overwritten.

Feature names for the NodeList are separated by pipes (|). E.g. "Std::ExposureTimeAbs|Std::GainAbs" saves both exposure time and gain settings.

The given features must be readable and writable.

This function can be used if the device vendor didn't provide streamable features or only a sub-set of features is needed.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[in]FilenameName of the file in which the settings are written.
[in]NodeListPipe (|) separated list of feature names to be saved.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetExW()

cvbres_t NMSaveSetExW ( NODEMAP  NodeMap,
const wchar_t *  Filename,
const wchar_t *  NodeList,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves the features given in NodeList with values from the given NodeMap to the given Filename.

If Filename exists it is overwritten.

Feature names for the NodeList are separated by pipes (|). E.g. "Std::ExposureTimeAbs|Std::GainAbs" saves both exposure time and gain settings.

The given features must be readable and writable.

This function can be used if the device vendor didn't provide streamable features or only a sub-set of features is needed.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[in]FilenameName of the file in which the settings are written.
[in]NodeListPipe (|) separated list of feature names to be saved.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetString()

cvbres_t NMSaveSetString ( NODEMAP  NodeMap,
char *  Settings,
size_t &  SettingsSize,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves all streamable features with values in the given NodeMap to the given Settings buffer.

The streamable features must be readable and writable.

Streamable features are features for which the NInfoAsBoolean with the NI_Streamable command returns a non zero value.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[out]SettingsPointer to buffer to be filled with settings document; NULL for size inquiry.
[in,out]SettingsSizeSize of Settings buffer; Number of bytes needed if Settings is NULL.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetStringEx()

cvbres_t NMSaveSetStringEx ( NODEMAP  NodeMap,
char *  Settings,
size_t &  SettingsSize,
const char *  NodeList,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves the features given in NodeList with values from the given NodeMap to the given Settings buffer.

Feature names for the NodeList are separated by pipes (|). E.g. "Std::ExposureTimeAbs|Std::GainAbs" saves both exposure time and gain settings.

The given features must be readable and writeable.

This function can be used if the device vendor didn't provide streamable features or only a sub-set of features is needed.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[out]SettingsPointer to buffer to be filled with settings document; NULL for size inquiry.
[in,out]SettingsSizeSize of Settings buffer; Number of bytes needed if Settings is NULL.
[in]NodeListPipe (|) separated list of feature names to be saved.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetStringExW()

cvbres_t NMSaveSetStringExW ( NODEMAP  NodeMap,
wchar_t *  Settings,
size_t &  SettingsSize,
const wchar_t *  NodeList,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves the features given in NodeList with values from the given NodeMap to the given Settings buffer.

Feature names for the NodeList are separated by pipes (|). E.g. "Std::ExposureTimeAbs|Std::GainAbs" saves both exposure time and gain settings.

The given features must be readable and writeable.

This function can be used if the device vendor didn't provide streamable features or only a sub-set of features is needed.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[out]SettingsPointer to buffer to be filled with settings document; NULL for size inquiry.
[in,out]SettingsSizeSize of Settings buffer; Number of bytes needed if Settings is NULL.
[in]NodeListPipe (|) separated list of feature names to be saved.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetStringW()

cvbres_t NMSaveSetStringW ( NODEMAP  NodeMap,
wchar_t *  Settings,
size_t &  SettingsSize,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves all streamable features with values in the given NodeMap to the given Settings buffer.

The streamable features must be readable and writable.

Streamable features are features for which the NInfoAsBoolean with the NI_Streamable command returns a non zero value.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[out]SettingsPointer to buffer to be filled with settings document; NULL for size inquiry.
[in,out]SettingsSizeSize of Settings buffer; Number of bytes needed if Settings is NULL.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMSaveSetW()

cvbres_t NMSaveSetW ( NODEMAP  NodeMap,
const wchar_t *  Filename,
TFNodeProc  Callback,
void *  pPrivate 
)

Saves all streamable features with values in the given NodeMap to the given Filename.

If Filename exists it is overwritten.

The streamable features must be readable and writable.

Streamable features are features for which the NInfoAsBoolean with the NI_Streamable command returns a non zero value.

The callback function, if given, is only called for recoverable errors. If a critical error occurs the function returns always without an additional call. If the operation is canceled the error code is returned by the function.

Parameters
[in]NodeMapCVB NodeMap from which streamable features are to be saved.
[in]FilenameName of the file in which the settings are written.
[in]CallbackFunction pointer to function to be called on errors; NULL if not needed.
[in]pPrivatePointer to user data given in Callback.
Returns
CVC error code: Smaller than zero on error.

◆ NMStreamDump()

cvbres_t NMStreamDump ( NODEMAPSTREAM  NodeMapStream,
char *  Settings,
size_t &  SettingsSize 
)

Dump the node information in the stream to a string.

Parameters
[in]NodeMapStreamNode map stream from which stream able features are to be saved.
[in]SettingsPointer to buffer to be filled with settings; NULL for size inquiry.
[in]SettingsSizeSize of Settings buffer; Number of bytes needed if Settings is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NMStreamDumpW()

cvbres_t NMStreamDumpW ( NODEMAPSTREAM  NodeMapStream,
wchar_t *  Settings,
size_t &  SettingsSize 
)

Dump the node information in the stream to a string.

Parameters
[in]NodeMapStreamNode map stream from which stream able features are to be saved.
[in]SettingsPointer to buffer to be filled with settings; NULL for size inquiry.
[in]SettingsSizeSize of Settings buffer; Number of bytes needed if Settings is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NMStreamPush()

cvbres_t NMStreamPush ( NODEMAPSTREAM  NodeMapStream,
NODE  Node 
)

Update the node information such as display name, type of node and value of node.

Parameters
[in]NodeMapStreamNode map stream to hold the node information.
[in]NodeNode, that will be dumped to the stream.
Returns
CVC error code: Smaller than zero on error.

◆ NMUploadFile()

cvbres_t NMUploadFile ( NODEMAP  NodeMap,
const char *  FileSelectorEntryName,
const char *  Filename 
)

Uploads a file to the device which is present in the Std::FileSelector from disk.

Parameters
[in]NodeMapCVB NodeMap to which the file is uploaded.
[in]FileSelectorEntryNameFile to upload.
[in]FilenamePath to load FileSelectorEntryName from.
Returns
CVC error code: Smaller than zero on error.

◆ NMUploadFileMemory()

cvbres_t NMUploadFileMemory ( NODEMAP  NodeMap,
const char *  FileSelectorEntryName,
const void *  pBuffer,
size_t  BufferSize 
)

Uploads a file to the device which is present in the Std::FileSelector and loads it from memory.

Parameters
[in]NodeMapCVB NodeMap to which the file is uploaded.
[in]FileSelectorEntryNameFile to upload.
[in]pBufferMemory to read file from.
[in]BufferSizeThe size of the pBuffer in bytes.
Returns
CVC error code: Smaller than zero on error.

◆ NMUploadFileMemoryW()

cvbres_t NMUploadFileMemoryW ( NODEMAP  NodeMap,
const wchar_t *  FileSelectorEntryName,
const void *  pBuffer,
size_t  BufferSize 
)

Uploads a file to the device which is present in the Std::FileSelector and loads it from memory.

Parameters
[in]NodeMapCVB NodeMap to which the file is uploaded.
[in]FileSelectorEntryNameFile to upload.
[in]pBufferMemory to read file from.
[in]BufferSizeThe size of the pBuffer in bytes.
Returns
CVC error code: Smaller than zero on error.

◆ NMUploadFileW()

cvbres_t NMUploadFileW ( NODEMAP  NodeMap,
const wchar_t *  FileSelectorEntryName,
const wchar_t *  Filename 
)

Uploads a file to the device which is present in the Std::FileSelector from disk.

Parameters
[in]NodeMapCVB NodeMap to which the file is uploaded.
[in]FileSelectorEntryNameFile to upload.
[in]FilenamePath to load FileSelectorEntryName from.
Returns
CVC error code: Smaller than zero on error.