Logo
UNICENS V2.3.0-4567
User Manual and API Reference
Ucs_Return_t Ucs_Ns_Run ( Ucs_Inst_t self,
uint16_t  node_address,
UCS_NS_CONST Ucs_Ns_Script_t script_list_ptr,
uint8_t  script_list_size,
Ucs_Ns_ResultCb_t  result_fptr 
)

Runs a given script list on the given node.

Parameters
selfThe UNICENS instance.
node_addressThe node address of the node the script shall be executed on.
script_list_ptrReference to a node script list which should be executed.
script_list_sizeSize of the node script list.
result_fptrReference to the mandatory result function pointer.
Returns
Possible return values are shown in the table below.
Value Description
UCS_RET_SUCCESS No error
UCS_RET_ERR_NOT_AVAILABLE No internal resources allocated for the given node.
Check if value of UCS_NUM_REMOTE_DEVICES is less than
the current number of remote devices in network.
UCS_RET_ERR_PARAM At least one parameter is NULL.
UCS_RET_ERR_BUFFER_OVERFLOW No TxBuffer Handles available
UCS_RET_ERR_API_LOCKED The API is locked.
UCS_RET_ERR_NOT_SUPPORTED API is not supported in the current Network Supervisor Mode.
UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized.
 See also Getting Started, section Node Scripting for detailed information and implementation example.