Difference between revisions of "Unit IPHlpAPI"

Revision as of 05:13, 9 December 2021

`MAX_INTERFACE_NAME_LEN = 256;`
`IPRTRMGR_PID = 10000;`
`ANY_SIZE = 1;`

`MAX_ADAPTER_NAME = 128;`

`MAX_ADAPTER_DESCRIPTION_LENGTH = 128;`
`MAX_ADAPTER_NAME_LENGTH = 256;`
`MAX_ADAPTER_ADDRESS_LENGTH = 8;`
`DEFAULT_MINIMUM_ENTITIES = 32;`
`MAX_HOSTNAME_LEN = 128;`
`MAX_DOMAIN_NAME_LEN = 128;`
`MAX_SCOPE_ID_LEN = 256;`

`MAXLEN_IFDESCR = 256;`
`MAXLEN_PHYSADDR = 8;`

MIB operation status MIB_IF_OPER_STATUS_*

`MIB_IF_OPER_STATUS_NON_OPERATIONAL = 0;`
`MIB_IF_OPER_STATUS_UNREACHABLE = 1;`
`MIB_IF_OPER_STATUS_DISCONNECTED = 2;`
`MIB_IF_OPER_STATUS_CONNECTING = 3;`
`MIB_IF_OPER_STATUS_CONNECTED = 4;`
`MIB_IF_OPER_STATUS_OPERATIONAL = 5;`

MIB type MIB_IF_TYPE_*

`MIB_IF_TYPE_OTHER = 1;`
`MIB_IF_TYPE_ETHERNET = 6;`
`MIB_IF_TYPE_TOKENRING = 9;`
`MIB_IF_TYPE_FDDI = 15;`
`MIB_IF_TYPE_PPP = 23;`
`MIB_IF_TYPE_LOOPBACK = 24;`
`MIB_IF_TYPE_SLIP = 28;`
`MIB_IF_TYPE_IEEE80211 = 71;`

`IF_TYPE_OTHER = MIB_IF_TYPE_OTHER;`
`IF_TYPE_ETHERNET_CSMACD = MIB_IF_TYPE_ETHERNET;`
`IF_TYPE_ISO88025_TOKENRING = MIB_IF_TYPE_TOKENRING;`
`IF_TYPE_FDDI = MIB_IF_TYPE_FDDI;`
`IF_TYPE_PPP = MIB_IF_TYPE_PPP;`
`IF_TYPE_SOFTWARE_LOOPBACK = MIB_IF_TYPE_LOOPBACK;`
`IF_TYPE_ATM = MIB_IF_TYPE_SLIP;`
`IF_TYPE_IEEE80211 = MIB_IF_TYPE_IEEE80211;`
`IF_TYPE_TUNNEL = 131;`
`IF_TYPE_IEEE1394 = 144;`
`IF_TYPE_IEEE80216_WMAN = 237;`
`IF_TYPE_WWANPP = 243;`
`IF_TYPE_WWANPP2 = 244;`

MIB admin status MIB_IF_ADMIN_STATUS_*

`MIB_IF_ADMIN_STATUS_UP = 1;`
`MIB_IF_ADMIN_STATUS_DOWN = 2;`
`MIB_IF_ADMIN_STATUS_TESTING = 3;`

MIB TCP MIB_TCP_*

`MIB_TCP_RTO_OTHER = 1;`
`MIB_TCP_RTO_CONSTANT = 2;`
`MIB_TCP_RTO_RSRE = 3;`
`MIB_TCP_RTO_VANJ = 4;`
`MIB_TCP_MAXCONN_DYNAMIC = DWORD(-1);`

MIB TCP state MIB_TCP_STATE_*

`MIB_TCP_STATE_CLOSED = 1;`
`MIB_TCP_STATE_LISTEN = 2;`
`MIB_TCP_STATE_SYN_SENT = 3;`
`MIB_TCP_STATE_SYN_RCVD = 4;`
`MIB_TCP_STATE_ESTAB = 5;`
`MIB_TCP_STATE_FIN_WAIT1 = 6;`
`MIB_TCP_STATE_FIN_WAIT2 = 7;`
`MIB_TCP_STATE_CLOSE_WAIT = 8;`
`MIB_TCP_STATE_CLOSING = 9;`
`MIB_TCP_STATE_LAST_ACK = 10;`
`MIB_TCP_STATE_TIME_WAIT = 11;`
`MIB_TCP_STATE_DELETE_TCB = 12;`

MIB current MIB_USE_CURRENT_*

