Ucs_Return_t Ucs_Rm_GetAttachedRoutes | ( | Ucs_Inst_t * | self, |
Ucs_Rm_EndPoint_t * | ep_inst, | ||
Ucs_Rm_Route_t * | ls_found_routes[], | ||
uint16_t | ls_size | ||
) |
Retrieves the reference(s) of the route(s) currently attached to the given endpoint and stores It into the (external) table provided by user application.
Thus, User application should provide an external reference to an empty routes table where the potential routes will be stored. That is, user application is responsible to allocate enough space to store the found routes. Refer to the Note below for more details.
self | The UNICENS instance pointer. |
ep_inst | Reference to the endpoint instance to be looked for. |
ls_found_routes | List to store references to the found routes. It should be allocated by user application. |
ls_size | Size of the provided list. |
Value | Description |
---|---|
UCS_RET_SUCCESS | No error |
UCS_RET_ERR_PARAM | At least one parameter is NULL. |
UCS_RET_ERR_NOT_INITIALIZED | UNICENS is not initialized |
Example