Image Manager (CVGenApi.dll) 14.0
Node

Typedefs

typedef void * NODE
 Handle to object representing a node. More...
 
typedef void * NODECALLBACK
 Handle referencing a NODE specific registered callback function. More...
 
typedef void(__stdcall * TFNode) (NODE Node, void *pPrivate)
 Callback function which is called with node related events. More...
 

Type Information

cvbbool_t IsNode (NODE Node)
 Checks whether the given Node handle is valid. More...
 
cvbres_t NType (NODE Node, TNodeType &Type)
 Gets the node type (implemented GenApi interface). More...
 

NODE Access

cvbres_t NGetAsBoolean (NODE Node, cvbbool_t &Value)
 Gets the given Node value as a Boolean value. More...
 
cvbres_t NGetAsFloat (NODE Node, double &Value)
 Gets the given Node value as a double. More...
 
cvbres_t NGetAsInteger (NODE Node, cvbint64_t &Value)
 Gets the given Node value as an int64. More...
 
cvbres_t NGetAsString (NODE Node, char *Value, size_t &ValueSize)
 Gets the given Node value as a C string. More...
 
cvbres_t NGetAsStringW (NODE Node, wchar_t *Value, size_t &ValueSize)
 Gets the given Node value as a wide C string. More...
 
cvbres_t NGetAsMemory (NODE PortNode, cvbint64_t Address, void *pBuffer, size_t BufferSize)
 Reads arbitrary data from a given Address. More...
 
cvbres_t NInvalidate (NODE Node)
 Invalidates the given Node. More...
 
cvbres_t NSetAsBoolean (NODE Node, cvbbool_t Value)
 Sets the given Node value as a Boolean. More...
 
cvbres_t NSetAsFloat (NODE Node, double Value)
 Sets the given Node value as a double. More...
 
cvbres_t NSetAsInteger (NODE Node, cvbint64_t Value)
 Sets the given Node value as an int64. More...
 
cvbres_t NSetAsString (NODE Node, const char *Value)
 Sets the given Node value as a C string. More...
 
cvbres_t NSetAsStringW (NODE Node, const wchar_t *Value)
 Sets the given Node value as a wide C string. More...
 
cvbres_t NSetAsMemory (NODE PortNode, cvbint64_t Address, const void *pBuffer, size_t BufferSize)
 Writes arbitrary data to a given Address. More...
 

NODE Information

cvbres_t NInfoAsBoolean (NODE Node, TNodeInfo Cmd, cvbbool_t &Info)
 Gets information about the given Node as a Boolean value. More...
 
cvbres_t NInfoAsFloat (NODE Node, TNodeInfo Cmd, double &Info)
 Gets information about the given Node as a double value. More...
 
cvbres_t NInfoAsInteger (NODE Node, TNodeInfo Cmd, cvbint64_t &Info)
 Gets information about the given Node as an int64 value. More...
 
cvbres_t NInfoAsString (NODE Node, TNodeInfo Cmd, char *Info, size_t &InfoSize)
 Gets information about the given Node as a C string value. More...
 
cvbres_t NInfoAsStringW (NODE Node, TNodeInfo Cmd, wchar_t *Info, size_t &InfoSize)
 Gets information about the given Node as a wide C string value. More...
 
cvbres_t NInfoEnum (NODE Node, cvbdim_t Index, cvbint64_t &IntegerValue, char *StringValue, size_t &StringValueSize)
 Gets the available entries for a GenApi::IEnumeration node. More...
 
cvbres_t NInfoEnumW (NODE Node, cvbdim_t Index, cvbint64_t &IntegerValue, wchar_t *StringValue, size_t &StringValueSize)
 Gets the available entries for a GenApi::IEnumeration node. More...
 
cvbres_t NListCount (NODE Node, TNodeList List, cvbdim_t &NodeCount)
 Gets the number of entries of the specified List of the given Node. More...
 
cvbres_t NList (NODE Node, TNodeList List, cvbdim_t Index, char *Entry, size_t &EntrySize)
 Gets the node Entry name at the given Index. More...
 
cvbres_t NListW (NODE Node, TNodeList List, cvbdim_t Index, wchar_t *Entry, size_t &EntrySize)
 Gets the node Entry name at the given Index. More...
 
cvbres_t NGetVerifyMode (NODE Node, TVerifyMode &Mode)
 Gets the current #TVerifyMode of this node. More...
 