`MIB_USE_CURRENT_TTL = DWORD(-1);`
`MIB_USE_CURRENT_FORWARDING = DWORD(-1);`

MIB IP MIB_IP_*

`MIB_IP_FORWARDING = 1;`
`MIB_IP_NOT_FORWARDING = 2;`

MIB IP route type MIB_IPROUTE_*

`MIB_IPROUTE_TYPE_OTHER = 1;`
`MIB_IPROUTE_TYPE_INVALID = 2;`
`MIB_IPROUTE_TYPE_DIRECT = 3;`
`MIB_IPROUTE_TYPE_INDIRECT = 4;`
`MIB_IPROUTE_METRIC_UNUSED = DWORD(-1);`

MIB IP protocol MIB_IPPROTO_*

`MIB_IPPROTO_OTHER = 1;`
`MIB_IPPROTO_LOCAL = 2;`
`MIB_IPPROTO_NETMGMT = 3;`
`MIB_IPPROTO_ICMP = 4;`
`MIB_IPPROTO_EGP = 5;`
`MIB_IPPROTO_GGP = 6;`
`MIB_IPPROTO_HELLO = 7;`
`MIB_IPPROTO_RIP = 8;`
`MIB_IPPROTO_IS_IS = 9;`
`MIB_IPPROTO_ES_IS = 10;`
`MIB_IPPROTO_CISCO = 11;`
`MIB_IPPROTO_BBN = 12;`
`MIB_IPPROTO_OSPF = 13;`
`MIB_IPPROTO_BGP = 14;`
`MIB_IPPROTO_NT_AUTOSTATIC = 10002;`
`MIB_IPPROTO_NT_STATIC = 10006;`
`MIB_IPPROTO_NT_STATIC_NON_DOD = 10007;`

MIB IP network type MIB_IPNET_*

`MIB_IPNET_TYPE_OTHER = 1;`
`MIB_IPNET_TYPE_INVALID = 2;`
`MIB_IPNET_TYPE_DYNAMIC = 3;`
`MIB_IPNET_TYPE_STATIC = 4;`

Type definitions

IP address

`IPAddr = Cardinal;`	An IP address

IP mask

`IPMask = Cardinal;`	An IP netmask

IP status

`IP_STATUS = Cardinal;`	Status code returned from IP APIs

MIB if number

TMibIfnumber = MIB_IFNUMBER;

PMibIfnumber = PMIB_IFNUMBER;

PMIB_IFNUMBER = ^MIB_IFNUMBER;

MIB_IFNUMBER = record

`dwValue: DWORD;`

MIB if row

TMibIfRow = MIB_IFROW;

PMibIfRow = PMIB_IFROW;

PMIB_IFROW = ^MIB_IFROW;

MIB_IFROW = record

`wszName: array [0..MAX_INTERFACE_NAME_LEN - 1] of WideChar;`
`dwIndex: DWORD;`
`dwType: DWORD;`
`dwMtu: DWORD;`
`dwSpeed: DWORD;`
`dwPhysAddrLen: DWORD;`
`bPhysAddr: array [0..MAXLEN_PHYSADDR - 1] of Byte;`
`dwAdminStatus: DWORD;`
`dwOperStatus: DWORD;`
`dwLastChange: DWORD;`
`dwInOctets: DWORD;`
`dwInUcastPkts: DWORD;`
`dwInNUcastPkts: DWORD;`
`dwInDiscards: DWORD;`
`dwInErrors: DWORD;`
`dwInUnknownProtos: DWORD;`
`dwOutOctets: DWORD;`
`dwOutUcastPkts: DWORD;`
`dwOutNUcastPkts: DWORD;`
`dwOutDiscards: DWORD;`
`dwOutErrors: DWORD;`
`dwOutQLen: DWORD;`
`dwDescrLen: DWORD;`
`bDescr: array[0..MAXLEN_IFDESCR - 1] of Byte;`

MIB if table

TMibIftable = MIB_IFTABLE;

PMibIftable = PMIB_IFTABLE;

PMIB_IFTABLE = ^MIB_IFTABLE;

MIB_IFTABLE = record

`dwNumEntries: DWORD;`
`table: array [0..ANY_SIZE - 1] of MIB_IFROW;`

MIB ICMP statistics

TMibIcmpStats = MIBICMPSTATS;

PMibIcmpStats = ^TMibIcmpStats;

MIBICMPSTATS = record

