tfInterfaceGetOptions

Jump to: navigation, search

Table of Contents >> Programmer's Reference


#include <trsocket.h>


int tfInterfaceGetOptions (
ttUserInterface interfaceHandle,
int optionName,
void TM_FAR * optionValuePtr,
int optionLength
);


Function Description

Get the value of various interface options. 'optionValuePtr' points to a variable of type as described below. 'optionLength' contains the size of that variable.


Possible Options

TM_DEV_OPTIONS_FORWARDING The current forwarding state on the specified interface. Set to 1 if forwarding is enabled on the interface, 0 if it is not.

Data type: unsigned char.

TM_DEV_OPTIONS_IP_PROMISCUOUS Enable or disable IP-level promiscuous mode on the device.

Data Type: unsigned short

TM_DEV_OPTIONS_NO_IGMPV2_RA Accept or drop IGMPv2 queries that do not carry the router alert option. Only valid when TM_USE_IGMPV3 is defined.

Data Type: unsigned short


Parameters

  • interfaceHandle
    The interface handle of the interface to set the option on.
  • optionName
    The option to get. (See above.)
  • optionValuePtr
    The pointer to a user variable into which the option value is stored. User variable is of data type described above.
  • optionLength
    The size of the user variable, which is the size of the option data type.


Returns

  • TM_ENOERROR
    Success.
  • TM_EINVAL
    Invalid 'optionName'; invalid 'optionLength'; or invalid 'optionValue' for the option.


Table of Contents >> Programmer's Reference