Ucs_Return_t Ucs_Xrm_Stream_GetPortConfig	(	Ucs_Inst_t *	self,
		uint16_t	node_address,
		uint8_t	index,
		Ucs_Xrm_Stream_PortCfgResCb_t	result_fptr
	)

This function requests the configurations of a Streaming Port.

This function corresponds with the INIC function INIC.StreamPortConfiguration.

Parameters

self	The UNICENS instance pointer
node_address	Device address of the target. 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
index	Streaming Port instance.   Index
result_fptr	Required result callback

Returns

Possible return values are shown in the table below.

Value	Description
UCS_RET_SUCCESS	No error
UCS_RET_ERR_PARAM	At least one parameter is wrong.
UCS_RET_ERR_BUFFER_OVERFLOW	No message buffer is available.
UCS_RET_ERR_API_LOCKED	API is currently 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 section Ucs_Xrm_Stream_GetPortConfig for an example implementation.