Logo
UNICENS V2.3.0-4567
User Manual and API Reference
Ucs_Return_t Ucs_Network_SetPacketFilterMode ( Ucs_Inst_t self,
uint16_t  node_address,
uint16_t  mode,
Ucs_StdNodeResultCb_t  result_fptr 
)

Sets the packet filter mode of an available node.

 This function corresponds with the INIC function INIC.NetworkConfiguration.
Parameters
selfThe instance
node_addressThe destination address of the node. Use the UCS_ADDR_LOCAL_NODE macro to target the local device.
The following address ranges are supported:
  • [0x10 ... 0x2FF]
  • [0x500 ... 0xFEF]
  • UCS_ADDR_LOCAL_NODE
modeThe new packet filter mode.
 PacketFilterMode
result_fptrResult callback.
Returns
Possible return values are shown in the table below.
Value Description
UCS_RET_SUCCESS No error
UCS_RET_ERR_PARAM The parameter self is NULL or result callback is not provided.
UCS_RET_ERR_NOT_SUPPORTED API is not supported in the current Network Supervisor Mode.
UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized.
UCS_RET_ERR_BUFFER_OVERFLOW No message buffer available.
UCS_RET_ERR_API_LOCKED API is currently locked.
UCS_RET_ERR_INVALID_SHADOW Missing internal proxy for this node.
See Also
Ucs_Ns_SynchronizeNode()