ホーム › Networking.WinInet › InternetCanonicalizeUrlA

InternetCanonicalizeUrlA

関数

URLを正規化された形式に変換する(ANSI)。

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

シグネチャ

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

BOOL InternetCanonicalizeUrlA(
    LPCSTR lpszUrl,
    LPSTR lpszBuffer,
    DWORD* lpdwBufferLength,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

lpszUrl

LPCSTR

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

lpszBuffer

LPSTR

out

正規化された URL を受け取るバッファーへのポインター。

lpdwBufferLength

DWORD*

inout

lpszBuffer バッファーのサイズ(文字数)を格納する変数へのポインター。関数が成功した場合、このパラメーターには lpszBuffer バッファーに実際にコピーされた文字数が設定されます(終端の null 文字は含みません)。関数が失敗した場合、このパラメーターには必要なバッファーのサイズ(文字数)が設定され、終端の null 文字を含みます。

dwFlags

DWORD

正規化を制御します。フラグを指定しない場合、関数はすべての安全でない文字とメタシーケンス(.、\ ..、... など)をエスケープシーケンスに変換します。このパラメーターには、次のいずれかの値を指定できます。

Value	Meaning
ICU_BROWSER_MODE	"#" または "?" の後の文字をエンコードまたはデコードせず、"?" の後の末尾の空白を削除しません。この値を指定しない場合、URL 全体がエンコードされ、末尾の空白が削除されます。
ICU_DECODE	URL が解析される前に、エスケープシーケンスを含むすべての %XX シーケンスを文字に変換します。
ICU_ENCODE_PERCENT	検出されたパーセント記号をエンコードします。既定では、パーセント記号はエンコードされません。この値は Microsoft Internet Explorer 5 以降で使用できます。
ICU_ENCODE_SPACES_ONLY	スペースのみをエンコードします。
ICU_NO_ENCODE	安全でない文字をエスケープシーケンスに変換しません。
ICU_NO_META	メタシーケンス("." や ".." など)を URL から削除しません。

戻り値の型: BOOL

公式ドキュメント

URL を正規化します。これには、安全でない文字やスペースをエスケープシーケンスに変換する処理が含まれます。(ANSI)

戻り値

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

Return code	Description
ERROR_BAD_PATHNAME	URL を正規化できませんでした。
ERROR_INSUFFICIENT_BUFFER	正規化された URL が大きすぎて、指定されたバッファーに収まりません。 lpdwBufferLength パラメーターには、正規化された URL を保持するために必要なバッファーのサイズ(バイト単位)が設定されます。
ERROR_INTERNET_INVALID_URL	URL の形式が無効です。
ERROR_INVALID_PARAMETER	無効な文字列、バッファー、バッファーサイズ、またはフラグパラメーターがあります。

解説(Remarks)

Internet Explorer 4.0 以降では、 InternetCanonicalizeUrl は常に ICU_BROWSER_MODE フラグが設定されているかのように動作します。URL 全体を正規化する必要があるクライアントアプリケーションは、 CoInternetParseUrl(アクション PARSE_CANONICALIZE とフラグ URL_ESCAPE_UNSAFE を使用)または UrlCanonicalize のいずれかを使用してください。

InternetCanonicalizeUrl は、ICU_DECODE フラグが指定されていても、既定で常にエンコードを行います。再エンコードせずにデコードするには、ICU_DECODE | ICU_NO_ENCODE を使用します。ICU_DECODE フラグを ICU_NO_ENCODE なしで使用すると、URL は解析前にデコードされ、その後、安全でない文字が解析後に再エンコードされます。この関数は任意のプロトコルスキームを処理しますが、そのためには安全でない文字セットから推論を行う必要があります。

Internet Explorer 3.0 を使用している場合(または Internet Explorer 5 以降で ICU_ENCODE_PERCENT フラグを設定している場合)に InternetCanonicalizeUrl を呼び出すアプリケーションは、特定の URL に対するこの関数の使用状況を追跡する必要があります。URL 内の安全でない文字がエスケープシーケンスに変換されている場合、同じ URL に対して再度 InternetCanonicalizeUrl を(フラグなしで)使用すると、エスケープシーケンスが別のエスケープシーケンスに変換されてしまいます。たとえば、URL 内の空白はエスケープシーケンス %20 に変換されます。その URL に対して再度 InternetCanonicalizeUrl を呼び出すと、% 記号がエスケープシーケンス用に予約された安全でない文字であり、関数によってエスケープシーケンス %25 に置き換えられるため、エスケープシーケンス %20 がエスケープシーケンス %2520 に変換されてしまいます。

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

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

メモ

wininet.h ヘッダーは、InternetCanonicalizeUrl を、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 InternetCanonicalizeUrlA(
    LPCSTR lpszUrl,
    LPSTR lpszBuffer,
    DWORD* lpdwBufferLength,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCanonicalizeUrlA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszUrl,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszBuffer,   // LPSTR out
    ref uint lpdwBufferLength,   // DWORD* in/out
    uint dwFlags   // DWORD
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternetCanonicalizeUrlA(
    <MarshalAs(UnmanagedType.LPStr)> lpszUrl As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpszBuffer As System.Text.StringBuilder,   ' LPSTR out
    ByRef lpdwBufferLength As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

InternetCanonicalizeUrlA = ctypes.windll.wininet.InternetCanonicalizeUrlA
InternetCanonicalizeUrlA.restype = wintypes.BOOL
InternetCanonicalizeUrlA.argtypes = [
    wintypes.LPCSTR,  # lpszUrl : LPCSTR
    wintypes.LPSTR,  # lpszBuffer : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpdwBufferLength : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
InternetCanonicalizeUrlA = Fiddle::Function.new(
  lib['InternetCanonicalizeUrlA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpszBuffer : LPSTR out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "wininet")]
extern "system" {
    fn InternetCanonicalizeUrlA(
        lpszUrl: *const u8,  // LPCSTR
        lpszBuffer: *mut u8,  // LPSTR out
        lpdwBufferLength: *mut u32,  // DWORD* in/out
        dwFlags: u32  // DWORD
    ) -> 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 InternetCanonicalizeUrlA([MarshalAs(UnmanagedType.LPStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszBuffer, ref uint lpdwBufferLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetCanonicalizeUrlA' -Namespace Win32 -PassThru
# $api::InternetCanonicalizeUrlA(lpszUrl, lpszBuffer, lpdwBufferLength, dwFlags)

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

出力引数:

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