ホーム › Networking.WinInet › InternetCrackUrlA

InternetCrackUrlA

関数

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

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

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

BOOL InternetCrackUrlA(
    LPCSTR lpszUrl,
    DWORD dwUrlLength,
    WIN_HTTP_CREATE_URL_FLAGS dwFlags,
    URL_COMPONENTSA* lpUrlComponents
);

パラメーター

名前

型

方向

説明

lpszUrl

LPCSTR

分解する正規化された URL を格納した文字列へのポインター。

dwUrlLength

DWORD

lpszUrl 文字列のサイズ(TCHAR 単位)。lpszUrl が ASCIIZ 文字列の場合はゼロを指定します。

dwFlags

WIN_HTTP_CREATE_URL_FLAGS

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

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

lpUrlComponents

URL_COMPONENTSA*

inout

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

解説(Remarks)

必要な構成要素は、 URL_COMPONENTS 構造体のメンバーによって指定します。各構成要素は値へのポインターを持ち、格納された値の長さを保持するメンバーを持ちます。ある構成要素の値と長さの両方がゼロの場合、その構成要素は返されません。Windows Vista 以降: 構成要素の値へのポインターが NULL で、対応する長さメンバーの値がゼロ以外の場合、 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  (ANSI / -A)
#include <windows.h>

BOOL InternetCrackUrlA(
    LPCSTR lpszUrl,
    DWORD dwUrlLength,
    WIN_HTTP_CREATE_URL_FLAGS dwFlags,
    URL_COMPONENTSA* lpUrlComponents
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCrackUrlA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrl,   // LPCSTR
    uint dwUrlLength,   // DWORD
    uint dwFlags,   // WIN_HTTP_CREATE_URL_FLAGS
    IntPtr lpUrlComponents   // URL_COMPONENTSA* in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetCrackUrlA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As String,   ' LPCSTR
    dwUrlLength As UInteger,   ' DWORD
    dwFlags As UInteger,   ' WIN_HTTP_CREATE_URL_FLAGS
    lpUrlComponents As IntPtr   ' URL_COMPONENTSA* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszUrl : LPCSTR
' dwUrlLength : DWORD
' dwFlags : WIN_HTTP_CREATE_URL_FLAGS
' lpUrlComponents : URL_COMPONENTSA* in/out
Declare PtrSafe Function InternetCrackUrlA Lib "wininet" ( _
    ByVal lpszUrl As String, _
    ByVal dwUrlLength As Long, _
    ByVal dwFlags As Long, _
    ByVal lpUrlComponents As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetCrackUrlA = Fiddle::Function.new(
  lib['InternetCrackUrlA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    -Fiddle::TYPE_INT,  # dwUrlLength : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : WIN_HTTP_CREATE_URL_FLAGS
    Fiddle::TYPE_VOIDP,  # lpUrlComponents : URL_COMPONENTSA* in/out
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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