tf6GetDefaultGateway
Table of Contents >> IPv6 Programmer's Reference
| #include <trsocket.h> |
| int tf6GetDefaultGateway | ( |
| ttUserInterface interfaceHandle | |
| ); | |
| Conditional parameter. See details in Parameters below. | |
Function Description
This function only supports IPv6. This function is used to get the active IPv6 default gateway.
Parameters
- interfaceHandle
- Interface ID as returned by tfAddInterface(). NOTE: This parameter is conditional and only present when TM_USE_STRONG_ESL is defined at compile time. For more information, please see Appendix C: Strong End System Model / Weak End System Model.
- gwyIPAddrPtr
- This is the default gateway's IPv6 address. This memory is used to hold this information and must be allocated by the caller (i.e. reside in the caller's address space).
Returns
- TM_ENOERROR
- Success.
- TM_EINVAL
- This indicates failure. Invalid arguments were found in the call.
- TM_ENOENT
- No default IPv6 gateway address was found.