cvbres_t NSetVerifyMode (NODE Node, TVerifyMode Mode)
 Sets a new #TVerifyMode for this node. More...
 

NODE Callback Handling

cvbres_t NRegisterUpdate (NODE Node, TFNode Callback, void *pPrivate, NODECALLBACK &Handle)
 Registers the node updated callback. More...
 
cvbres_t NDeregisterUpdate (NODE Node, NODECALLBACK Handle)
 Unregisters a formerly registered function. More...
 

NODE functions

cvbres_t NInfoAsBoolean (NODE Node, ::TNodeInfo Cmd, cvbbool_t &Info)
 
cvbres_t NInfoAsFloat (NODE Node, ::TNodeInfo Cmd, double &Info)
 
cvbres_t NInfoAsInteger (NODE Node, ::TNodeInfo Cmd, cvbint64_t &Info)
 
cvbres_t NInfoAsString (NODE Node, ::TNodeInfo Cmd, char *Info, size_t &InfoSize)
 
cvbres_t NInfoAsStringW (NODE Node, ::TNodeInfo Cmd, wchar_t *Info, size_t &InfoSize)
 

Detailed Description

Typedef Documentation

◆ NODE

Handle to object representing a node.

All types of nodes are referenced via this handle.

See also
TNodeType

◆ NODECALLBACK

Handle referencing a NODE specific registered callback function.

This handle identifies a registered callback function on a node. Use this handle to unregister the callback on the node it was registered on.

See also
NRegisterUpdate
NDeregisterUpdate

◆ TFNode

void(* TFNode)(NODE Node, void *pPrivate)

Callback function which is called with node related events.

This function can be registered by the NRegisterUpdate function to get notifications on invalidated (and thus updated) nodes.

Attention
The call of this function does not necessarily mean that the given Node is currently accessible. Invalidations also occur when the Node access status changes (e.g. from AM_RO to AM_NA).
Parameters
Node[in] Node object that was invalidated (changed).
pPrivate[in] Pointer to user data given in the register function.

Function Documentation

◆ IsNode()

cvbbool_t IsNode ( NODE  Node)

Checks whether the given Node handle is valid.

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

◆ NDeregisterUpdate()

cvbres_t NDeregisterUpdate ( NODE  Node,
NODECALLBACK  Handle 
)

Unregisters a formerly registered function.

Parameters
[in]NodeCVB Node to access.
[in]HandleHandle of callback function to be unregistered.
Returns
CVC error code: Smaller than zero on error.

◆ NGetAsBoolean()

cvbres_t NGetAsBoolean ( NODE  Node,
cvbbool_t &  Value 
)

Gets the given Node value as a Boolean value.

If the value of the node is not readable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[out]ValueReference to variable in which the current value of the node is written.
Returns
CVC error code: Smaller than zero on error.

◆ NGetAsFloat()

cvbres_t NGetAsFloat ( NODE  Node,
double &  Value 
)

Gets the given Node value as a double.

If the value of the node is not readable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[out]ValueReference to variable in which the current value of the node is written.
Returns
CVC error code: Smaller than zero on error.

◆ NGetAsInteger()

cvbres_t NGetAsInteger ( NODE  Node,
cvbint64_t &  Value 
)

Gets the given Node value as an int64.

If the value of the node is not readable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[out]ValueReference to variable in which the current value of the node is written.
Returns
CVC error code: Smaller than zero on error.

◆ NGetAsMemory()

cvbres_t NGetAsMemory ( NODE  PortNode,
cvbint64_t  Address,
void *  pBuffer,
size_t  BufferSize 
)

Reads arbitrary data from a given Address.

Attention
This function only works on NT_Port nodes.
Parameters
[in]PortNodeThe port node to read data from.
[in]AddressAddress to read from.
[in]pBufferBuffer to write read data to.
[in]BufferSizeSize of the given pBuffer memory.
Returns
CVC error code: Smaller than zero on error.

◆ NGetAsString()

cvbres_t NGetAsString ( NODE  Node,
char *  Value,
size_t &  ValueSize 
)

Gets the given Node value as a C string.

If the value of the node is not readable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[out]ValueC string to be filled with requested value; NULL for size inquiry (see ValueSize).
[in,out]ValueSizeGives the buffer size of Value or receives the minimal needed size (including the terminating zero in either case) if Value is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NGetAsStringW()

