NotifyStableUnicastIpAddressTable 函数

NotifyStableUnicastIpAddressTable 函数检索本地计算机上的稳定单播 IP 地址表。

语法

NETIOAPI_API NotifyStableUnicastIpAddressTable(
  _In_    ADDRESS_FAMILY                           Family,
  _Out_   PMIB_UNICASTIPADDRESS_TABLE              *Table,
  _In_    PSTABLE_UNICAST_IPADDRESS_TABLE_CALLBACK CallerCallback,
  _In_    PVOID                                    CallerContext,
  _Inout_ HANDLE                                   *NotificationHandle
);

参数

  • 家庭 [in]
    要检索的地址系列。

    Winsock2.h 头文件中列出了地址系列的可能值。 请注意,AF_地址系列和PF_协议系列常量的值 (相同,例如,AF_INET和PF_INET) ,因此可以使用任一常量。

    在 Windows Vista 和更高版本的 Windows 操作系统上,在 Ws2def.h 头文件中定义 Family 参数的可能值。 请注意,Ws2def.h 头文件自动包含在 Netioapi.h 中,不应直接使用 Ws2def.h。

    地址系列当前支持以下值:

    • AF_INET
      IPv4 地址系列。 指定此值后,函数将检索仅包含 IPv4 条目的稳定单播 IP 地址表。

    • AF_INET6
      IPv6 地址系列。 指定此值后,函数将检索仅包含 IPv6 条目的稳定单播 IP 地址表。

    • AF_UNSPEC
      地址系列未指定。 指定此值后,函数将检索同时包含 IPv4 和 IPv6 条目的稳定单播 IP 地址表。

  • [out]
    指向 MIB_UNICASTIPADDRESS_TABLE 结构的指针。 如果 NotifyStableUnicastIpAddressTable 成功,此参数将返回本地计算机上的稳定单播 IP 地址表。

    当 NotifyStableUnicastIpAddressTable 返回ERROR_IO_PENDING(指示 I/O 请求挂起)时,稳定的单播 IP 地址表将返回到 CallerCallback 参数中的 函数。

  • CallerCallback [in]
    指向要使用稳定单播 IP 地址表调用的函数的指针。 如果 NotifyStableUnicastIpAddressTable 返回ERROR_IO_PENDING,则调用此函数,这指示 I/O 请求挂起。

  • CallerContext [in]
    一个用户上下文,在稳定的单播 IP 地址表可用时传递给 CallerCallback 参数中指定的回调函数。

  • NotificationHandle [in, out]
    一个指针,用于返回句柄,驱动程序可以使用该句柄来取消请求以检索稳定的单播 IP 地址表。 如果 NotifyStableUnicastIpAddressTable 的返回值ERROR_IO_PENDING,则返回此参数,这指示 I/O 请求处于挂起状态。

返回值

NotifyStableUnicastIpAddressTable 返回STATUS_SUCCESS,如果函数立即成功,则会在 Table 参数中返回稳定的单播 IP 表。

如果 I/O 请求处于挂起状态,函数将返回ERROR_IO_PENDING并且当 I/O 请求使用稳定的单播 IP 地址表完成时调用 CallerCallback 参数指向的函数。

如果函数失败, NotifyStableUnicastIpAddressTable 将返回以下错误代码之一:

返回代码 说明
ERROR_INVALID_HANDLE

遇到无效句柄时发生内部错误。

STATUS_INVALID_PARAMETER

向该函数传递了无效参数。 如果 Table 参数为 NULL 指针、 NotificationHandle 参数为 NULL 指针,或者 Family 参数不是AF_INET、AF_INET6或AF_UNSPEC,则返回此错误。

STATUS_NOT_ENOUGH_MEMORY

内存不足。

其他

使用 FormatMessage 函数获取返回错误的消息字符串。

注解

所有单播 IP 地址(按需拨号地址除外)仅当它们处于首选状态时才被视为稳定。 对于普通单播 IP 地址条目,此状态将对应于设置为 IpDadStatePreferredIP 地址的 MIB_UNICASTIPADDRESS_ROWDadState 成员。 每个按需拨号地址都定义自己的稳定性指标。 NotifyStableUnicastIpAddressTable 函数目前唯一考虑的按需拨号地址是 Teredo 客户端在本地计算机上使用的单播 IP 地址。

驱动程序必须将 Family 参数设置为 AF_INET、AF_INET6 或 AF_UNSPEC。

如果 NotifyStableUnicastIpAddressTable 成功并返回STATUS_SUCCESS,则 Table 参数将返回本地计算机上的稳定单播 IP 地址表。

当 NotifyStableUnicastIpAddressTable 返回ERROR_IO_PENDING(指示 I/O 请求挂起)时,稳定的单播 IP 地址表将返回到 CallerCallback 参数中的 函数。

如果 Teredo 使用的单播 IP 地址在本地计算机上可用,但不在本地计算机上处于稳定 (限定) 状态, 则 NotifyStableUnicastIpAddressTable 将返回ERROR_IO_PENDING并且稳定的单播 IP 地址表最终通过调用 CallerCallback 参数中的 函数返回。 如果 Teredo 地址不可用或处于稳定状态,并且其他单播 IP 地址处于稳定状态,则永远不会调用 CallerCallback 参数中的函数。

CallerCallback 参数中指定的回调函数应定义为 VOID 类型的函数。 传递给回调函数的参数包括以下内容。

参数 说明

IN PVOID CallerContext

在为通知注册驱动程序时传递给 NotifyStableUnicastIpAddressTable 函数的 CallerContext 参数。

IN PMIB_UNICASTIPADDRESS_TABLE AddressTable

指向 MIB_UNICASTIPADDRESS_TABLE 结构的指针,该结构包含本地计算机上的稳定单播 IP 地址表。

NotifyStableUnicastIpAddressTable 函数主要由使用 Teredo 客户端的驱动程序使用。

若要在回调完成后取消通知,请调用 CancelMibChangeNotify2 函数,传递 NotifyStableUnicastIpAddressTable 返回的 NotificationHandle 参数。

要求

目标平台

通用

版本

在 Windows Vista 和更高版本的 Windows 操作系统中可用。

标头

Netioapi.h (包括 Netioapi.h)

Netio.lib

IRQL

< DISPATCH_LEVEL

另请参阅

CancelMibChangeNotify2

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetTeredoPort

GetUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_NOTIFICATION_TYPE

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyTeredoPortChange

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry