TIM SDK
TIM API C
network_information.h File Reference

Description

Contains network information of the terminal.

Object type network_information.

Result of calling ta_terminal_system_information() or ta_terminal_system_information_async().

Functions

ta_e_result_code_t ta_network_information_get_terminal_ip (ta_object_t network_info, ta_object_t *terminal_ip)
 Terminal IP. More...
 
ta_e_result_code_t ta_network_information_get_terminal_ip_mask (ta_object_t network_info, ta_object_t *terminal_ip_mask)
 Terminal IP network mask. More...
 
ta_e_result_code_t ta_network_information_get_terminal_ip_gw (ta_object_t network_info, ta_object_t *terminal_ip_gw)
 Terminal IP gateway. More...
 
ta_e_result_code_t ta_network_information_get_terminal_ip_dns (ta_object_t network_info, ta_object_t *terminal_ip_dns)
 Terminal IP dns host name. More...
 

Function Documentation

◆ ta_network_information_get_terminal_ip()

ta_e_result_code_t ta_network_information_get_terminal_ip ( ta_object_t  network_info,
ta_object_t terminal_ip 
)

Terminal IP.

Parameters
[in]network_infoObject instance of type network_information.
[out]terminal_ipPointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to terminal_ip.
ta_c_rc_invalid_argumentnetwork_info is ta_invalid_object.
ta_c_rc_invalid_argumentnetwork_info is not of type network_information.
ta_c_rc_invalid_argumentterminal_ip is null-pointer.

◆ ta_network_information_get_terminal_ip_dns()

ta_e_result_code_t ta_network_information_get_terminal_ip_dns ( ta_object_t  network_info,
ta_object_t terminal_ip_dns 
)

Terminal IP dns host name.

Parameters
[in]network_infoObject instance of type network_information.
[out]terminal_ip_dnsPointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to terminal_ip_dns.
ta_c_rc_invalid_argumentnetwork_info is ta_invalid_object.
ta_c_rc_invalid_argumentnetwork_info is not of type network_information.
ta_c_rc_invalid_argumentterminal_ip_dns is null-pointer.

◆ ta_network_information_get_terminal_ip_gw()

ta_e_result_code_t ta_network_information_get_terminal_ip_gw ( ta_object_t  network_info,
ta_object_t terminal_ip_gw 
)

Terminal IP gateway.

Parameters
[in]network_infoObject instance of type network_information.
[out]terminal_ip_gwPointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to terminal_ip_gw.
ta_c_rc_invalid_argumentnetwork_info is ta_invalid_object.
ta_c_rc_invalid_argumentnetwork_info is not of type network_information.
ta_c_rc_invalid_argumentterminal_ip_gw is null-pointer.

◆ ta_network_information_get_terminal_ip_mask()

ta_e_result_code_t ta_network_information_get_terminal_ip_mask ( ta_object_t  network_info,
ta_object_t terminal_ip_mask 
)

Terminal IP network mask.

Parameters
[in]network_infoObject instance of type network_information.
[out]terminal_ip_maskPointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to terminal_ip_mask.
ta_c_rc_invalid_argumentnetwork_info is ta_invalid_object.
ta_c_rc_invalid_argumentnetwork_info is not of type network_information.
ta_c_rc_invalid_argumentterminal_ip_mask is null-pointer.