cvbres_t NGetAsStringW ( NODE  Node,
wchar_t *  Value,
size_t &  ValueSize 
)

Gets the given Node value as a wide C string.

If the value of the node is not readable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[out]ValueWide C string to be filled with requested value; NULL for size inquiry (see ValueSize).
[in,out]ValueSizeGives the buffer size of Value or receives the minimal needed size if Value is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NGetVerifyMode()

cvbres_t NGetVerifyMode ( NODE  Node,
TVerifyMode &  Mode 
)

Gets the current #TVerifyMode of this node.

The mode indicates whether value reads and/or writes are to be verified. If a value is out of range no value is set/returned and an appropriate error code is returned.

Parameters
[in]NodeCVB Node to access.
[out]ModeReference to variable to contain the current mode.
Returns
CVC error code: Smaller than zero on error.

◆ NInfoAsBoolean()

cvbres_t NInfoAsBoolean ( NODE  Node,
TNodeInfo  Cmd,
cvbbool_t &  Info 
)

Gets information about the given Node as a Boolean value.

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

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

◆ NInfoAsFloat()

cvbres_t NInfoAsFloat ( NODE  Node,
TNodeInfo  Cmd,
double &  Info 
)

Gets information about the given Node as a double value.

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

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

◆ NInfoAsInteger()

cvbres_t NInfoAsInteger ( NODE  Node,
TNodeInfo  Cmd,
cvbint64_t &  Info 
)

Gets information about the given Node as an int64 value.

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

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

◆ NInfoAsString()

cvbres_t NInfoAsString ( NODE  Node,
TNodeInfo  Cmd,
char *  Info,
size_t &  InfoSize 
)

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

Parameters
[in]NodeCVB Node 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 minimal needed size if Info is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NInfoAsStringW()

cvbres_t NInfoAsStringW ( NODE  Node,
TNodeInfo  Cmd,
wchar_t *  Info,
size_t &  InfoSize 
)

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

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

◆ NInfoEnum()

cvbres_t NInfoEnum ( NODE  Node,
cvbdim_t  Index,
cvbint64_t &  IntegerValue,
char *  StringValue,
size_t &  StringValueSize 
)

Gets the available entries for a GenApi::IEnumeration node.

The number of available enumeration entries can be inquired with the NL_EnumEntry command of the NInfoAsInteger function.

Parameters
[in]NodeCVB Node to access.
[in]IndexIndex of entry to access [0 ... NListCount (NL_EnumEntry) - 1].
[out]IntegerValueInteger representation of enumeration entry.
[out]StringValueC string to be filled with string representation of the enumeration entry; NULL for size inquiry (see StringValueSize).
[out]StringValueSizeGives the buffer size of StringValue or receives the needed size if StringValue is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NInfoEnumW()

cvbres_t NInfoEnumW ( NODE  Node,
cvbdim_t  Index,
cvbint64_t &  IntegerValue,
wchar_t *  StringValue,
size_t &  StringValueSize 
)

Gets the available entries for a GenApi::IEnumeration node.

The number of available enumeration entries can be inquired with the NL_EnumEntry command of the NInfoAsInteger function.

Parameters
[in]NodeCVB Node to access.
[in]IndexIndex of entry to access [0 ... NListCount (NL_EnumEntry) - 1].
[out]IntegerValueInteger representation of enumeration entry.
[out]StringValueWide C string to be filled with string representation of the enumeration entry; NULL for size inquiry (see StringValueSize).
[out]StringValueSizeGives the buffer size of StringValue or receives the needed size if StringValue is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NInvalidate()

cvbres_t NInvalidate ( NODE  Node)

Invalidates the given Node.

Resets the changed status of the given Node. If the value is cached the next time this node is accessed the actual value from the device is read. All features which depend on this one are also updated.

Parameters
[in]NodeCVB Node to be invalidated.
Returns
CVC error code: Smaller than zero on error.

◆ NList()

cvbres_t NList ( NODE  Node,
TNodeList  List,
cvbdim_t  Index,
char *  Entry,
size_t &  EntrySize 
)

Gets the node Entry name at the given Index.

Parameters
[in]NodeCVB Node to access.
[in]ListType of list of the Node to be accessed.
[in]IndexIndex of entry to access.
[out]EntryName of node entry at the given Index.
[in,out]EntrySizeSize of Entry buffer; inquiry of min number of bytes if Entry is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NListCount()

