ホーム › Networking.WinInet › InternetCanonicalizeUrlW

InternetCanonicalizeUrlW

関数

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

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

シグネチャ

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

BOOL InternetCanonicalizeUrlW(
    LPCWSTR lpszUrl,
    LPWSTR lpszBuffer,
    DWORD* lpdwBufferLength,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

lpszUrl

LPCWSTR

正規化する URL を含む文字列へのポインターです。

lpszBuffer

LPWSTR

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 を正規化します。これには、安全でない文字やスペースをエスケープシーケンスに変換する処理が含まれます。(Unicode)

戻り値

成功した場合は 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_NO_ENCODE なしで ICU_DECODE フラグを使用した場合、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 内やグローバルオブジェクトのコンストラクター/デストラクター内から安全に呼び出すことはできません。

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

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして InternetCanonicalizeUrl を定義しています。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、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 InternetCanonicalizeUrlW(
    LPCWSTR lpszUrl,
    LPWSTR lpszBuffer,
    DWORD* lpdwBufferLength,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool InternetCanonicalizeUrlW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszUrl,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszBuffer,   // LPWSTR out
    ref uint lpdwBufferLength,   // DWORD* in/out
    uint dwFlags   // DWORD
);

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

' lpszUrl : LPCWSTR
' lpszBuffer : LPWSTR out
' lpdwBufferLength : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function InternetCanonicalizeUrlW Lib "wininet" ( _
    ByVal lpszUrl As LongPtr, _
    ByVal lpszBuffer As LongPtr, _
    ByRef lpdwBufferLength As Long, _
    ByVal dwFlags As Long) 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

InternetCanonicalizeUrlW = ctypes.windll.wininet.InternetCanonicalizeUrlW
InternetCanonicalizeUrlW.restype = wintypes.BOOL
InternetCanonicalizeUrlW.argtypes = [
    wintypes.LPCWSTR,  # lpszUrl : LPCWSTR
    wintypes.LPWSTR,  # lpszBuffer : LPWSTR 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')
InternetCanonicalizeUrlW = Fiddle::Function.new(
  lib['InternetCanonicalizeUrlW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszBuffer : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpdwBufferLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn InternetCanonicalizeUrlW(
        lpszUrl: *const u16,  // LPCWSTR
        lpszBuffer: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool InternetCanonicalizeUrlW([MarshalAs(UnmanagedType.LPWStr)] string lpszUrl, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszBuffer, ref uint lpdwBufferLength, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_InternetCanonicalizeUrlW' -Namespace Win32 -PassThru
# $api::InternetCanonicalizeUrlW(lpszUrl, lpszBuffer, lpdwBufferLength, dwFlags)

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

出力引数:

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