Functions related to the GenICam Node or Feature. More...
Typedefs | |
typedef struct BGAPI2_Node | BGAPI2_Node |
Struct for pointers of type Node. More... | |
Functions | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetInterface (BGAPI2_Node *node, char *iface, bo_uint64 *string_length) |
Returns the data type (interface) of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetExtension (BGAPI2_Node *node, char *extension, bo_uint64 *string_length) |
Returns the extension (vendor specific information) of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetToolTip (BGAPI2_Node *node, char *tool_tip, bo_uint64 *string_length) |
Returns the tooltip of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDescription (BGAPI2_Node *node, char *description, bo_uint64 *string_length) |
Returns the description of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetName (BGAPI2_Node *node, char *name, bo_uint64 *string_length) |
Returns the name of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDisplayname (BGAPI2_Node *node, char *display_name, bo_uint64 *string_length) |
Returns the "user friendly" display name of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetVisibility (BGAPI2_Node *node, char *visibility, bo_uint64 *string_length) |
Returns the visibility of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetEventID (BGAPI2_Node *node, bo_int64 *event_id) |
Returns the event identifier of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetImplemented (BGAPI2_Node *node, bo_bool *is_implemented) |
Returns the implemented state of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetAvailable (BGAPI2_Node *node, bo_bool *is_available) |
Returns the availability state of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetLocked (BGAPI2_Node *node, bo_bool *is_locked) |
Returns the locked state of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetImposedAccessMode (BGAPI2_Node *node, char *imposed_access_mode, bo_uint64 *string_length) |
Returns the imposed access mode of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetCurrentAccessMode (BGAPI2_Node *node, char *current_access_mode, bo_uint64 *string_length) |
Returns the current access mode of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_IsReadable (BGAPI2_Node *node, bo_bool *is_readable) |
Returns the readability state of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_IsWriteable (BGAPI2_Node *node, bo_bool *is_writable) |
Returns the writeability state of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetAlias (BGAPI2_Node *node, char *alias, bo_uint64 *string_length) |
Returns the alias name of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetValue (BGAPI2_Node *node, char *value, bo_uint64 *string_length) |
Returns the value of node as a string. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_SetValue (BGAPI2_Node *node, const char *value) |
Sets a string value to a node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetRepresentation (BGAPI2_Node *node, char *representation, bo_uint64 *string_length) |
Returns the representation of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetIntMin (BGAPI2_Node *node, bo_int64 *min) |
Returns the minimal integer value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetIntMax (BGAPI2_Node *node, bo_int64 *max) |
Returns the maximum integer value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetIntInc (BGAPI2_Node *node, bo_int64 *inc) |
Returns the integer increment value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetInt (BGAPI2_Node *node, bo_int64 *value) |
Returns the integer value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_SetInt (BGAPI2_Node *node, bo_int64 value) |
Sets the integer value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_HasUnit (BGAPI2_Node *node, bo_bool *has_unit) |
Returns the availability of a unit for the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetUnit (BGAPI2_Node *node, char *unit, bo_uint64 *string_length) |
Returns the unit of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDoubleMin (BGAPI2_Node *node, bo_double *min) |
Returns the minimal double value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDoubleMax (BGAPI2_Node *node, bo_double *max) |
Returns the maximum double value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDoubleInc (BGAPI2_Node *node, bo_double *inc) |
Returns the double increment value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_HasInc (BGAPI2_Node *node, bo_bool *has_inc) |
Returns the availability of an increment value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDoublePrecision (BGAPI2_Node *node, bo_uint64 *prec) |
Returns the double precision value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetDouble (BGAPI2_Node *node, bo_double *value) |
Returns the double value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_SetDouble (BGAPI2_Node *node, bo_double value) |
Sets the double value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetMaxStringLength (BGAPI2_Node *node, bo_int64 *max_string_length) |
Returns the maximum string length value of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetString (BGAPI2_Node *node, char *value, bo_uint64 *string_length) |
Returns the string value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_SetString (BGAPI2_Node *node, const char *value) |
Sets the string value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetEnumNodeList (BGAPI2_Node *node, BGAPI2_NodeMap **enum_node_map) |
Gets the enumeration node map of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_Execute (BGAPI2_Node *node) |
Executes the selected node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_IsDone (BGAPI2_Node *node, bo_bool *is_done) |
Checks if the execution of node is done. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetBool (BGAPI2_Node *node, bo_bool *value) |
Returns the boolean value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_SetBool (BGAPI2_Node *node, bo_bool value) |
Sets the boolean value of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetNodeTree (BGAPI2_Node *node, BGAPI2_NodeMap **node_tree) |
Gets the node tree of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetNodeList (BGAPI2_Node *node, BGAPI2_NodeMap **node_list) |
Gets the node list of the node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_IsSelector (BGAPI2_Node *node, bo_bool *is_selector) |
Checks if the node is an selector. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetSelectedFeatures (BGAPI2_Node *node, BGAPI2_NodeMap **selected_features) |
Returns the selected features of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetLength (BGAPI2_Node *node, bo_int64 *length) |
Returns the (data) length of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_GetAddress (BGAPI2_Node *node, bo_int64 *address) |
Returns the (data) address of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_Get (BGAPI2_Node *node, void *buffer, bo_int64 length) |
Returns the data of node. More... | |
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL | BGAPI2_Node_Set (BGAPI2_Node *node, void *buffer, bo_int64 length) |
Sets the data of node. More... | |
Detailed Description
Functions related to the GenICam Node or Feature.
Typedef Documentation
◆ BGAPI2_Node
typedef struct BGAPI2_Node BGAPI2_Node |
Struct for pointers of type Node.
Function Documentation
◆ BGAPI2_Node_GetInterface()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetInterface | ( | BGAPI2_Node * | node, |
char * | iface, | ||
bo_uint64 * | string_length | ||
) |
Returns the data type (interface) of the node.
The BGAPI2 C-Interface utilizes a two step process for the retrieval of strings.
1. Get the size of the string: For the first call to BGAPI2_Node_GetInterface, you need to supply the function with an null-pointer for the parameter interface. In this case the function will return you the size of the interface. You can now use this size to set up the pointer with the right size.
2. Get the actual interface string: Now you can supply the function with the right sized pointer you created for the interface. In that case, the function will return the interface into your provided memory pointer.
Alternatively, to save the extra call to get the size, you can supply the function with a larger memory pointer than required (e.g. 1024 byte).
- Parameters
-
[in] node Pointer to the node [in,out] iface Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No interface name on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetExtension()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetExtension | ( | BGAPI2_Node * | node, |
char * | extension, | ||
bo_uint64 * | string_length | ||
) |
Returns the extension (vendor specific information) of node.
- Parameters
-
[in] node Pointer to the node [in,out] extension Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetToolTip()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetToolTip | ( | BGAPI2_Node * | node, |
char * | tool_tip, | ||
bo_uint64 * | string_length | ||
) |
Returns the tooltip of node.
- Parameters
-
[in] node Pointer to the node [in,out] tool_tip Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetDescription()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDescription | ( | BGAPI2_Node * | node, |
char * | description, | ||
bo_uint64 * | string_length | ||
) |
Returns the description of node.
- Parameters
-
[in] node Pointer to the node [in,out] description Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetName()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetName | ( | BGAPI2_Node * | node, |
char * | name, | ||
bo_uint64 * | string_length | ||
) |
Returns the name of node.
- Parameters
-
[in] node Pointer to the node [in,out] name Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetDisplayname()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDisplayname | ( | BGAPI2_Node * | node, |
char * | display_name, | ||
bo_uint64 * | string_length | ||
) |
Returns the "user friendly" display name of node.
- Parameters
-
[in] node Pointer to the node [in,out] display_name Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetVisibility()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetVisibility | ( | BGAPI2_Node * | node, |
char * | visibility, | ||
bo_uint64 * | string_length | ||
) |
Returns the visibility of node.
- Parameters
-
[in] node Pointer to the node [in,out] visibility Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetEventID()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetEventID | ( | BGAPI2_Node * | node, |
bo_int64 * | event_id | ||
) |
Returns the event identifier of node.
- Parameters
-
[in] node Pointer to the node [out] event_id Pointer to store the event identifier
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetImplemented()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetImplemented | ( | BGAPI2_Node * | node, |
bo_bool * | is_implemented | ||
) |
Returns the implemented state of node.
- Parameters
-
[in] node Pointer to the node [out] is_implemented Pointer to store the implemented state of node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetAvailable()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetAvailable | ( | BGAPI2_Node * | node, |
bo_bool * | is_available | ||
) |
Returns the availability state of node.
- Parameters
-
[in] node Pointer to the node [out] is_available Pointer to store the availability state of node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetLocked()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetLocked | ( | BGAPI2_Node * | node, |
bo_bool * | is_locked | ||
) |
Returns the locked state of node.
- Parameters
-
[in] node Pointer to the node [out] is_locked Pointer to store the locked state of node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetImposedAccessMode()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetImposedAccessMode | ( | BGAPI2_Node * | node, |
char * | imposed_access_mode, | ||
bo_uint64 * | string_length | ||
) |
Returns the imposed access mode of node.
- Parameters
-
[in] node Pointer to the node [in,out] imposed_access_mode Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetCurrentAccessMode()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetCurrentAccessMode | ( | BGAPI2_Node * | node, |
char * | current_access_mode, | ||
bo_uint64 * | string_length | ||
) |
Returns the current access mode of node.
- Parameters
-
[in] node Pointer to the node [in,out] current_access_mode Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_IsReadable()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsReadable | ( | BGAPI2_Node * | node, |
bo_bool * | is_readable | ||
) |
Returns the readability state of node.
- Parameters
-
[in] node Pointer to the node [out] is_readable Pointer to store the readability state of node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_IsWriteable()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsWriteable | ( | BGAPI2_Node * | node, |
bo_bool * | is_writable | ||
) |
Returns the writeability state of node.
- Parameters
-
[in] node Pointer to the node [out] is_writable Pointer to store the writeability state of node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetAlias()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetAlias | ( | BGAPI2_Node * | node, |
char * | alias, | ||
bo_uint64 * | string_length | ||
) |
Returns the alias name of node.
- Parameters
-
[in] node Pointer to the node [in,out] alias Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetValue()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetValue | ( | BGAPI2_Node * | node, |
char * | value, | ||
bo_uint64 * | string_length | ||
) |
Returns the value of node as a string.
- Parameters
-
[in] node Pointer to the node [in,out] value Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_SetValue()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetValue | ( | BGAPI2_Node * | node, |
const char * | value | ||
) |
Sets a string value to a node.
- Parameters
-
[in] node Pointer to the node [in] value Pointer to the value to be written
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetRepresentation()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetRepresentation | ( | BGAPI2_Node * | node, |
char * | representation, | ||
bo_uint64 * | string_length | ||
) |
Returns the representation of the node.
- Parameters
-
[in] node Pointer to the node [in,out] representation Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No extension on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetIntMin()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetIntMin | ( | BGAPI2_Node * | node, |
bo_int64 * | min | ||
) |
Returns the minimal integer value of node.
- Parameters
-
[in] node Pointer to the node [out] min Pointer to store the minimal integer value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetIntMax()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetIntMax | ( | BGAPI2_Node * | node, |
bo_int64 * | max | ||
) |
Returns the maximum integer value of node.
- Parameters
-
[in] node Pointer to the node [out] max Pointer to store the maximum integer value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetIntInc()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetIntInc | ( | BGAPI2_Node * | node, |
bo_int64 * | inc | ||
) |
Returns the integer increment value of node.
- Parameters
-
[in] node Pointer to the node [out] inc Pointer to store the integer increment value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetInt()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetInt | ( | BGAPI2_Node * | node, |
bo_int64 * | value | ||
) |
Returns the integer value of the node.
- Parameters
-
[in] node Pointer to the node [out] value Pointer to store the integer value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_SetInt()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetInt | ( | BGAPI2_Node * | node, |
bo_int64 | value | ||
) |
Sets the integer value of node.
- Parameters
-
[in] node Pointer to the node [in] value Integer value for node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_HasUnit()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_HasUnit | ( | BGAPI2_Node * | node, |
bo_bool * | has_unit | ||
) |
Returns the availability of a unit for the node.
- Parameters
-
[in] node Pointer to the node [out] has_unit Pointer to store the availability of a unit for the node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetUnit()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetUnit | ( | BGAPI2_Node * | node, |
char * | unit, | ||
bo_uint64 * | string_length | ||
) |
Returns the unit of the node.
- Parameters
-
[in] node Pointer to the node [in,out] unit Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No unit name on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_GetDoubleMin()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoubleMin | ( | BGAPI2_Node * | node, |
bo_double * | min | ||
) |
Returns the minimal double value of the node.
- Parameters
-
[in] node Pointer to the node [out] min Pointer to store the minimal double value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetDoubleMax()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoubleMax | ( | BGAPI2_Node * | node, |
bo_double * | max | ||
) |
Returns the maximum double value of the node.
- Parameters
-
[in] node Pointer to the node [out] max Pointer to store the maximum double value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetDoubleInc()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoubleInc | ( | BGAPI2_Node * | node, |
bo_double * | inc | ||
) |
Returns the double increment value of the node.
- Parameters
-
[in] node Pointer to the node [out] inc Pointer to store the double increment value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_HasInc
◆ BGAPI2_Node_HasInc()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_HasInc | ( | BGAPI2_Node * | node, |
bo_bool * | has_inc | ||
) |
Returns the availability of an increment value of the node.
- Parameters
-
[in] node Pointer to the node [out] has_inc Pointer to store the availability of increment value unit
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetDoublePrecision()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDoublePrecision | ( | BGAPI2_Node * | node, |
bo_uint64 * | prec | ||
) |
Returns the double precision value of node.
- Parameters
-
[in] node Pointer to the node [out] prec Pointer to store the double precision value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetDouble()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetDouble | ( | BGAPI2_Node * | node, |
bo_double * | value | ||
) |
Returns the double value of node.
- Parameters
-
[in] node Pointer to the node [out] value Pointer to store the double value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_SetDouble()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetDouble | ( | BGAPI2_Node * | node, |
bo_double | value | ||
) |
Sets the double value of node.
- Parameters
-
[in] node Pointer to the node [in] value New double value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetMaxStringLength()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetMaxStringLength | ( | BGAPI2_Node * | node, |
bo_int64 * | max_string_length | ||
) |
Returns the maximum string length value of node.
- Parameters
-
[in] node Pointer to the node [out] max_string_length Pointer to store the maximum string length value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetString()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetString | ( | BGAPI2_Node * | node, |
char * | value, | ||
bo_uint64 * | string_length | ||
) |
Returns the string value of the node.
- Parameters
-
[in] node Pointer to the node [in,out] value Nullptr to get string length or pointer to store result [in,out] string_length Result size, length of version string (including string end zero)
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_NOT_IMPLEMENTED No string on node BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
- See also
- BGAPI2_Node_GetInterface for detail how to retrieve strings with unknown size
◆ BGAPI2_Node_SetString()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetString | ( | BGAPI2_Node * | node, |
const char * | value | ||
) |
Sets the string value of the node.
- Parameters
-
[in] node Pointer to the node [in] value String value to set
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (access denied, invalid parameter, ..) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetEnumNodeList()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetEnumNodeList | ( | BGAPI2_Node * | node, |
BGAPI2_NodeMap ** | enum_node_map | ||
) |
Gets the enumeration node map of the node.
- Parameters
-
[in] node Pointer to the node [out] enum_node_map Pointer to store the enumeration node map
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_Execute()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_Execute | ( | BGAPI2_Node * | node | ) |
Executes the selected node.
- Parameters
-
[in] node Pointer to the node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_IsDone()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsDone | ( | BGAPI2_Node * | node, |
bo_bool * | is_done | ||
) |
Checks if the execution of node is done.
- Parameters
-
[in] node Pointer to the node [out] is_done Pointer to store the execution done
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetBool()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetBool | ( | BGAPI2_Node * | node, |
bo_bool * | value | ||
) |
Returns the boolean value of the node.
- Parameters
-
[in] node Pointer to the node [out] value Pointer to store the boolean value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_SetBool()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_SetBool | ( | BGAPI2_Node * | node, |
bo_bool | value | ||
) |
Sets the boolean value of the node.
- Parameters
-
[in] node Pointer to the node [in] value A boolean value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetNodeTree()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetNodeTree | ( | BGAPI2_Node * | node, |
BGAPI2_NodeMap ** | node_tree | ||
) |
Gets the node tree of the node.
- Parameters
-
[in] node Pointer to the node [out] node_tree Pointer to store the node tree
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetNodeList()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetNodeList | ( | BGAPI2_Node * | node, |
BGAPI2_NodeMap ** | node_list | ||
) |
Gets the node list of the node.
- Parameters
-
[in] node Pointer to the node [out] node_list Pointer to store the node list with node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Error for missing root node BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_IsSelector()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_IsSelector | ( | BGAPI2_Node * | node, |
bo_bool * | is_selector | ||
) |
Checks if the node is an selector.
- Parameters
-
[in] node Pointer to the node [out] is_selector Pointer to store the is_selector value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetSelectedFeatures()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetSelectedFeatures | ( | BGAPI2_Node * | node, |
BGAPI2_NodeMap ** | selected_features | ||
) |
Returns the selected features of node.
- Parameters
-
[in] node Pointer to the node [out] selected_features Pointer to store the selected features
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetLength()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetLength | ( | BGAPI2_Node * | node, |
bo_int64 * | length | ||
) |
Returns the (data) length of node.
- Parameters
-
[in] node Pointer to the node [out] length Pointer to store the (data) length value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_GetAddress()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_GetAddress | ( | BGAPI2_Node * | node, |
bo_int64 * | address | ||
) |
Returns the (data) address of node.
- Parameters
-
[in] node Pointer to the node [out] address Pointer to store the (data) address value
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_Get()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_Get | ( | BGAPI2_Node * | node, |
void * | buffer, | ||
bo_int64 | length | ||
) |
Returns the data of node.
- Parameters
-
[in] node Pointer to the node [out] buffer Pointer to store the data [in] length Length of the data
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters
◆ BGAPI2_Node_Set()
BGAPI2_C_DECL BGAPI2_RESULT BGAPI2CALL BGAPI2_Node_Set | ( | BGAPI2_Node * | node, |
void * | buffer, | ||
bo_int64 | length | ||
) |
Sets the data of node.
- Parameters
-
[in] node Pointer to the node [in] buffer Variable with data [in] length Data length of node
- Return values
-
BGAPI2_RESULT_SUCCESS No error BGAPI2_RESULT_ERROR Internal error (no nodemap found) BGAPI2_RESULT_INVALID_PARAMETER Error for invalid parameters