Functions | |
GSNODE | CreateGSBooleanNode (const char *NodeName, TGSNamespace Namespace) |
Creates a boolean node with the given NodeName as C string in the given Namespace which can be used to map arbitrary values in an integer node. More... | |
GSNODE | CreateGSBooleanNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates a boolean node with the given NodeName as wide C string in the given Namespace which can be used to map arbitrary values in an integer node. More... | |
GSNODE | CreateGSCategoryNode (const char *NodeName, TGSNamespace Namespace) |
Creates a category node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSCategoryNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates a category node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSCommandNode (const char *NodeName, TGSNamespace Namespace) |
Creates a command node with the given NodeName as C string in the given Namespace to start an prolonged execution in a device. More... | |
GSNODE | CreateGSCommandNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates a command node with the given NodeName as wide C string in the given Namespace to start an prolonged execution in a device. More... | |
GSNODE | CreateGSEnumEntryNode (const char *NodeName, TGSNamespace Namespace) |
Creates an enumeration entry node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSEnumEntryNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates an enumeration entry node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSEnumerationNode (const char *NodeName, TGSNamespace Namespace) |
Creates an enumeration node (GenApi IEnumeration ) with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSEnumerationNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates an enumeration node (GenApi IEnumeration ) with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSFloat32Node (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 32bit float node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSFloat32NodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 32bit float node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSFloat64Node (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 64bit register float node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSFloat64NodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 64bit register float node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSFloatNode (const char *NodeName, TGSNamespace Namespace) |
Creates an float node which is not directly connected to a register (GenApi IFloat) with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSFloatNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates an float node which is not directly connected to a register (GenApi IFloat) with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSFloatRegNode (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a variable sized float register node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSFloatRegNodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a variable sized float register node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSInt32Node (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 32bit integer node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSInt32NodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 32bit integer node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSInt64Node (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 64bit register integer node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSInt64NodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address) |
Creates a 64bit register integer node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSIntegerNode (const char *NodeName, TGSNamespace Namespace) |
Creates an integer node which is not directly connected to a register (GenApi IInteger) with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSIntegerNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates an integer node which is not directly connected to a register (GenApi IInteger) with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSIntRegNode (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a variable sized integer register node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSIntRegNodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a variable sized integer register node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSIntSwissKnifeNode (const char *NodeName, TGSNamespace Namespace) |
Creates a integer swiss knife node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSIntSwissKnifeNodeW (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates a integer swiss knife node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSStringNode (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a string registry node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSStringNodeEx (const char *NodeName, TGSNamespace Namespace) |
Creates a string node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSStringNodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a string register node with the given NodeName as wide C string in the given Namespace. More... | |
GSNODE | CreateGSStringNodeWEx (const wchar_t *NodeName, TGSNamespace Namespace) |
Creates a string node with the given NodeName as wide string in the given Namespace. More... | |
GSNODE | CreateGSStringRegNode (const char *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a string node with the given NodeName as C string in the given Namespace. More... | |
GSNODE | CreateGSStringRegNodeW (const wchar_t *NodeName, TGSNamespace Namespace, cvbint64_t Address, cvbint64_t Length) |
Creates a string node with the given NodeName as wide C string in the given Namespace. More... | |
cvbres_t | GSAddNode (GEVSRV Server, GSNODE Node) |
Adds the given Node to the Server register map. More... | |
cvbres_t | GSGetNode (GEVSRV Server, const char *NodeName, GSNODE &Node) |
Gets the node from the Server with the given NodeName. More... | |
cvbres_t | GSGetNodeW (GEVSRV Server, const wchar_t *NodeName, GSNODE &Node) |
Gets the node from the Server with the given NodeName. More... | |
cvbres_t | GSNAddNode (GSNODE Node, TGSNodeList Cmd, GSNODE ToAdd) |
Adds the given ToAdd node to the given Node specified by the Cmd. Used for simple indexed lists. More... | |
cvbres_t | GSNAddNodeEx (GSNODE Node, TGSNodeList Cmd, const char *Key, GSNODE ToAdd) |
Adds the given ToAdd node to the given Node to the location specified the Cmd and Key as C string. More... | |
cvbres_t | GSNAddNodeExW (GSNODE Node, TGSNodeList Cmd, const wchar_t *Key, GSNODE ToAdd) |
Adds the given ToAdd node to the given Node to the location specified the Cmd and Key as wide C string. More... | |
cvbres_t | GSNGetAsBoolean (GSNODE Node, cvbbool_t &Value) |
Gets the current value of the given Node as a boolean. More... | |
cvbres_t | GSNGetAsFloat (GSNODE Node, double &Value) |
Gets the value of the given Node as a float. More... | |
cvbres_t | GSNGetAsInteger (GSNODE Node, cvbint64_t &Value) |
Gets the value of the given Node as an integer. More... | |
cvbres_t | GSNGetAsString (GSNODE Node, char *Value, size_t &ValueSize) |
Gets the value of the given Node as a C string. More... | |
cvbres_t | GSNGetAsStringW (GSNODE Node, wchar_t *Value, size_t &ValueSize) |
Gets the value of the given Node as a wide C string. More... | |
cvbres_t | GSNGetInfoAsFloat (GSNODE Node, TGSNodeInfo Cmd, double &Info) |
Gets an informational part of the given Node specified by the Cmd as a float. More... | |
cvbres_t | GSNGetInfoAsInteger (GSNODE Node, TGSNodeInfo Cmd, cvbint64_t &Info) |
Gets an informational part of the given Node specified by the Cmd as an integer. More... | |
cvbres_t | GSNGetInfoAsNode (GSNODE Node, TGSNodeInfo Cmd, GSNODE &ValueNode) |
Gets an informational part of the given Node specified by the Cmd as a GSNODE . More... | |
cvbres_t | GSNGetInfoAsString (GSNODE Node, TGSNodeInfo Cmd, char *Info, size_t &Length) |
Gets an informational part of the given Node specified by the Cmd as C string. More... | |
cvbres_t | GSNGetInfoAsStringW (GSNODE Node, TGSNodeInfo Cmd, wchar_t *Info, size_t &Length) |
Gets an informational part of the given Node specified by the Cmd as wide C string. More... | |
cvbres_t | GSNGetNode (GSNODE Node, TGSNodeList Cmd, const char *NodeName, GSNODE &ChildNode) |
Gets the ChildNode from the given Node. More... | |
cvbres_t | GSNGetNodeW (GSNODE Node, TGSNodeList Cmd, const wchar_t *NodeName, GSNODE &ChildNode) |
Gets the ChildNode from the given Node. More... | |
cvbres_t | GSNList (GSNODE Node, TGSNodeList Cmd, size_t Index, char *EntryName, size_t &EntryLength) |
Gets the node name (EntryName) in the list defined by Cmd as C string. More... | |
cvbres_t | GSNListCount (GSNODE Node, TGSNodeList Cmd, size_t &NodeCount) |
Gets the number of nodes in the list defined by Cmd. More... | |
cvbres_t | GSNListEx (GSNODE Node, TGSNodeList Cmd, size_t Index, char *EntryName, size_t &EntryLength, char *KeyName, size_t &KeyLength) |
Gets the node (EntryName) and key (KeyName) as C string in the list defined by Cmd. More... | |
cvbres_t | GSNListExW (GSNODE Node, TGSNodeList Cmd, size_t Index, wchar_t *EntryName, size_t &EntryLength, wchar_t *KeyName, size_t &KeyLength) |
Gets the node (EntryName) and key (KeyName) as wide C string in the list defined by Cmd. More... | |
cvbres_t | GSNListW (GSNODE Node, TGSNodeList Cmd, size_t Index, wchar_t *EntryName, size_t &EntryLength) |
Gets the node name (EntryName) in the list defined by Cmd as wide C string. More... | |
cvbres_t | GSNodeCount (GEVSRV Server, size_t &NodeCount) |
Gets the number of GenApi feature nodes known to the Server. More... | |
cvbres_t | GSNodeList (GEVSRV Server, size_t Index, char *EntryName, size_t &EntryLength) |
Gets a node name (EntryName) as C string at the given Index. More... | |
cvbres_t | GSNodeListW (GEVSRV Server, size_t Index, wchar_t *EntryName, size_t &EntryLength) |
Gets a node name (EntryName) as wide C string at the given Index. More... | |
cvbres_t | GSNRegisterEvent (GSNODE Node, TGSNodeEvent EventID, TFGEVSrv Callback, void *pPrivate, size_t &CallbackID) |
Registers the given EventID on the given Node. More... | |
cvbres_t | GSNRegisterEventWithStatus (GSNODE Node, TGSNodeEvent EventID, TFGEVSrvStatus Callback, void *pPrivate, size_t &CallbackID) |
Registers the given EventID on the given Node. More... | |
cvbres_t | GSNRemoveNode (GSNODE Node, TGSNodeList Cmd, GSNODE ToRemove) |
Removes the given ToRemove node from the given Node. More... | |
cvbres_t | GSNRemoveNodeEx (GSNODE Node, TGSNodeList Cmd, const char *Key) |
Removes the node identified by the given Key as C string from the given Node. More... | |
cvbres_t | GSNRemoveNodeExW (GSNODE Node, TGSNodeList Cmd, const wchar_t *Key) |
Removes the node identified by the given Key as wide C string from the given Node. More... | |
cvbres_t | GSNSetAsBoolean (GSNODE Node, cvbbool_t Value) |
Sets the value of the given Node as a boolean. More... | |
cvbres_t | GSNSetAsFloat (GSNODE Node, double Value) |
Sets the value of the given Node as a float. More... | |
cvbres_t | GSNSetAsInteger (GSNODE Node, cvbint64_t Value) |
Sets the value of the given Node as an integer. More... | |
cvbres_t | GSNSetAsString (GSNODE Node, const char *Value) |
Sets the value of the given Node as a C string. More... | |
cvbres_t | GSNSetAsStringW (GSNODE Node, const wchar_t *Value) |
Sets the value of the given Node as a wide C string. More... | |
cvbres_t | GSNSetInfoAsFloat (GSNODE Node, TGSNodeInfo Cmd, double Info) |
Sets an informational part of the given Node specified by the Cmd as a float. More... | |
cvbres_t | GSNSetInfoAsInteger (GSNODE Node, TGSNodeInfo Cmd, cvbint64_t Info) |
Sets an informational part of the given Node specified by the Cmd as an integer. More... | |
cvbres_t | GSNSetInfoAsNode (GSNODE Node, TGSNodeInfo Cmd, GSNODE ValueNode) |
Sets an informational part of the given Node specified by the Cmd as a GSNODE . More... | |
cvbres_t | GSNSetInfoAsString (GSNODE Node, TGSNodeInfo Cmd, const char *Info) |
Sets an informational part of the given Node specified by the Cmd as C string. More... | |
cvbres_t | GSNSetInfoAsStringW (GSNODE Node, TGSNodeInfo Cmd, const wchar_t *Info) |
Sets an informational part of the given Node specified by the Cmd as wide C string. More... | |
cvbres_t | GSNType (GSNODE Node, TGSNodeType &Type) |
Gets the feature type of the given Node. More... | |
cvbres_t | GSNUnregisterEvent (GSNODE Node, TGSNodeEvent EventID, size_t CallbackID) |
Unregisters the given CallbackID from the given Node. More... | |
cvbres_t | GSRemoveNode (GEVSRV Server, GSNODE Node) |
Removes the given Node from the Server register map. More... | |
cvbbool_t | IsGSNode (GSNODE Node) |
Tries to check whether the given Node handle is a valid object. More... | |
GSNODE CreateGSBooleanNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a boolean node with the given NodeName as C string in the given Namespace which can be used to map arbitrary values in an integer node.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | C string Name of the node (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IBoolean
section in the Theory of Operation chapter for more information. GSNODE CreateGSBooleanNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a boolean node with the given NodeName as wide C string in the given Namespace which can be used to map arbitrary values in an integer node.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Wide C string Name of the node (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IBoolean
section in the Theory of Operation chapter for more information. GSNODE CreateGSCategoryNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a category node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).ICategory
section in the Theory of Operation chapter for more information.GSNODE CreateGSCategoryNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a category node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).ICategory
section in the Theory of Operation chapter for more information.GSNODE CreateGSCommandNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a command node with the given NodeName as C string in the given Namespace to start an prolonged execution in a device.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).ICommand
section in the Theory of Operation chapter for more information GSNODE CreateGSCommandNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a command node with the given NodeName as wide C string in the given Namespace to start an prolonged execution in a device.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).ICommand
section in the Theory of Operation chapter for more information GSNODE CreateGSEnumEntryNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an enumeration entry node with the given NodeName as C string in the given Namespace.
The node needs not to be added to the server, but only to the enumeration node which should use it.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IEnumEntry
section in the Theory of Operation chapter for more information.GSNODE CreateGSEnumEntryNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an enumeration entry node with the given NodeName as wide C string in the given Namespace.
The node needs not to be added to the server, but only to the enumeration node which should use it.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IEnumEntry
section in the Theory of Operation chapter for more information.GSNODE CreateGSEnumerationNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an enumeration node (GenApi IEnumeration
) with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IEnumeration
section in the Theory of Operation chapter for more information.GSNODE CreateGSEnumerationNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an enumeration node (GenApi IEnumeration
) with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IEnumeration
section in the Theory of Operation chapter for more information.GSNODE CreateGSFloat32Node | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 32bit float node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IFLoatReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSFloat32NodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 32bit float node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IFLoatReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSFloat64Node | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 64bit register float node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IFloatReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSFloat64NodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 64bit register float node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IFloatReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSFloatNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an float node which is not directly connected to a register (GenApi IFloat) with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IFloatNode
section in the Theory of Operation chapter for more information GSNODE CreateGSFloatNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an float node which is not directly connected to a register (GenApi IFloat) with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IFloatNode
section in the Theory of Operation chapter for more information GSNODE CreateGSFloatRegNode | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a variable sized float register node with the given NodeName as C string in the given Namespace.
This function creates a freely addressable float register. This also means, that no register memory is allocated in the server backing register read/writes.
You can use such a node for e.g. aliasing other registers or implementing a selector register.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; no auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be either four or eight. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSFloatRegNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a variable sized float register node with the given NodeName as wide C string in the given Namespace.
This function creates a freely addressable float register. This also means, that no register memory is allocated in the server backing register read/writes.
You can use such a node for e.g. aliasing other registers or implementing a selector register.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; no auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be either four or eight. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSInt32Node | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 32bit integer node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntReg
section in the Theory of Operation chapter for more information.GSNODE CreateGSInt32NodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 32bit integer node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntReg
section in the Theory of Operation chapter for more information.GSNODE CreateGSInt64Node | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 64bit register integer node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSInt64NodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address | ||
) |
Creates a 64bit register integer node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
GSNODE
containing the node handle, nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSIntegerNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an integer node which is not directly connected to a register (GenApi IInteger) with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntegerNode
section in the Theory of Operation chapter for more information GSNODE CreateGSIntegerNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates an integer node which is not directly connected to a register (GenApi IInteger) with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntegerNode
section in the Theory of Operation chapter for more information GSNODE CreateGSIntRegNode | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a variable sized integer register node with the given NodeName as C string in the given Namespace.
This function creates a freely addressable integer register. This also means, that no register memory is allocated in the server backing register read/writes.
You can use such a node for e.g. aliasing other registers or implementing a selector register.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; no auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be either four or eight. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSIntRegNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a variable sized integer register node with the given NodeName as wide C string in the given Namespace.
This function creates a freely addressable integer register. This also means, that no register memory is allocated in the server backing register read/writes.
You can use such a node for e.g. aliasing other registers or implementing a selector register.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; no auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be either four or eight. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSIntSwissKnifeNode | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a integer swiss knife node with the given NodeName as C string in the given Namespace.
Swiss-knifes are used to calculate values based on other integer nodes. The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntSwissKnife
section in the Theory of Operation chapter for more information.IntSwissKnife
and add it to a server: GSNODE CreateGSIntSwissKnifeNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a integer swiss knife node with the given NodeName as wide C string in the given Namespace.
Swiss-knifes are used to calculate values based on other integer nodes. The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IIntSwissKnife
section in the Theory of Operation chapter for more information.IntSwissKnife
and add it to a server: GSNODE CreateGSStringNode | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a string registry node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be a multiple of four. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSStringNodeEx | ( | const char * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a string node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IString
section in the Theory of Operation chapter for more information. GSNODE CreateGSStringNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a string register node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be a multiple of four. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSStringNodeWEx | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace | ||
) |
Creates a string node with the given NodeName as wide string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IString
section in the Theory of Operation chapter for more information. GSNODE CreateGSStringRegNode | ( | const char * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a string node with the given NodeName as C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be a multiple of four. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. GSNODE CreateGSStringRegNodeW | ( | const wchar_t * | NodeName, |
TGSNamespace | Namespace, | ||
cvbint64_t | Address, | ||
cvbint64_t | Length | ||
) |
Creates a string node with the given NodeName as wide C string in the given Namespace.
The node needs to be added to a server before most of the operations on it are valid.
[in] | NodeName | Name of the node as wide C string (Must start with a letter (a-z) and may contain numbers and the underscore '_'). |
[in] | Namespace | Namespace the node should reside in. |
[in] | Address | Address in the register map; -1 for auto-address. Must be a multiple of four. |
[in] | Length | Length of the string in bytes. Must be a multiple of four. |
GSNODE
containing the node handle; nullptr
on error (Use GSGetLastErrorString function for a human readable error description).IStringReg
section in the Theory of Operation chapter for more information. Adds the given Node to the Server register map.
This is possible as long as the Server is not started and no node with the same name is present.
[in] | Server | Server object to retrieve node from. |
[in] | Node | Node to add to the Server register map. |
Gets the node from the Server with the given NodeName.
To enumerate all the node names known to the Server use the GSNodeList function.
[in] | Server | Server object to retrieve node from. |
[in] | NodeName | Name without namespace of the node to retrieve (zero-terminated). |
[out] | Node | Handle of the node with the given NodeName. |
Gets the node from the Server with the given NodeName.
To enumerate all the node names known to the Server use the GSNodeList function.
[in] | Server | Server object to retrieve node from. |
[in] | NodeName | Name without namespace of the node to retrieve (zero-terminated). |
[out] | Node | Handle of the node with the given NodeName. |
cvbres_t GSNAddNode | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
GSNODE | ToAdd | ||
) |
Adds the given ToAdd node to the given Node specified by the Cmd. Used for simple indexed lists.
[in] | Node | Node to add the other ToAdd node to. |
[in] | Cmd | Where to add. |
[in] | ToAdd | Node to add. |
cvbres_t GSNAddNodeEx | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
const char * | Key, | ||
GSNODE | ToAdd | ||
) |
Adds the given ToAdd node to the given Node to the location specified the Cmd and Key as C string.
Used for map-like lists which use keys to reference nodes.
[in] | Node | Node to add the other ToAdd node to. |
[in] | Cmd | Where to add. |
[in] | Key | Key as C string which is e.g. a variable name for the node ToAdd. |
[in] | ToAdd | Node to add. |
cvbres_t GSNAddNodeExW | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
const wchar_t * | Key, | ||
GSNODE | ToAdd | ||
) |
Adds the given ToAdd node to the given Node to the location specified the Cmd and Key as wide C string.
Used for map-like lists which use keys to reference nodes.
[in] | Node | Node to add the other ToAdd node to. |
[in] | Cmd | Where to add. |
[in] | Key | Key as wide C string which is e.g. a variable name for the node ToAdd. |
[in] | ToAdd | Node to add. |
cvbres_t GSNGetAsBoolean | ( | GSNODE | Node, |
cvbbool_t & | Value | ||
) |
Gets the current value of the given Node as a boolean.
Only works on nodes implementing the IBoolean
and ICommand
GenApi interfaces.
[in] | Node | Node to query value from. |
[out] | Value | Current value of the Node; in case of a command this is the IsDone result if the command is readable. |
IBoolean
and ICommand sections in the Theory of Operation chapter for more information. cvbres_t GSNGetAsFloat | ( | GSNODE | Node, |
double & | Value | ||
) |
Gets the value of the given Node as a float.
Only works on nodes implementing the IFloat
and IEnumeration
GenApi interfaces.
[in] | Node | Node to query value from. |
[out] | Value | Current value of the Node. |
IFloat
section in the Theory of Operation chapter for more information. cvbres_t GSNGetAsInteger | ( | GSNODE | Node, |
cvbint64_t & | Value | ||
) |
Gets the value of the given Node as an integer.
Only works on nodes implementing the IInteger
and IEnumeration
GenApi interfaces.
[in] | Node | Node to query value from. |
[out] | Value | Current value of the Node. |
IInteger
section in the Theory of Operation chapter for more information.cvbres_t GSNGetAsString | ( | GSNODE | Node, |
char * | Value, | ||
size_t & | ValueSize | ||
) |
Gets the value of the given Node as a C string.
Only works on nodes implementing the IString
and IEnumeration
and IEnumEntry
GenApi interfaces.
[in] | Node | Node to query value from. |
[in] | Value | If not nullptr this is the C string buffer to be filled with the info; nullptr if size query is to be performed. |
[in,out] | ValueSize | Set with minimal buffer needed including zero-termination if Value is nullptr ; if Value is not nullptr this is set to the minimal size of the Value buffer in bytes (including zero-termination). |
IStringReg
, IEnumeration
and IEnumEntry
sections in the Theory of Operation chapter for more information. cvbres_t GSNGetAsStringW | ( | GSNODE | Node, |
wchar_t * | Value, | ||
size_t & | ValueSize | ||
) |
Gets the value of the given Node as a wide C string.
Only works on nodes implementing the IString
and IEnumeration
and IEnumEntry
GenApi interfaces.
[in] | Node | Node to query value from. |
[in] | Value | If not nullptr this is the wide C string buffer to be filled with the info; nullptr if size query is to be performed. |
[in,out] | ValueSize | Set with minimal buffer needed including zero-termination if Value is nullptr ; if Value is not nullptr this is set to the minimal size of the Value buffer in bytes (including zero-termination). |
IStringReg
, IEnumeration
and IEnumEntry
sections in the Theory of Operation chapter for more information. cvbres_t GSNGetInfoAsFloat | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
double & | Info | ||
) |
Gets an informational part of the given Node specified by the Cmd as a float.
Not every information can be queried as a float.
[in] | Node | Node to query information from. |
[in] | Cmd | Information to query. |
[out] | Info | Information queried as a float. |
cvbres_t GSNGetInfoAsInteger | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
cvbint64_t & | Info | ||
) |
Gets an informational part of the given Node specified by the Cmd as an integer.
Not every information can be queried as an integer.
[in] | Node | Node to query information from. |
[in] | Cmd | Information to query. |
[out] | Info | Information queried as an integer. |
cvbres_t GSNGetInfoAsNode | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
GSNODE & | ValueNode | ||
) |
Gets an informational part of the given Node specified by the Cmd as a GSNODE
.
If a fixed value is set, this function will return CVC_ERROR(CVC_E_OK), but will set ValueNode to nullptr
. Not every information can be queried as a GSNODE.
[in] | Node | Node to get info from. |
[in] | Cmd | Type of information to get. |
[out] | ValueNode | Reference to handle to receive the node for the given Cmd; nullptr if no node is set. |
cvbres_t GSNGetInfoAsString | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
char * | Info, | ||
size_t & | Length | ||
) |
Gets an informational part of the given Node specified by the Cmd as C string.
Not every information can be queried as a string.
[in] | Node | Node to retrieve info about. |
[in] | Cmd | Type of information to retrieve as C string |
[in] | Info | If not nullptr this is the buffer to be filled with the info; nullptr if size query is to be performed. |
[in,out] | Length | Set with minimal buffer needed including zero-termination if Info is nullptr ; if Info is not nullptr this is set to the minimal size of the Info buffer in bytes (including zero-termination). |
cvbres_t GSNGetInfoAsStringW | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
wchar_t * | Info, | ||
size_t & | Length | ||
) |
Gets an informational part of the given Node specified by the Cmd as wide C string.
Not every information can be queried as a string.
[in] | Node | Node to retrieve info about. |
[in] | Cmd | Type of information to retrieve as wide C string |
[in] | Info | If not nullptr this is the buffer to be filled with the info; nullptr if size query is to be performed. |
[in,out] | Length | Set with minimal buffer needed including zero-termination if Info is nullptr ; if Info is not nullptr this is set to the minimal size of the Info buffer in bytes (including zero-termination). |
cvbres_t GSNGetNode | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
const char * | NodeName, | ||
GSNODE & | ChildNode | ||
) |
Gets the ChildNode from the given Node.
This function is used for nodes which are not directly accessible from the general node map (like inline IEnumEntry nodes).
[in] | Node | Node to get ChildNode from. |
[in] | Cmd | List to get node from. |
[in] | NodeName | Name of the node to retrieve as C string (dependent on Node). |
[out] | ChildNode | Reference to be filled with node handle. |
cvbres_t GSNGetNodeW | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
const wchar_t * | NodeName, | ||
GSNODE & | ChildNode | ||
) |
Gets the ChildNode from the given Node.
This function is used for nodes which are not directly accessible from the general node map (like inline IEnumEntry nodes).
[in] | Node | Node to get ChildNode from. |
[in] | Cmd | List to get node from. |
[in] | NodeName | Name of the node to retrieve as wide C string (dependent on Node). |
[out] | ChildNode | Reference to be filled with node handle. |
cvbres_t GSNList | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
size_t | Index, | ||
char * | EntryName, | ||
size_t & | EntryLength | ||
) |
Gets the node name (EntryName) in the list defined by Cmd as C string.
Used for simple indexed lists.
The number of entries of the list can be obtained by calling GSNListCount. The actual node handle can then be retrieved via the GSGetNode or GSNGetNode functions.
[in] | Node | Node of which a list is to be enumerated. |
[in] | Cmd | Which list to enumerate. |
[in] | Index | Zero-based index of node to retrieve. |
[in] | EntryName | Buffer to be filled with node name as C string; nullptr to inquire size. |
[in,out] | EntryLength | Size of EntryName in bytes; the minimal size in bytes if EntryName is nullptr . |
cvbres_t GSNListCount | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
size_t & | NodeCount | ||
) |
Gets the number of nodes in the list defined by Cmd.
[in] | Node | Node of which a list is to be enumerated. |
[in] | Cmd | Which list to enumerate. |
[out] | NodeCount | Number of nodes in the list. |
cvbres_t GSNListEx | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
size_t | Index, | ||
char * | EntryName, | ||
size_t & | EntryLength, | ||
char * | KeyName, | ||
size_t & | KeyLength | ||
) |
Gets the node (EntryName) and key (KeyName) as C string in the list defined by Cmd.
Used for map-like lists which use keys to reference nodes.
The number of entries of the list can be obtained by calling GSNListCount. The actual node handle can then be retrieved via the GSGetNode or GSNGetNode functions.
The key can be a variable name for e.g. SwissKnife nodes.
[in] | Node | Node of which a list is to be enumerated. |
[in] | Cmd | Which list to enumerate. |
[in] | Index | Zero-based index of node to retrieve. |
[in] | EntryName | Buffer to be filled with node name as C string; nullptr to inquire size. |
[in,out] | EntryLength | Size of EntryName in bytes; the minimal size in bytes if EntryName is nullptr . |
[in] | KeyName | Buffer to be filled with node key as C string; nullptr to inquire size. |
[in,out] | KeyLength | Size of KeyName in bytes; the minimal size in bytes if KeyName is nullptr . |
cvbres_t GSNListExW | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
size_t | Index, | ||
wchar_t * | EntryName, | ||
size_t & | EntryLength, | ||
wchar_t * | KeyName, | ||
size_t & | KeyLength | ||
) |
Gets the node (EntryName) and key (KeyName) as wide C string in the list defined by Cmd.
Used for map-like lists which use keys to reference nodes.
The number of entries of the list can be obtained by calling GSNListCount. The actual node handle can then be retrieved via the GSGetNode or GSNGetNode functions.
The key can be a variable name for e.g. SwissKnife nodes.
[in] | Node | Node of which a list is to be enumerated. |
[in] | Cmd | Which list to enumerate. |
[in] | Index | Zero-based index of node to retrieve. |
[in] | EntryName | Buffer to be filled with node name as wide C string; nullptr to inquire size. |
[in,out] | EntryLength | Size of EntryName in bytes; the minimal size in bytes if EntryName is nullptr . |
[in] | KeyName | Buffer to be filled with node key as wide C string; nullptr to inquire size. |
[in,out] | KeyLength | Size of KeyName in bytes; the minimal size in bytes if KeyName is nullptr . |
cvbres_t GSNListW | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
size_t | Index, | ||
wchar_t * | EntryName, | ||
size_t & | EntryLength | ||
) |
Gets the node name (EntryName) in the list defined by Cmd as wide C string.
Used for simple indexed lists.
The number of entries of the list can be obtained by calling GSNListCount. The actual node handle can then be retrieved via the GSGetNode or GSNGetNode functions.
[in] | Node | Node of which a list is to be enumerated. |
[in] | Cmd | Which list to enumerate. |
[in] | Index | Zero-based index of node to retrieve. |
[in] | EntryName | Buffer to be filled with node name as wide C string; nullptr to inquire size. |
[in,out] | EntryLength | Size of EntryName in bytes; the minimal size in bytes if EntryName is nullptr . |
cvbres_t GSNodeCount | ( | GEVSRV | Server, |
size_t & | NodeCount | ||
) |
Gets the number of GenApi feature nodes known to the Server.
[in] | Server | Server to enumerate nodes on. |
[out] | NodeCount | Number of nodes stored in the server. |
cvbres_t GSNodeList | ( | GEVSRV | Server, |
size_t | Index, | ||
char * | EntryName, | ||
size_t & | EntryLength | ||
) |
Gets a node name (EntryName) as C string at the given Index.
The number of available nodes can be obtained by calling GSNodeCount. With the returned EntryName a node can be queried by calling GSGetNode.
[in] | Server | Server to enumerate nodes on. |
[in] | Index | Zero-based index of the node to enumerate. |
[in] | EntryName | C string to receive the node name; nullptr to inquire name length in bytes including the zero-termination. |
[in,out] | EntryLength | Size of EntryName in bytes if not nullptr ; If EntryName is nullptr this will contain the minimal amount of bytes to store the name including the zero-termination. |
cvbres_t GSNodeListW | ( | GEVSRV | Server, |
size_t | Index, | ||
wchar_t * | EntryName, | ||
size_t & | EntryLength | ||
) |
Gets a node name (EntryName) as wide C string at the given Index.
The number of available nodes can be obtained by calling GSNodeCount. With the returned EntryName a node can be queried by calling GSGetNode.
[in] | Server | Server to enumerate nodes on. |
[in] | Index | Zero-based index of the node to enumerate. |
[in] | EntryName | Wide C string to receive the node name; nullptr to inquire name length in bytes including the zero-termination. |
[in,out] | EntryLength | Size of EntryName in bytes if not nullptr ; If EntryName is nullptr this will contain the minimal amount of bytes to store the name including the zero-termination. |
cvbres_t GSNRegisterEvent | ( | GSNODE | Node, |
TGSNodeEvent | EventID, | ||
TFGEVSrv | Callback, | ||
void * | pPrivate, | ||
size_t & | CallbackID | ||
) |
Registers the given EventID on the given Node.
[in] | Node | Node to register event on. |
[in] | EventID | Event type to get notified on. |
[in] | Callback | Callback function to call in case of EventID. |
[in] | pPrivate | Pointer to private data given as the Callback function's parameter (e.g. pointer to a class). |
[out] | CallbackID | Node and EventID wide unique callback ID used to unregister the Callback. |
IValue
section in the Theory of Operation chapter for more information.cvbres_t GSNRegisterEventWithStatus | ( | GSNODE | Node, |
TGSNodeEvent | EventID, | ||
TFGEVSrvStatus | Callback, | ||
void * | pPrivate, | ||
size_t & | CallbackID | ||
) |
Registers the given EventID on the given Node.
The difference to the GSNRegisterEvent function is that the Callback has an additional argument which references a status. With that status a callee can communicate an error to the remote client for read/write access.
As there can be multiple registered callees, best check the status before doing your own processing. If a status other than CVC_ERROR(CVC_E_OK)
is set after all callees finished their processing, the value in the node map is rolled back and an appropriate error acknowledge is sent.
[in] | Node | Node to register event on. |
[in] | EventID | Event type to get notified on. |
[in] | Callback | Callback function to call in case of EventID. |
[in] | pPrivate | Pointer to private data given as the Callback function's parameter (e.g. pointer to a class). |
[out] | CallbackID | Node and EventID wide unique callback ID used to unregister the Callback. |
IValue
section in the Theory of Operation chapter for more information.cvbres_t GSNRemoveNode | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
GSNODE | ToRemove | ||
) |
Removes the given ToRemove node from the given Node.
Used for simple indexed lists.
[in] | Node | Node to remove the other ToRemove node from. |
[in] | Cmd | Where to remove from. |
[in] | ToRemove | Node to remove. |
cvbres_t GSNRemoveNodeEx | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
const char * | Key | ||
) |
Removes the node identified by the given Key as C string from the given Node.
Used for map-like lists which use keys to reference nodes.
[in] | Node | Node to remove the other node from. |
[in] | Cmd | Where to remove from. |
[in] | Key | Identifying the node to remove as C string. |
cvbres_t GSNRemoveNodeExW | ( | GSNODE | Node, |
TGSNodeList | Cmd, | ||
const wchar_t * | Key | ||
) |
Removes the node identified by the given Key as wide C string from the given Node.
Used for map-like lists which use keys to reference nodes.
[in] | Node | Node to remove the other node from. |
[in] | Cmd | Where to remove from. |
[in] | Key | Identifying the node to remove as wide C string. |
cvbres_t GSNSetAsBoolean | ( | GSNODE | Node, |
cvbbool_t | Value | ||
) |
Sets the value of the given Node as a boolean.
Only works on nodes implementing the IBoolean
and ICommand
GenApi interfaces.
[in] | Node | Node to set value to. |
[in] | Value | New value of the Node. |
IBoolean
and ICommand
sections in the Theory of Operation chapter for more information cvbres_t GSNSetAsFloat | ( | GSNODE | Node, |
double | Value | ||
) |
Sets the value of the given Node as a float.
Only works on nodes implementing the IFloat
and IEnumeration
GenApi interfaces.
[in] | Node | Node to set value to. |
[in] | Value | New value of the Node. |
IFloat
section in the Theory of Operation chapter for more information cvbres_t GSNSetAsInteger | ( | GSNODE | Node, |
cvbint64_t | Value | ||
) |
Sets the value of the given Node as an integer.
Only works on nodes implementing the IInteger
and IEnumeration
GenApi interfaces.
[in] | Node | Node to set value to. |
[in] | Value | New value of the Node. |
IInteger
section in the Theory of Operation chapter for more informationcvbres_t GSNSetAsString | ( | GSNODE | Node, |
const char * | Value | ||
) |
Sets the value of the given Node as a C string.
Only works on nodes implementing the IString
and IEnumeration
and IEnumEntry
GenApi interfaces.
[in] | Node | Node to set value to. |
[in] | Value | New value of the Node as C string. |
IStringReg
, IEnumeration
and IEnumEntry
sections in the Theory of Operation chapter for more information. cvbres_t GSNSetAsStringW | ( | GSNODE | Node, |
const wchar_t * | Value | ||
) |
Sets the value of the given Node as a wide C string.
Only works on nodes implementing the IString
and IEnumeration
and IEnumEntry
GenApi interfaces.
[in] | Node | Node to set value to. |
[in] | Value | New value of the Node as wide C string. |
IStringReg
, IEnumeration
and IEnumEntry
sections in the Theory of Operation chapter for more information. cvbres_t GSNSetInfoAsFloat | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
double | Info | ||
) |
Sets an informational part of the given Node specified by the Cmd as a float.
Not every information can be set as a float. Set is only possible if the server has not been started yet. Also some information can only be set if the node is added to the register map.
[in] | Node | Node to set info in. |
[in] | Cmd | Type of information to set. |
[in] | Info | Information set as a float. |
cvbres_t GSNSetInfoAsInteger | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
cvbint64_t | Info | ||
) |
Sets an informational part of the given Node specified by the Cmd as an integer.
Not every information can be set as an integer. Set is only possible if the server has not been started yet. Also some information can only be set if the node is added to the register map.
[in] | Node | Node to set info in. |
[in] | Cmd | Type of information to set. |
[in] | Info | Information set as an integer. |
cvbres_t GSNSetInfoAsNode | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
GSNODE | ValueNode | ||
) |
Sets an informational part of the given Node specified by the Cmd as a GSNODE
.
The given ValueNode must be of a compatible type to Node. This would be e.g. an IntRegNode
for an IntegerNode
. Not every information can be set as a node.
[in] | Node | Node to set info in. |
[in] | Cmd | Type of information to set. |
[out] | ValueNode | Node handle of the node for the given Cmd. |
cvbres_t GSNSetInfoAsString | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
const char * | Info | ||
) |
Sets an informational part of the given Node specified by the Cmd as C string.
Not every information can be set as a string. Set is only possible if the server has not been started yet. Also some information can only be set if the node is added to the register map.
[in] | Node | Node to set info in. |
[in] | Cmd | Type of information to set as C string. |
[in] | Info | Buffer containing the new info to be set (zero terminated). |
cvbres_t GSNSetInfoAsStringW | ( | GSNODE | Node, |
TGSNodeInfo | Cmd, | ||
const wchar_t * | Info | ||
) |
Sets an informational part of the given Node specified by the Cmd as wide C string.
Not every information can be set as a string. Set is only possible if the server has not been started yet. Also some information can only be set if the node is added to the register map.
[in] | Node | Node to set info in. |
[in] | Cmd | Type of information to set as wide C string. |
[in] | Info | Buffer containing the new info to be set (zero terminated). |
cvbres_t GSNType | ( | GSNODE | Node, |
TGSNodeType & | Type | ||
) |
Gets the feature type of the given Node.
[in] | Node | Node to query. |
[out] | Type | Type of feature. |
cvbres_t GSNUnregisterEvent | ( | GSNODE | Node, |
TGSNodeEvent | EventID, | ||
size_t | CallbackID | ||
) |
Unregisters the given CallbackID from the given Node.
The previously registered callback function will not be called anymore.
[in] | Node | Node to unregister event on. |
[in] | EventID | Type of event to unregister. |
[in] | CallbackID | ID of callback function to unregister. |
IValue
section in the Theory of Operation chapter for more information. Removes the given Node from the Server register map.
This is possible as long as the Server is not started and a node with the same name is present.
[in] | Server | Server object to remove node from. |
[in] | Node | Node to remove from the Server register map. |
cvbbool_t IsGSNode | ( | GSNODE | Node | ) |
Tries to check whether the given Node handle is a valid object.
nullptr
.[in] | Node | Node handle to check. |