ConvertInterfaceLuidToAlias 函式 (netioapi.h)

發行項
02/29/2024

ConvertInterfaceLuidToAlias 函式會將網路介面的本機唯一標識碼 (LUID) 轉換為介面別名。

語法

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API ConvertInterfaceLuidToAlias(
  [in]  const NET_LUID *InterfaceLuid,
  [out] PWSTR          InterfaceAlias,
  [in]  SIZE_T         Length
);

參數

[in] InterfaceLuid

網路介面 NET_LUID 的指標。

[out] InterfaceAlias

當函式成功傳回時，要保存 NULL 終止 Unicode 字串的緩衝區指標，其中包含網路介面的別名名稱。

[in] Length

InterfaceAlias 參數所指向緩衝區的長度，以字元為單位。這個值必須夠大，才能容納網路介面的別名名稱和終止 的NULL 字元。所需的長度上限 為 NDIS_IF_MAX_STRING_SIZE + 1。

傳回值

成功時， ConvertInterfaceLuidToAlias 會傳回NO_ERROR。任何非零傳回值都表示失敗。

錯誤碼	意義
ERROR_INVALID_PARAMETER	其中一個參數無效。如果 InterfaceLuid 或 InterfaceAlias 參數為 NULL 或 InterfaceLuid 參數無效，則會傳回此錯誤。
ERROR_NOT_ENOUGH_MEMORY	沒有足夠的記憶體可用來處理此命令。如果 InterfaceAlias 參數指向的緩衝區大小不夠大，因為 Length 參數中指定的大小不足以保存別名名稱，就會傳回此錯誤。

備註

ConvertInterfaceLuidToAlias 函式可在 Windows Vista 和更新版本上使用。

ConvertInterfaceLuidToAlias 函式與通訊協議無關，可與 IPv6 和 IPv4 通訊協定的網路介面搭配使用。

網路介面的別名名稱長度上限， NDIS_IF_MAX_STRING_SIZE，而沒有終止 NULL 的宣告 會在 Ntddndis.h 頭檔中宣告。 NDIS_IF_MAX_STRING_SIZE定義為 Ifdef.h 頭檔中定義的IF_MAX_STRING_SIZE常數。 Ntddndis.h 和 Ifdef.h 頭文件會自動包含在由 Iphlpapi.h 頭文件自動包含的 Netioapi.h 頭檔中。不應該直接使用 Ntddndis.h、 Ifdef.h 和 Netioapi.h 頭檔。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	netioapi.h (包含 Iphlpapi.h)
程式庫	Iphlpapi.lib
Dll	Iphlpapi.dll