`dwMsgs: DWORD;`
`dwErrors: DWORD;`
`dwDestUnreachs: DWORD;`
`dwTimeExcds: DWORD;`
`dwParmProbs: DWORD;`
`dwSrcQuenchs: DWORD;`
`dwRedirects: DWORD;`
`dwEchos: DWORD;`
`dwEchoReps: DWORD;`
`dwTimestamps: DWORD;`
`dwTimestampReps: DWORD;`
`dwAddrMasks: DWORD;`
`dwAddrMaskReps: DWORD;`

MIB ICMP information

TMibIcmpInfo = MIBICMPINFO;

PMibIcmpInfo = ^TMibIcmpInfo;

MIBICMPINFO = record

`icmpInStats: MIBICMPSTATS;`
`icmpOutStats: MIBICMPSTATS;`

MIB ICMP

TMibIcmp = MIB_ICMP;

PMibIcmp = PMIB_ICMP;

PMIB_ICMP = ^MIB_ICMP;

MIB_ICMP = record

`stats: MIBICMPINFO;`

MIB UDP statistics

TMibUdpStats = MIB_UDPSTATS;

PMibUdpStats = PMIB_UDPSTATS;

PMIB_UDPSTATS = ^MIB_UDPSTATS;

MIB_UDPSTATS = record

`dwInDatagrams: DWORD;`
`dwNoPorts: DWORD;`
`dwInErrors: DWORD;`
`dwOutDatagrams: DWORD;`
`dwNumAddrs: DWORD;`

MIB UDP row

TMibUdpRow = MIB_UDPROW;

PMibUdpRow = PMIB_UDPROW;

PMIB_UDPROW = ^MIB_UDPROW;

MIB_UDPROW = record

`dwLocalAddr: DWORD;`
`dwLocalPort: DWORD;`

MIB UDP table

TMibUdpTable = MIB_UDPTABLE;

PMibUdpTable = PMIB_UDPTABLE;

PMIB_UDPTABLE = ^MIB_UDPTABLE;

MIB_UDPTABLE = record

`dwNumEntries: DWORD;`
`table: array [0..ANY_SIZE - 1] of MIB_UDPROW;`

MIB TCP statistics

TMibTcpStats = MIB_TCPSTATS;

PMibTcpStats = PMIB_TCPSTATS;

PMIB_TCPSTATS = ^MIB_TCPSTATS;

MIB_TCPSTATS = record

`dwRtoAlgorithm: DWORD;`
`dwRtoMin: DWORD;`
`dwRtoMax: DWORD;`
`dwMaxConn: DWORD;`
`dwActiveOpens: DWORD;`
`dwPassiveOpens: DWORD;`
`dwAttemptFails: DWORD;`
`dwEstabResets: DWORD;`
`dwCurrEstab: DWORD;`
`dwInSegs: DWORD;`
`dwOutSegs: DWORD;`
`dwRetransSegs: DWORD;`
`dwInErrs: DWORD;`
`dwOutRsts: DWORD;`
`dwNumConns: DWORD;`

MIB TCP row

TMibTcpRow = MIB_TCPROW;

PMibTcpRow = PMIB_TCPROW;

PMIB_TCPROW = ^MIB_TCPROW;

MIB_TCPROW = record

`dwState: DWORD;`
`dwLocalAddr: DWORD;`
`dwLocalPort: DWORD;`
`dwRemoteAddr: DWORD;`
`dwRemotePort: DWORD;`

MIB TCP table

TMibTcpTable = MIB_TCPTABLE;

PMibTcpTable = PMIB_TCPTABLE;

PMIB_TCPTABLE = ^MIB_TCPTABLE;

MIB_TCPTABLE = record

`dwNumEntries: DWORD;`
`table: array [0..ANY_SIZE - 1] of MIB_TCPROW;`

MIB IP statistics

TMibIpStats = MIB_IPSTATS;

PMibIpStats = PMIB_IPSTATS;

PMIB_IPSTATS = ^MIB_IPSTATS;

MIB_IPSTATS = record

`dwForwarding: DWORD;`
`dwDefaultTTL: DWORD;`
`dwInReceives: DWORD;`
`dwInHdrErrors: DWORD;`
`dwInAddrErrors: DWORD;`
`dwForwDatagrams: DWORD;`
`dwInUnknownProtos: DWORD;`
`dwInDiscards: DWORD;`
`dwInDelivers: DWORD;`
`dwOutRequests: DWORD;`
`dwRoutingDiscards: DWORD;`
`dwOutDiscards: DWORD;`
`dwOutNoRoutes: DWORD;`
`dwReasmTimeout: DWORD;`
`dwReasmReqds: DWORD;`
`dwReasmOks: DWORD;`
`dwReasmFails: DWORD;`
`dwFragOks: DWORD;`
`dwFragFails: DWORD;`
`dwFragCreates: DWORD;`
`dwNumIf: DWORD;`
`dwNumAddr: DWORD;`
`dwNumRoutes: DWORD;`

