ホーム › Networking.WinInet › InternetCrackUrlW

InternetCrackUrlW

関数

URLを構成要素に分解して解析する(Unicode)。

DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL InternetCrackUrlW(
    LPCWSTR lpszUrl,
    DWORD dwUrlLength,
    WIN_HTTP_CREATE_URL_FLAGS dwFlags,
    URL_COMPONENTSW* lpUrlComponents
);

パラメーター

名前

型

方向

説明

lpszUrl

LPCWSTR

分解対象となる正規化済み URL を含む文字列へのポインターです。

dwUrlLength

DWORD

lpszUrl 文字列のサイズ（TCHARs 単位）です。lpszUrl が ASCIIZ 文字列の場合はゼロを指定します。

dwFlags

WIN_HTTP_CREATE_URL_FLAGS

動作を制御します。このパラメーターには次のいずれかの値を指定できます。

値	意味
ICU_DECODE	エンコードされた文字を通常の形式に戻します。これは、構成要素のコピー先となるバッファーをユーザーが URL_COMPONENTS 構造体内に用意している場合にのみ使用できます。
ICU_ESCAPE	すべてのエスケープシーケンス (%xx) を対応する文字に変換します。これは、構成要素のコピー先となるバッファーをユーザーが URL_COMPONENTS 構造体内に用意している場合にのみ使用できます。

lpUrlComponents

URL_COMPONENTSW*

inout

URL の構成要素を受け取る URL_COMPONENTS 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

URL を構成要素に分解します。(Unicode)

戻り値

関数が成功した場合は TRUE を、それ以外の場合は FALSE を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

必要な構成要素は URL_COMPONENTS 構造体のメンバーによって指定します。各構成要素は値へのポインターを持ち、格納された値の長さを保持するメンバーを持ちます。ある構成要素について値と長さの両方がゼロの場合、その構成要素は返されません。Windows Vista 以降: 構成要素の値へのポインターが NULL で、対応する長さメンバーの値が 0 以外の場合、 lpszUrl 文字列内の対応する構成要素の先頭文字のアドレスがそのポインターに格納され、構成要素の長さが長さメンバーに格納されます。

ポインターがユーザー指定のバッファーのアドレスを保持している場合、長さメンバーにはそのバッファーのサイズを指定する必要があります。 InternetCrackUrl は構成要素をバッファーにコピーし、長さメンバーにはコピーされた構成要素の長さから末尾の文字列終端分の 1 を引いた値が設定されます。

InternetCrackUrl が正しく動作するためには、 URL_COMPONENTS 構造体のサイズ（バイト単位）を dwStructSize メンバーに格納しておく必要があります。

注意スペースを含む "file://" URL に対して InternetCrackUrl を使用しないでください。これは、lpUrlComponents が指す URL_COMPONENTS 構造体の dwUrlPathLength メンバーに返される値が大きすぎるためです。ただし、この問題はスペース文字を含む "file://" URL の場合にのみ発生します。

WinINet API の他のすべての側面と同様に、この関数は DllMain 内やグローバルオブジェクトのコンストラクター/デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスには Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

wininet.h ヘッダーは InternetCrackUrl を、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。このエンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致によりコンパイルエラーや実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL InternetCrackUrlW(
    LPCWSTR lpszUrl,
    DWORD dwUrlLength,
    WIN_HTTP_CREATE_URL_FLAGS dwFlags,
    URL_COMPONENTSW* lpUrlComponents
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCrackUrlW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrl,   // LPCWSTR
    uint dwUrlLength,   // DWORD
    uint dwFlags,   // WIN_HTTP_CREATE_URL_FLAGS
    IntPtr lpUrlComponents   // URL_COMPONENTSW* in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetCrackUrlW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszUrl As String,   ' LPCWSTR
    dwUrlLength As UInteger,   ' DWORD
    dwFlags As UInteger,   ' WIN_HTTP_CREATE_URL_FLAGS
    lpUrlComponents As IntPtr   ' URL_COMPONENTSW* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrl : LPCWSTR
' dwUrlLength : DWORD
' dwFlags : WIN_HTTP_CREATE_URL_FLAGS
' lpUrlComponents : URL_COMPONENTSW* in/out
Declare PtrSafe Function InternetCrackUrlW Lib "wininet" ( _
    ByVal lpszUrl As LongPtr, _
    ByVal dwUrlLength As Long, _
    ByVal dwFlags As Long, _
    ByVal lpUrlComponents As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

InternetCrackUrlW = ctypes.windll.wininet.InternetCrackUrlW
InternetCrackUrlW.restype = wintypes.BOOL
InternetCrackUrlW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrl : LPCWSTR
    wintypes.DWORD,  # dwUrlLength : DWORD
    wintypes.DWORD,  # dwFlags : WIN_HTTP_CREATE_URL_FLAGS
    ctypes.c_void_p,  # lpUrlComponents : URL_COMPONENTSW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetCrackUrlW = Fiddle::Function.new(
  lib['InternetCrackUrlW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCWSTR
    -Fiddle::TYPE_INT,  # dwUrlLength : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : WIN_HTTP_CREATE_URL_FLAGS
    Fiddle::TYPE_VOIDP,  # lpUrlComponents : URL_COMPONENTSW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn InternetCrackUrlW(
        lpszUrl: *const u16,  // LPCWSTR
        dwUrlLength: u32,  // DWORD
        dwFlags: u32,  // WIN_HTTP_CREATE_URL_FLAGS
        lpUrlComponents: *mut URL_COMPONENTSW  // URL_COMPONENTSW* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool InternetCrackUrlW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrl, uint dwUrlLength, uint dwFlags, IntPtr lpUrlComponents);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetCrackUrlW' -Namespace Win32 -PassThru
# $api::InternetCrackUrlW(lpszUrl, dwUrlLength, dwFlags, lpUrlComponents)

#uselib "WININET.dll"
#func global InternetCrackUrlW "InternetCrackUrlW" wptr, wptr, wptr, wptr
; InternetCrackUrlW lpszUrl, dwUrlLength, dwFlags, varptr(lpUrlComponents)   ; 戻り値は stat
; lpszUrl : LPCWSTR -> "wptr"
; dwUrlLength : DWORD -> "wptr"
; dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "wptr"
; lpUrlComponents : URL_COMPONENTSW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global InternetCrackUrlW "InternetCrackUrlW" wstr, int, int, var
; res = InternetCrackUrlW(lpszUrl, dwUrlLength, dwFlags, lpUrlComponents)
; lpszUrl : LPCWSTR -> "wstr"
; dwUrlLength : DWORD -> "int"
; dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "int"
; lpUrlComponents : URL_COMPONENTSW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global InternetCrackUrlW "InternetCrackUrlW" wstr, int, int, sptr
; res = InternetCrackUrlW(lpszUrl, dwUrlLength, dwFlags, varptr(lpUrlComponents))
; lpszUrl : LPCWSTR -> "wstr"
; dwUrlLength : DWORD -> "int"
; dwFlags : WIN_HTTP_CREATE_URL_FLAGS -> "int"
; lpUrlComponents : URL_COMPONENTSW* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。