Ucs_Return_t Ucs_Rm_GetAtdValue	(	Ucs_Inst_t *	self,
		Ucs_Rm_Route_t *	route_ptr,
		uint16_t *	atd_value_ptr
	)

This function retrieves the ATD value of the given route reference.

Note

Links the given ATD value pointer to the ATD value of the route instance.

Parameters

self	Reference to UCS instance.
route_ptr	Reference of the route.
atd_value_ptr	Given pointer which is linked to the ATD value.

Returns

Possible return values are shown in the table below.

Value	Description
UCS_RET_SUCCESS	No error
UCS_RET_ERR_NOT_AVAILABLE	ATD was not enabled for the desired route.
UCS_RET_ERR_PARAM	ATD value is not up-to-date or the parameter self is NULL.
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 Processing Example for an example implementation.