| Ucs_Return_t Ucs_Xrm_Stream_GetPortConfig | ( | Ucs_Inst_t * | self, |
| uint16_t | destination_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. |
| self | The UNICENS instance pointer | ||
| destination_address | Device address of the target. Use the UCS_ADDR_LOCAL_DEV macro to target the local device. The following address ranges are supported:
| ||
| index | Streaming Port instance.
| ||
| result_fptr | Required result callback |
| 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 available |
| UCS_RET_ERR_API_LOCKED | API is currently locked |
| UCS_RET_ERR_NOT_INITIALIZED | UNICENS is not initialized |
Example