tfDhcpUserSetOption
Table of Contents >> Optional Protocols >> DHCP User Configured
| #include <trsocket.h> |
| int tfDhcpUserSetOption | ( |
| ttUserInterface interfaceHandle, | |
| int index, | |
| ttUser8Bit bootOption, | |
| ttUserCharPtr dataPtr, | |
| ttUser8Bit dataLen | |
| ); |
Function Description
This function instructs the DHCP client to include the specified non-native option in outgoing DHCP packets.
Parameters
- interfaceHandle
- This is the interface handle
- Index
- This is the user index on which to set the specified option.
- bootOption
- This is the option to be set.
- dataPtr
- This is the buffer used to store the option data.
- dataLen
- This is the size of the dataPtr buffer.
Returns
- TM_EINVAL
- This indicates failure. The kernel found invalid arguments in the call.
- TM_ENOBUFS
- This indicates failure due to a failed memory allocation.
- TM_ENOERROR
- This indicates success.
Usage
This function is used for options not natively supported by the DHCP client. This must be called prior to calling tfDhcpUserStart(). When calling twice with the same option value, the new data replaces the old.
Table of Contents >> Optional Protocols >> DHCP User Configured