RtlIpv4AddressToStringEx 函式會將 IPv4 位址和埠號碼轉換成因特網標準格式的字串。
語法
NTSYSAPI NTSTATUS RtlIpv4AddressToStringExA(
[in] const in_addr *Address,
[in] USHORT Port,
[out] PSTR AddressString,
[in, out] PULONG AddressStringLength
);
參數
[in] Address
網路位元組順序的 IPv4 位址。
[in] Port
網路位元組順序格式的連接埠號碼。 這是選擇性參數。
[out] AddressString
緩衝區的指標,以接收 IPv4 位址和埠的 NULL 結尾字串表示法。 此緩衝區應該足夠大,至少可以容納 INET_ADDRSTRLEN 個字元。 INET_ADDRSTRLEN值定義在 Ws2ipdef.h 標頭檔中。
[in, out] AddressStringLength
輸入時,符合 AddressString 參數所指向緩衝區的字元數目,包括 NULL 終止字元。
在輸出時,此參數包含實際寫入 AddressString 參數所指向緩衝區的字元數目。
返回值
如果函式成功,則傳回值為 STATUS_SUCCESS。
如果函式失敗,傳回值會是下列其中一個錯誤碼。
| 回傳碼 | Description |
|---|---|
|
無效的參數已傳遞至函式。 如果在 AddressString 或 AddressStringLength 參數中傳遞 NULL 指標,則會傳回此錯誤。 如果 AddressString 參數所指向的緩衝區長度不足以接收 IPv4 位址和埠的字串表示法,也會傳回此錯誤。 |
|
使用 FormatMessage 來取得傳回錯誤的訊息字串。 |
備註
RtlIpv4AddressToStringEx 函式可用來將 IPv4 位址和埠號碼轉換成 IPv4 位址的字串表示法,採用因特網點十進位格式,後面接著冒號字元和埠的字串表示法。
RtlIpv4AddressToStringEx 是便利函式,不需要載入 Windows 通訊端 DLL 即可存取 Windows 通訊端中提供的函式,以執行 IP 位址至字串轉換。
如果 AddressString 參數所指向的緩衝區長度不足以接收 IPv4 位址和埠的字串表示法,則 RtlIpv4AddressToStringEx 會傳回 ERROR_INVALID_PARAMETER ,並將 AddressStringLength 參數設定為所需的緩衝區長度。
定義 UNICODE 或 _UNICODE 時, RtlIpv4AddressToStringEx 會定義為 RtlIpv4AddressToStringExW,這是此函式的 Unicode 版本。 AddressString 參數會定義為 PWSTR 資料類型。
當未定義 UNICODE 和 _UNICODE 時, RtlIpv4AddressToStringEx 會定義為 RtlIpv4AddressToStringExA,這是函式的 ANSI 版本。 AddressString 參數會定義為 PSTR 資料類型。
IN_ADDR結構定義在 Inaddr.h 標頭檔中。
需求
| Requirement | 價值觀 |
|---|---|
| 最低支援的用戶端 | Windows Vista [傳統型應用程式 |UWP 應用程式] |
| 支援的最低伺服器 | Windows Server 2008 [傳統型應用程式 |UWP 應用程式] |
| 目標平臺 | 窗戶 |
| Header | ip2string.h (包括 Mstcpip.h) |
| Library | ntdll.lib |
| DLL | Ntdll.dll |
另請參閱
GetModuleHandle
GetProc位址
InetNtop
伊內普頓
載入程式庫
RtlIpv4AddressToString
RtlIpv4StringTo位址
RtlIpv4StringToAddressEx
RtlIpv6AddressToString
RtlIpv6AddressToStringEx
RtlIpv6StringTo位址
RtlIpv6StringToAddressEx
inet_addr
inet_ntoa