Difference between revisions of "Unit IPHlpAPI"

From Ultibo.org
Jump to: navigation, search
Line 10: Line 10:
 
----
 
----
  
−
''To be documented''
+
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''IP helper specific constants''' <code> MAX_ADAPTER_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MAX_INTERFACE_NAME_LEN = 256;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>IPRTRMGR_PID = 10000;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ANY_SIZE = 1;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>MAX_ADAPTER_NAME = 128;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>MAX_ADAPTER_DESCRIPTION_LENGTH = 128;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAX_ADAPTER_NAME_LENGTH = 256;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAX_ADAPTER_ADDRESS_LENGTH = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DEFAULT_MINIMUM_ENTITIES = 32;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAX_HOSTNAME_LEN = 128;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAX_DOMAIN_NAME_LEN = 128;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAX_SCOPE_ID_LEN = 256;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>MAXLEN_IFDESCR = 256;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MAXLEN_PHYSADDR = 8;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB operation status constants''' <code> MIB_IF_OPER_STATUS_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IF_OPER_STATUS_NON_OPERATIONAL = 0;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IF_OPER_STATUS_UNREACHABLE = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_OPER_STATUS_DISCONNECTED = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_OPER_STATUS_CONNECTING = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_OPER_STATUS_CONNECTED = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_OPER_STATUS_OPERATIONAL = 5;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB type constants''' <code> MIB_IF_TYPE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IF_TYPE_OTHER = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IF_TYPE_ETHERNET = 6;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_TYPE_TOKENRING = 9;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_TYPE_FDDI = 15;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_TYPE_PPP = 23;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_TYPE_LOOPBACK = 24;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_TYPE_SLIP = 28;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB admin status constants''' <code> MIB_IF_ADMIN_STATUS_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IF_ADMIN_STATUS_UP = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IF_ADMIN_STATUS_DOWN = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IF_ADMIN_STATUS_TESTING = 3;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB TCP constants''' <code> MIB_TCP_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_TCP_RTO_OTHER = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_TCP_RTO_CONSTANT = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_RTO_RSRE = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_RTO_VANJ = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_MAXCONN_DYNAMIC = DWORD(-1);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB TCP state constants''' <code> MIB_TCP_STATE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_TCP_STATE_CLOSED = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_LISTEN = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_SYN_SENT = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_SYN_RCVD = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_ESTAB = 5;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_FIN_WAIT1 = 6;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_FIN_WAIT2 = 7;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_CLOSE_WAIT = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_CLOSING = 9;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_LAST_ACK = 10;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_TIME_WAIT = 11;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_TCP_STATE_DELETE_TCB = 12;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB current constants''' <code> MIB_USE_CURRENT_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_USE_CURRENT_TTL = DWORD(-1);</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_USE_CURRENT_FORWARDING = DWORD(-1);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB IP constants''' <code> MIB_IP_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IP_FORWARDING = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IP_NOT_FORWARDING = 2;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB IP route type constants''' <code> MIB_IPROUTE_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IPROUTE_TYPE_OTHER = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IPROUTE_TYPE_INVALID = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPROUTE_TYPE_DIRECT = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPROUTE_TYPE_INDIRECT = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPROUTE_METRIC_UNUSED = DWORD(-1);</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB IP protocol constants''' <code> MIB_IPPROTO_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IPPROTO_OTHER = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_LOCAL = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_NETMGMT = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_ICMP = 4;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_EGP = 5;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_GGP = 6;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_HELLO = 7;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_RIP = 8;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_IS_IS = 9;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_ES_IS = 10;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_CISCO = 11;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_BBN = 12;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_OSPF = 13;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_BGP = 14;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_NT_AUTOSTATIC = 10002;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_NT_STATIC = 10006;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPPROTO_NT_STATIC_NON_DOD = 10007;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br /> 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 20px; padding-bottom: 15px;">
 +
<div style="font-size: 14px; padding-left: 12px;">'''MIB IP network type constants''' <code> MIB_IPNET_* </code></div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>MIB_IPNET_TYPE_OTHER = 1;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>MIB_IPNET_TYPE_INVALID = 2;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPNET_TYPE_DYNAMIC = 3;</code>
 +
