RtlIpv4StringToAddressA 関数 (ip2string.h)
RtlIpv4StringToAddress 関数は、IPv4 アドレスの文字列表現をバイナリ IPv4 アドレスに変換します。
構文
NTSYSAPI NTSTATUS RtlIpv4StringToAddressA(
[in] PCSTR S,
[in] BOOLEAN Strict,
[out] PCSTR *Terminator,
[out] in_addr *Addr
);
パラメーター
[in] S
IPv4 アドレスの NULL で終わる文字列表現を含むバッファーへのポインター。
[in] Strict
文字列が厳密な 4 部構成のドット付き 10 進数表記で表される IPv4 アドレスである必要があるかどうかを示す値。 このパラメーターが TRUE の場合、文字列は 4 つの部分でドット 10 進数にする必要があります。 このパラメーターが FALSE の場合は、10 進数、8 進数、または 16 進数表記の 4 つの形式のいずれかを使用できます。 詳細については、「解説」を参照してください。
[out] Terminator
変換された文字列を終了した文字へのポインターを受け取るパラメーター。 これは、呼び出し元が文字列から詳細情報を抽出するために使用できます。
[out] Addr
IPv4 アドレスのバイナリ表現を格納するポインター。
戻り値
関数が成功した場合、戻り値は STATUS_SUCCESS。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| リターン コード | 説明 |
|---|---|
|
無効なパラメーターが関数に渡されました。 Strict パラメーターがTRUE に設定されているが、 S パラメーターが指す文字列に IPv4 アドレスの 4 部構成のドット付き 10 進文字列表現が含まれていない場合、このエラーが返されます。 S パラメーターが 指す文字列に IPv4 アドレスの適切な文字列表現が含まれていない場合も、このエラーが返されます。
このエラー コードは、Ntstatus.h ヘッダー ファイルで定義されています。 |
|
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。 |
注釈
RtlIpv4StringToAddress 関数は、IPv4 アドレスの文字列表現をネットワーク順 (左から右に並べられたバイト数) で返される IPv4 アドレスに変換するために使用されます。
RtlIpv4StringToAddress は、文字列から IP アドレスへの変換を実行するために Windows ソケットで提供される関数にアクセスするために Windows ソケット DLL を読み込む必要がない便利な関数です。
Strict パラメーターが TRUE に設定されている場合、S パラメーターが指す文字列は、厳密なドット付き 10 進数表記である必要があります。 この厳密な形式では、4 つの部分を指定する必要があります。 各部分はデータの 10 進バイトとして解釈され、左から右に IPv4 アドレスの 4 バイトに割り当てられます。
Strict パラメーターが FALSE に設定されている場合、S パラメーターが指す文字列は、使用可能な複数の形式のいずれかになります。 S パラメーターが指すバッファーに 3 部構成のアドレス文字列が含まれている場合、最後の部分は 16 ビット数量として解釈され、ネットワーク アドレスの右端の 2 バイトに配置されます。 これにより、3 部構成のアドレス形式は、クラス B のネットワーク アドレスを "128.net.host" として指定する場合に便利です。 S パラメーターが指すバッファーに 2 部構成のアドレス文字列が含まれている場合、最後の部分は 24 ビット数量として解釈され、ネットワーク アドレスの右端の 3 バイトに配置されます。 これにより、クラス A のネットワーク アドレスを "net.host" として指定する場合に、2 つの部分のアドレス形式が便利になります。 S パラメーターが指すバッファーに 1 部構成のアドレス文字列のみが含まれている場合、値はバイト再配置なしでネットワーク アドレスに直接格納されます。
成功した場合、 Terminator パラメーターは、変換された文字列を終了した文字を指します。 これにより、アプリケーションは IP アドレスと追加情報を含む文字列を RtlIpv4StringToAddress 関数に渡し、残りの情報を解析できます。
UNICODE または_UNICODEが定義されている場合、 RtlIpv4StringToAddress は、この関数の Unicode バージョンである RtlIpv4StringToAddressW に定義されます。 S パラメーターは PCWSTR データ型に定義され、Terminator パラメーターは LPCWSTR データ型に定義されます。
UNICODE と_UNICODEの両方が定義されていない場合、 RtlIpv4StringToAddress は、この関数の ANSI バージョンである RtlIpv4StringToAddressA に定義されます。 S パラメーターと Terminator パラメーターは、PCSTR データ型に定義されます。
IN_ADDR構造体は、Inaddr.h ヘッダー ファイルで定義されています。
RtlIpv4StringToAddress 関数を含むインポート ライブラリは、Windows Vista 用にリリースされた Microsoft Windows ソフトウェア開発キット (SDK) には含まれていません。 RtlIpv4StringToAddress 関数は、Windows Driver Kit (WDK) に含まれる Ntdll.lib インポート ライブラリに含まれています。 アプリケーションでは 、GetModuleHandle 関数と GetProcAddress 関数を使用して 、Ntdll.dll から関数ポインターを取得し、この関数を呼び出すこともできます。
注意
ip2string.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RtlIpv4StringToAddress を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | ip2string.h (Mstcpip.h、Ip2string.h を含む) |
| Library | ntdll.lib |
| [DLL] | ntdll.dll |