ConvertInterfaceLuidToAlias 函式會將網路介面的本機唯一標識符 (LUID) 轉換為介面別名。
注意
ConvertInterfaceXxx API 系列會列舉系結至 TCP/IP 之所有介面的識別碼,這可能包括虛擬迷你埠、輕量型篩選器、通道配接器和實體介面。
語法
NETIOAPI_API ConvertInterfaceLuidToAlias(
_In_ const NET_LUID *InterfaceLuid,
_Out_ PWSTR InterfaceAlias,
_In_ SIZE_T Length
);
參數
InterfaceLuid [in]
網路介面 NET_LUID 聯集的指標。InterfaceAlias [out]
要保存 NULL 終止 Unicode 字串之緩衝區的指標。 如果 ConvertInterfaceLuidToAlias 成功傳回,InterfaceAlias 包含網路介面的別名名稱。長度 [in]
InterfaceAlias 參數指向的緩衝區長度,依字元計數。 這個值必須夠大,才能保存網路介面的別名名稱和終止的NULL字元。 允許的最大長度為 NDIS_IF_MAX_STRING_SIZE + 1。 如需NDIS_IF_MAX_STRING_SIZE的詳細資訊,請參閱下列一節。
傳回值
ConvertInterfaceLuidToAlias 如果函式成功,就會傳回STATUS_SUCCESS。 如果函式失敗,ConvertInterfaceLuidToAlias 會傳回下列其中一個錯誤碼:
傳回碼 | 描述 |
---|---|
STATUS_INVALID_PARAMETER | 其中一個參數無效。 ConvertInterfaceLuidToAlias 如果 InterfaceLuid 或 InterfaceAliasNULL,或 InterfaceLuid 無效,則會傳回此錯誤。 |
STATUS_NOT_ENOUGH_MEMORY | 沒有足夠的記憶體可用。 ConvertInterfaceLuidToAlias 會傳回此錯誤,如果 InterfaceAlias 參數指向的緩衝區大小不如 Length 參數中所指定,因此緩衝區無法保存別名名稱。 |
言論
ConvertInterfaceLuidToAlias 函式與通訊協議無關,可與 IPv6 和 IPv4 通訊協定的網路介面搭配使用。
網路介面別名名稱的最大長度,NDIS_IF_MAX_STRING_SIZE,不含終止 NULL 字元,會在 Ntddndis.h 頭檔中宣告。 NDIS_IF_MAX_STRING_SIZE定義為IF_MAX_STRING_SIZE常數,該常數定義於 Ifdef.h 頭檔中。
注意
Ntddndis.h 和 Ifdef.h 頭文件會自動包含在 netioapi.h 頭檔中。 您不應該直接使用 Ntddndis.h 和 Ifdef.h 頭檔。
要求
目標平臺 |
通用 |
版本 |
可在 Windows Vista 和更新版本的 Windows作系統中使用。 |
頁眉 |
Netioapi.h (包括 Netioapi.h) |
圖書館 |
Netio.lib |
IRQL |
PASSIVE_LEVEL |