| &nbsp;
 +
|-
 +
| <code>MIB_IPNET_TYPE_STATIC = 4;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Type definitions ===
 
=== Type definitions ===

Revision as of 05:37, 21 December 2016

Return to Unit Reference


Description

To be documented

Constants


IP helper specific constants MAX_ADAPTER_*
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 constants 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 constants 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 admin status constants MIB_IF_ADMIN_STATUS_*
MIB_IF_ADMIN_STATUS_UP = 1;  
MIB_IF_ADMIN_STATUS_DOWN = 2;  
MIB_IF_ADMIN_STATUS_TESTING = 3;  


MIB TCP constants 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 constants 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 constants MIB_USE_CURRENT_*
MIB_USE_CURRENT_TTL = DWORD(-1);  
MIB_USE_CURRENT_FORWARDING = DWORD(-1);  


MIB IP constants MIB_IP_*
MIB_IP_FORWARDING = 1;  
MIB_IP_NOT_FORWARDING = 2;  


MIB IP route type constants 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 constants 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 constants MIB_IPNET_*
MIB_IPNET_TYPE_OTHER = 1;  
MIB_IPNET_TYPE_INVALID = 2;  
MIB_IPNET_TYPE_DYNAMIC = 3;  
MIB_IPNET_TYPE_STATIC = 4;  


Type definitions

To be documented

Public variables

To be documented

Function declarations


IP helper functions 

function GetNumberOfInterfaces(var pdwNumIf: DWORD): DWORD;
Description: To be documented
Note None documented 


function GetIfEntry(pIfRow: PMIB_IFROW): DWORD;
Description: To be documented
Note None documented 


function GetIfTable(pIfTable: PMIB_IFTABLE; var pdwSize: DWORD; bOrder: BOOL): DWORD;
Description: To be documented
Note None documented 


function GetIpAddrTable(pIpAddrTable: PMIB_IPADDRTABLE; var pdwSize: DWORD; bOrder: BOOL): DWORD;
Description: To be documented
Note None documented 


function GetIpNetTable(pIpNetTable: PMIB_IPNETTABLE; var pdwSize: DWORD; bOrder: BOOL): DWORD;
Description: To be documented
Note None documented 


function GetIpForwardTable(pIpForwardTable: PMIB_IPFORWARDTABLE; var pdwSize: DWORD; bOrder: BOOL): DWORD;
Description: To be documented
Note None documented 


function SetIfEntry(const pIfRow: MIB_IFROW): DWORD;
Description: To be documented
Note None documented 


function CreateIpForwardEntry(const pRoute: MIB_IPFORWARDROW): DWORD;
Description: To be documented
Note None documented 


function SetIpForwardEntry(const pRoute: MIB_IPFORWARDROW): DWORD;
Description: To be documented
Note None documented 


function DeleteIpForwardEntry(const pRoute: MIB_IPFORWARDROW): DWORD;
Description: To be documented
Note None documented 


function SetIpStatistics(const pIpStats: MIB_IPSTATS): DWORD;
Description: To be documented
Note None documented 


function SetIpTTL(nTTL: UINT): DWORD;
Description: To be documented
Note None documented 


function GetInterfaceInfo(pIfTable: PIP_INTERFACE_INFO; var dwOutBufLen: DWORD): DWORD;
Description: To be documented
Note None documented 


function GetNetworkParams(pFixedInfo: PFIXED_INFO; var pOutBufLen: DWORD): DWORD;
Description: To be documented
Note None documented 


function GetAdaptersInfo(pAdapterInfo: PIP_ADAPTER_INFO; var pOutBufLen: DWORD): DWORD;
Description: To be documented
Note None documented 


function IpReleaseAddress(const AdapterInfo: IP_ADAPTER_INDEX_MAP): DWORD;
Description: To be documented
Note None documented 


function IpRenewAddress(const AdapterInfo: IP_ADAPTER_INDEX_MAP): DWORD;
Description: To be documented
Note None documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_IPHlpAPI&oldid=2191"