tfDhcpUserGetOption

Table of Contents >> Optional Protocols >> DHCP User Configured

#include <trsocket.h>

int tfDhcpUserGetOption	(
	ttUserInterface interfaceHandle,
	int Index,
	ttUser8Bit bootOption,
	ttUserCharPtr dataPtr,
	ttUser8BitPtr dataLenPtr
	);

Function Description

This new function instructs the DHCP client to retrieve a non-native option sent by the DHCP server.

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 retrieved.

• dataPtr

  This is the buffer used to store the option data.

• dataLenPtr

  This is the maximum size of the dataPtr content. This will be modified upon return to specify the actual amount of the buffer used to store the data.

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_EMSGSIZE

  This indicates failure when the dataPtr is not large enough to hold the option data. dataLenPtr is subsequently modified to the required buffer size.

• TM_ENOENT

  This indicates failure when the specified option is not found.

• TM_ENOERROR

  This indicates success.

Usage

This function is used for options not natively supported by the DHCP client. Any unrecognized option sent by the DHCP server can be accessed with this API. This function is for use with the DHCP User Controlled Configuration API.

Table of Contents >> Optional Protocols >> DHCP User Configured