cvbres_t NListCount ( NODE  Node,
TNodeList  List,
cvbdim_t &  NodeCount 
)

Gets the number of entries of the specified List of the given Node.

Parameters
[in]NodeCVB Node to access.
[in]ListType of list of the NODE to be accessed.
[out]NodeCountNumber of entries in the List.
Returns
CVC error code: Smaller than zero on error.

◆ NListW()

cvbres_t NListW ( NODE  Node,
TNodeList  List,
cvbdim_t  Index,
wchar_t *  Entry,
size_t &  EntrySize 
)

Gets the node Entry name at the given Index.

Parameters
[in]NodeCVB Node to access.
[in]ListType of list of the Node to be accessed.
[in]IndexIndex of entry to access.
[out]EntryName of node entry at the given Index.
[in,out]EntrySizeSize of Entry buffer; inquiry of min number of bytes if Entry is NULL.
Returns
CVC error code: Smaller than zero on error.

◆ NRegisterUpdate()

cvbres_t NRegisterUpdate ( NODE  Node,
TFNode  Callback,
void *  pPrivate,
NODECALLBACK Handle 
)

Registers the node updated callback.

This callback is called when a node is invalidated (changed).

Parameters
[in]NodeCVB Node to access.
[in]CallbackCallback function pointer of function being called.
[in]pPrivateUser data pointer to be given in Callback function.
[out]HandleHandle identifying the registered function. Needed to unregister the callback.
Returns
CVC error code: Smaller than zero on error.

◆ NSetAsBoolean()

cvbres_t NSetAsBoolean ( NODE  Node,
cvbbool_t  Value 
)

Sets the given Node value as a Boolean.

If the value of the node is not writable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[in]ValueNew value of the node.
Returns
CVC error code: Smaller than zero on error.

◆ NSetAsFloat()

cvbres_t NSetAsFloat ( NODE  Node,
double  Value 
)

Sets the given Node value as a double.

If the value of the node is not writable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[in]ValueNew value of the node.
Returns
CVC error code: Smaller than zero on error.

◆ NSetAsInteger()

cvbres_t NSetAsInteger ( NODE  Node,
cvbint64_t  Value 
)

Sets the given Node value as an int64.

If the value of the node is not writable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[in]ValueNew value of the node.
Returns
CVC error code: Smaller than zero on error.

◆ NSetAsMemory()

cvbres_t NSetAsMemory ( NODE  PortNode,
cvbint64_t  Address,
const void *  pBuffer,
size_t  BufferSize 
)

Writes arbitrary data to a given Address.

Attention
This function only works on NT_Port nodes.
Parameters
[in]PortNodeThe port node to write data to.
[in]AddressAddress to write to.
[in]pBufferBuffer to write data from.
[in]BufferSizeSize of the given pBuffer memory.
Returns
CVC error code: Smaller than zero on error.

◆ NSetAsString()

cvbres_t NSetAsString ( NODE  Node,
const char *  Value 
)

Sets the given Node value as a C string.

If the value of the node is not writable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[in]ValueNew value of the node. This string must be 0 terminated.
Returns
CVC error code: Smaller than zero on error.

◆ NSetAsStringW()

cvbres_t NSetAsStringW ( NODE  Node,
const wchar_t *  Value 
)

Sets the given Node value as a wide C string.

If the value of the node is not writable in this type an error is returned.

Parameters
[in]NodeCVB Node to access.
[in]ValueNew value of the node. This string must be 0 terminated.
Returns
CVC error code: Smaller than zero on error.

◆ NSetVerifyMode()

cvbres_t NSetVerifyMode ( NODE  Node,
TVerifyMode  Mode 
)

Sets a new #TVerifyMode for this node.

The mode indicates whether value reads and/or writes are to be verified. If a value is out of range no value is set/returned and an appropriate error code is returned.

Parameters
[in]NodeCVB Node to access.
[out]ModeNew mode.
Returns
CVC error code: Smaller than zero on error.

◆ NType()

cvbres_t NType ( NODE  Node,
TNodeType &  Type 
)

Gets the node type (implemented GenApi interface).

Only value types are supported (GenApi::IValue).

Parameters
[in]NodeCVB Node to retrieve information about.
[out]TypeGenApi node type of node.
Returns
CVC error code: Smaller than zero on error.