genapic/GenApiC32BitMethods.h#

GenApi C bindings - 32 bit functions.

Functions#

Functions Documentation#

function GenApiIntegerGetIncInt32#

GENAPIC_RESULT GenApiIntegerGetIncInt32(
    NODE_HANDLE hNode,
    int32_t * pValue
)

Get the value increment from an integer node.

Parameters:

• hNode Node to operate on
• pValue Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return the integer value increment of a node.

function GenApiIntegerGetMaxInt32#

GENAPIC_RESULT GenApiIntegerGetMaxInt32(
    NODE_HANDLE hNode,
    int32_t * pValue
)

Get the maximum value from an integer node.

Parameters:

• hNode Node to operate on
• pValue Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return the maximum integer value of a node.

function GenApiIntegerGetMinInt32#

GENAPIC_RESULT GenApiIntegerGetMinInt32(
    NODE_HANDLE hNode,
    int32_t * pValue
)

Get the minimum value from an integer node.

Parameters:

• hNode Node to operate on
• pValue Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return the minimum integer value of a node.

function GenApiIntegerGetValueExInt32#

GENAPIC_RESULT GenApiIntegerGetValueExInt32(
    NODE_HANDLE hNode,
    _Bool verify,
    int32_t * pValue
)

Return a node's integer value with optional validation.

Parameters:

• hNode Node to operate on
• verify Boolean switch to enable validation
• pValue Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return the integer value of a node. If verify equals true, the result value is checked to ensure that it does not violate any of the node's constraints.

function GenApiIntegerGetValueInt32#

GENAPIC_RESULT GenApiIntegerGetValueInt32(
    NODE_HANDLE hNode,
    int32_t * pValue
)

Get a node's integer value without validation.

Parameters:

• hNode Node to operate on
• pValue Result value pointer

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Return the integer value of a node. No validation is performed on the value returned.

function GenApiIntegerSetValueExInt32#

GENAPIC_RESULT GenApiIntegerSetValueExInt32(
    NODE_HANDLE hNode,
    _Bool verify,
    int32_t value
)

Set a node's integer value with optional validation.

Parameters:

• hNode Node to operate on
• verify Boolean switch to enable validation
• value Value to set

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Set the node to a particular value. If verify equals true, the function will fail if the value to be set conflicts with any relevant constraints.

function GenApiIntegerSetValueInt32#

GENAPIC_RESULT GenApiIntegerSetValueInt32(
    NODE_HANDLE hNode,
    int32_t value
)

Set a node's integer value with mandatory validation.

Parameters:

• hNode Node to operate on
• value Value to set

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Set the node to a particular value. The function will fail if the value to be set conflicts with any relevant constraints.

function GenApiNodeGetPollingTimeInt32#

GENAPIC_RESULT GenApiNodeGetPollingTimeInt32(
    NODE_HANDLE hNode,
    int32_t * pollingTime
)

Query a node for its recommended polling interval.

Parameters:

• hNode Node to operate on
• pPollingTime Pointer to variable receiving result

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Nodes that are subject to asynchronous state changes must be periodically queried (polled) in order to detect state changes. Such nodes have an associated attribute specifying a recommended polling interval in milliseconds. Use this function to get that value.

function GenApiNodeMapPollInt32#

GENAPIC_RESULT GenApiNodeMapPollInt32(
    NODEMAP_HANDLE hMap,
    int32_t timestamp
)

Poll all nodes in a node map.

Parameters:

• hMap Node map handle
• timestamp Current time stamp in ms

Return: If the function succeeds, the return value is GENAPI_E_OK.

If the function fails, the return value will be any of error codes described in the section ErrorCodes.

Poll all nodes in the node map and execute callbacks for those that are expired.