MIB IP address row

TMibIpAddrRow = MIB_IPADDRROW;

PMibIpAddrRow = PMIB_IPADDRROW;

PMIB_IPADDRROW = ^MIB_IPADDRROW;

MIB_IPADDRROW = record

`dwAddr: DWORD;`
`dwIndex: DWORD;`
`dwMask: DWORD;`
`dwBCastAddr: DWORD;`
`dwReasmSize: DWORD;`
`unused1: Word;`
`unused2: Word;`

MIB IP address table

TMibIpAddrTable = MIB_IPADDRTABLE;

PMibIpAddrTable = PMIB_IPADDRTABLE;

PMIB_IPADDRTABLE = ^MIB_IPADDRTABLE;

MIB_IPADDRTABLE = record

`dwNumEntries: DWORD;`
`table: array [0..ANY_SIZE - 1] of MIB_IPADDRROW;`

MIB IP forward number

TMibIpForwardNumber = MIB_IPFORWARDNUMBER;

PMibIpForwardNumber = PMIB_IPFORWARDNUMBER;

PMIB_IPFORWARDNUMBER = ^MIB_IPFORWARDNUMBER;

MIB_IPFORWARDNUMBER = record

`dwValue: DWORD;`

MIB IP forward row

TMibIpForwardRow = MIB_IPFORWARDROW;

PMibIpForwardRow = PMIB_IPFORWARDROW;

PMIB_IPFORWARDROW = ^MIB_IPFORWARDROW;

MIB_IPFORWARDROW = record

`dwForwardDest: DWORD;`
`dwForwardMask: DWORD;`
`dwForwardPolicy: DWORD;`
`dwForwardNextHop: DWORD;`
`dwForwardIfIndex: DWORD;`
`dwForwardType: DWORD;`
`dwForwardProto: DWORD;`
`dwForwardAge: DWORD;`
`dwForwardNextHopAS: DWORD;`
`dwForwardMetric1: DWORD;`
`dwForwardMetric2: DWORD;`
`dwForwardMetric3: DWORD;`
`dwForwardMetric4: DWORD;`
`dwForwardMetric5: DWORD;`

MIB IP forward table

TMibIpForwardTable = MIB_IPFORWARDTABLE;

PMibIpForwardTable = PMIB_IPFORWARDTABLE;

PMIB_IPFORWARDTABLE = ^MIB_IPFORWARDTABLE;

MIB_IPFORWARDTABLE = record

`dwNumEntries: DWORD;`
`table: array [0..ANY_SIZE - 1] of MIB_IPFORWARDROW;`

MIB IP net row

TMibIpNetRow = MIB_IPNETROW;

PMibIpNetRow = PMIB_IPNETROW;

PMIB_IPNETROW = ^MIB_IPNETROW;

MIB_IPNETROW = record

`dwIndex: DWORD;`
`dwPhysAddrLen: DWORD;`
`bPhysAddr: array [0..MAXLEN_PHYSADDR - 1] of BYTE;`
`dwAddr: DWORD;`
`dwType: DWORD;`

MIB IP net table

TMibIpNetTable = MIB_IPNETTABLE;

PMibIpNetTable = PMIB_IPNETTABLE;

PMIB_IPNETTABLE = ^MIB_IPNETTABLE;

MIB_IPNETTABLE = record

`dwNumEntries: DWORD;`
`table: array [0..ANY_SIZE - 1] of MIB_IPNETROW;`

IP adapter index map

TIpAdapterIndexMap = IP_ADAPTER_INDEX_MAP;

PIpAdapterIndexMap = PIP_ADAPTER_INDEX_MAP;

PIP_ADAPTER_INDEX_MAP = ^IP_ADAPTER_INDEX_MAP;

IP_ADAPTER_INDEX_MAP = record

`Index: ULONG;`
`Name: array [0..MAX_ADAPTER_NAME - 1] of WideChar;`

IP interface info

TIpInterfaceInfo = IP_INTERFACE_INFO;

PIpInterfaceInfo = PIP_INTERFACE_INFO;

PIP_INTERFACE_INFO = ^IP_INTERFACE_INFO;

IP_INTERFACE_INFO = record

`NumAdapters: Longint;`
`Adapter: array [0..0] of IP_ADAPTER_INDEX_MAP;`

IP unidirectional adapter address

TIpUnidirectionalAdapterAddress = IP_UNIDIRECTIONAL_ADAPTER_ADDRESS;

PIpUnidirectionalAdapterAddress = PIP_UNIDIRECTIONAL_ADAPTER_ADDRESS;

PIP_UNIDIRECTIONAL_ADAPTER_ADDRESS = ^IP_UNIDIRECTIONAL_ADAPTER_ADDRESS;

IP_UNIDIRECTIONAL_ADAPTER_ADDRESS = record

`NumAdapters: ULONG;`
`Address: array [0..0] of IPAddr;`

IP address string

TIpAddressString = IP_ADDRESS_STRING;

PIpAddressString = PIP_MASK_STRING;

PIP_ADDRESS_STRING = ^IP_ADDRESS_STRING;

IP_MASK_STRING = IP_ADDRESS_STRING;

PIP_MASK_STRING = ^IP_MASK_STRING;

IP_ADDRESS_STRING = record

`S: array [0..15] of Char;`

IP addr string

TIpAddrString = IP_ADDR_STRING;

PIpAddrString = PIP_ADDR_STRING;

PIP_ADDR_STRING = ^IP_ADDR_STRING;

IP_ADDR_STRING = record

`Next: PIP_ADDR_STRING;`
`IpAddress: IP_ADDRESS_STRING;`
`IpMask: IP_MASK_STRING;`
`Context: DWORD;`

IP adapter information

TIpAdapterInfo = IP_ADAPTER_INFO;

PIpAdapterInfo = PIP_ADAPTER_INFO;

PIP_ADAPTER_INFO = ^IP_ADAPTER_INFO;

IP_ADAPTER_INFO = record

`Next: PIP_ADAPTER_INFO;`
`ComboIndex: DWORD;`
`AdapterName: array [0..MAX_ADAPTER_NAME_LENGTH + 3] of Char;`
`Description: array [0..MAX_ADAPTER_DESCRIPTION_LENGTH + 3] of Char;`
`AddressLength: UINT;`
`Address: array [0..MAX_ADAPTER_ADDRESS_LENGTH - 1] of BYTE;`
`Index: DWORD;`
`Type_: UINT;`
`DhcpEnabled: UINT;`
`CurrentIpAddress: PIP_ADDR_STRING;`
`IpAddressList: IP_ADDR_STRING;`
`GatewayList: IP_ADDR_STRING;`
`DhcpServer: IP_ADDR_STRING;`
`HaveWins: BOOL;`
`PrimaryWinsServer: IP_ADDR_STRING;`
`SecondaryWinsServer: IP_ADDR_STRING;`
`LeaseObtained: LongInt;`	time_t
`LeaseExpires: LongInt;`	time_t

IP per adapter information

TIpPerAdapterInfo = IP_PER_ADAPTER_INFO;

PIpPerAdapterInfo = PIP_PER_ADAPTER_INFO;

PIP_PER_ADAPTER_INFO = ^IP_PER_ADAPTER_INFO;

IP_PER_ADAPTER_INFO = record

`AutoconfigEnabled: UINT;`
`AutoconfigActive: UINT;`
`CurrentDnsServer: PIP_ADDR_STRING;`
`DnsServerList: IP_ADDR_STRING;`

Fixed information

TFixedInfo = FIXED_INFO;

PFixedInfo = PFIXED_INFO;

PFIXED_INFO = ^FIXED_INFO;

FIXED_INFO = record

`HostName: array [0..MAX_HOSTNAME_LEN + 3] of Char;`
`DomainName: array[0..MAX_DOMAIN_NAME_LEN + 3] of Char;`
`CurrentDnsServer: PIP_ADDR_STRING;`
`DnsServerList: IP_ADDR_STRING;`
`NodeType: UINT;`
`ScopeId: array [0..MAX_SCOPE_ID_LEN + 3] of Char;`
`EnableRouting: UINT;`
`EnableProxy: UINT;`
`EnableDns: UINT;`

Public variables

None defined

Function declarations

Initialization functions

function IPHelperStart:Boolean;

Description: Initialize and start the Winsock2 provider

Note	Only called internally by IP Helper functions

function IPHelperStop:Boolean;

Description: Terminate and stop the Winsock2 provider

Note	Only called internally by IP Helper functions

Helper functions

function IPHelperConvertError(Status:Integer):DWORD;

Description: Convert a Winsock2 error to an error code

Note	None documented

IP helper functions

function GetNumberOfInterfaces(var pdwNumIf: DWORD): DWORD;