UrlCanonicalizeA
関数シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
HRESULT UrlCanonicalizeA(
LPCSTR pszUrl,
LPSTR pszCanonicalized,
DWORD* pcchCanonicalized,
DWORD dwFlags
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszUrl | LPCSTR | in | URL 文字列を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列へのポインターです。文字列がファイルを参照していない場合は、"http://" などの有効なスキームを含める必要があります。 |
| pszCanonicalized | LPSTR | out | この関数が正常に戻ったときに、変換された URL を null 終端文字列として受け取るバッファーへのポインターです。 |
| pcchCanonicalized | DWORD* | inout | 呼び出し時に pszCanonicalized バッファーの文字数が設定される値へのポインターです。 |
| dwFlags | DWORD | in | URL を正規化された形式に変換する方法を指定するフラグです。次のフラグを組み合わせて使用できます。 URL_UNESCAPE (0x10000000)URL に含まれるエスケープ シーケンスを 2 つの例外を除いてアンエスケープします。"?" と "#" のエスケープ シーケンスはアンエスケープされません。URL_ESCAPE_XXX フラグのいずれかも設定されている場合、2 つの URL はまずアンエスケープされ、次に結合され、その後エスケープされます。 URL_ESCAPE_UNSAFE (0x20000000)安全でない文字をそのエスケープ シーケンスに置き換えます。安全でない文字とは、インターネット上の転送中に変化する可能性がある文字で、(<、>、"、#、{、}、|、\、^、[、]、および ') の各文字が含まれます。このフラグは、不透明な (opaque) URL を含むすべての URL に適用されます。 URL_PLUGGABLE_PROTOCOL (0x40000000)W3C 仕様に従って、クライアント定義のプラグ可能なプロトコルで URL を結合します。このフラグは、ftp、http、gopher などの標準プロトコルには適用されません。このフラグが設定されている場合、UrlCombine は URL を簡略化しないため、URL_DONT_SIMPLIFY も設定する必要はありません。 URL_ESCAPE_SPACES_ONLY (0x04000000)スペースのみをエスケープ シーケンスに置き換えます。このフラグは URL_ESCAPE_UNSAFE よりも優先されますが、不透明な URL には適用されません。 URL_DONT_SIMPLIFY (0x08000000)URL 文字列中の "/./" および "/../" を、ナビゲーションの省略表記としてではなく、リテラル文字として扱います。詳細は「解説」を参照してください。 URL_NO_META (0x08000000)URL_DONT_SIMPLIFY と同じものとして定義されています。 URL_ESCAPE_PERCENT (0x00001000)"%" の出現箇所をそのエスケープ シーケンスに変換します。 URL_ESCAPE_AS_UTF8 (0x00040000)Windows 7 以降。すべての非 ASCII 文字を、その UTF-8 相当のものとしてパーセント エンコードします。 |
戻り値の型: HRESULT
公式ドキュメント
URL 文字列を正規化された形式に変換します。(ANSI)
戻り値
型: HRESULT
この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。
解説(Remarks)
この関数は、安全でない文字をそのエスケープ シーケンスに置き換える、"....." のようなシーケンスを折りたたむ、といった処理を行います。
URL 文字列に "/../" または "/./" が含まれている場合、UrlCanonicalize はこれらの文字を URL 階層内のナビゲーションを示すものとして扱います。この関数は、URL を結合する前に簡略化します。たとえば "/hello/cruel/../world" は "/hello/world" に簡略化されます。この既定の動作には、次の場合に例外があります。
- dwFlags に URL_DONT_SIMPLIFY フラグが設定されている場合、この関数は URL を簡略化しません。この場合、"/hello/cruel/../world" はそのまま残されます。
- "/../" または "/./" がパスの最初のセグメントである場合 (たとえば "http://domain/../path1/path2/file.htm")、UrlCanonicalize はパスを入力されたとおりに出力します。
shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして UrlCanonicalize を定義しています。エンコード非依存のエイリアスの使用と、エンコード非依存ではないコードを混在させると、コンパイル エラーや実行時エラーの原因となる不一致が生じる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
HRESULT UrlCanonicalizeA(
LPCSTR pszUrl,
LPSTR pszCanonicalized,
DWORD* pcchCanonicalized,
DWORD dwFlags
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int UrlCanonicalizeA(
[MarshalAs(UnmanagedType.LPStr)] string pszUrl, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszCanonicalized, // LPSTR out
ref uint pcchCanonicalized, // DWORD* in/out
uint dwFlags // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UrlCanonicalizeA(
<MarshalAs(UnmanagedType.LPStr)> pszUrl As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> pszCanonicalized As System.Text.StringBuilder, ' LPSTR out
ByRef pcchCanonicalized As UInteger, ' DWORD* in/out
dwFlags As UInteger ' DWORD
) As Integer
End Function' pszUrl : LPCSTR
' pszCanonicalized : LPSTR out
' pcchCanonicalized : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlCanonicalizeA Lib "shlwapi" ( _
ByVal pszUrl As String, _
ByVal pszCanonicalized As String, _
ByRef pcchCanonicalized 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
UrlCanonicalizeA = ctypes.windll.shlwapi.UrlCanonicalizeA
UrlCanonicalizeA.restype = ctypes.c_int
UrlCanonicalizeA.argtypes = [
wintypes.LPCSTR, # pszUrl : LPCSTR
wintypes.LPSTR, # pszCanonicalized : LPSTR out
ctypes.POINTER(wintypes.DWORD), # pcchCanonicalized : DWORD* in/out
wintypes.DWORD, # dwFlags : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
UrlCanonicalizeA = Fiddle::Function.new(
lib['UrlCanonicalizeA'],
[
Fiddle::TYPE_VOIDP, # pszUrl : LPCSTR
Fiddle::TYPE_VOIDP, # pszCanonicalized : LPSTR out
Fiddle::TYPE_VOIDP, # pcchCanonicalized : DWORD* in/out
-Fiddle::TYPE_INT, # dwFlags : DWORD
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn UrlCanonicalizeA(
pszUrl: *const u8, // LPCSTR
pszCanonicalized: *mut u8, // LPSTR out
pcchCanonicalized: *mut u32, // DWORD* in/out
dwFlags: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern int UrlCanonicalizeA([MarshalAs(UnmanagedType.LPStr)] string pszUrl, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszCanonicalized, ref uint pcchCanonicalized, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlCanonicalizeA' -Namespace Win32 -PassThru
# $api::UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags)#uselib "SHLWAPI.dll"
#func global UrlCanonicalizeA "UrlCanonicalizeA" sptr, sptr, sptr, sptr
; UrlCanonicalizeA pszUrl, varptr(pszCanonicalized), varptr(pcchCanonicalized), dwFlags ; 戻り値は stat
; pszUrl : LPCSTR -> "sptr"
; pszCanonicalized : LPSTR out -> "sptr"
; pcchCanonicalized : DWORD* in/out -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHLWAPI.dll" #cfunc global UrlCanonicalizeA "UrlCanonicalizeA" str, var, var, int ; res = UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags) ; pszUrl : LPCSTR -> "str" ; pszCanonicalized : LPSTR out -> "var" ; pcchCanonicalized : DWORD* in/out -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global UrlCanonicalizeA "UrlCanonicalizeA" str, sptr, sptr, int ; res = UrlCanonicalizeA(pszUrl, varptr(pszCanonicalized), varptr(pcchCanonicalized), dwFlags) ; pszUrl : LPCSTR -> "str" ; pszCanonicalized : LPSTR out -> "sptr" ; pcchCanonicalized : DWORD* in/out -> "sptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HRESULT UrlCanonicalizeA(LPCSTR pszUrl, LPSTR pszCanonicalized, DWORD* pcchCanonicalized, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlCanonicalizeA "UrlCanonicalizeA" str, var, var, int ; res = UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags) ; pszUrl : LPCSTR -> "str" ; pszCanonicalized : LPSTR out -> "var" ; pcchCanonicalized : DWORD* in/out -> "var" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT UrlCanonicalizeA(LPCSTR pszUrl, LPSTR pszCanonicalized, DWORD* pcchCanonicalized, DWORD dwFlags) #uselib "SHLWAPI.dll" #cfunc global UrlCanonicalizeA "UrlCanonicalizeA" str, intptr, intptr, int ; res = UrlCanonicalizeA(pszUrl, varptr(pszCanonicalized), varptr(pcchCanonicalized), dwFlags) ; pszUrl : LPCSTR -> "str" ; pszCanonicalized : LPSTR out -> "intptr" ; pcchCanonicalized : DWORD* in/out -> "intptr" ; dwFlags : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procUrlCanonicalizeA = shlwapi.NewProc("UrlCanonicalizeA")
)
// pszUrl (LPCSTR), pszCanonicalized (LPSTR out), pcchCanonicalized (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procUrlCanonicalizeA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszUrl))),
uintptr(pszCanonicalized),
uintptr(pcchCanonicalized),
uintptr(dwFlags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction UrlCanonicalizeA(
pszUrl: PAnsiChar; // LPCSTR
pszCanonicalized: PAnsiChar; // LPSTR out
pcchCanonicalized: Pointer; // DWORD* in/out
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlCanonicalizeA';result := DllCall("SHLWAPI\UrlCanonicalizeA"
, "AStr", pszUrl ; LPCSTR
, "Ptr", pszCanonicalized ; LPSTR out
, "Ptr", pcchCanonicalized ; DWORD* in/out
, "UInt", dwFlags ; DWORD
, "Int") ; return: HRESULT●UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags) = DLL("SHLWAPI.dll", "int UrlCanonicalizeA(char*, char*, void*, dword)")
# 呼び出し: UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags)
# pszUrl : LPCSTR -> "char*"
# pszCanonicalized : LPSTR out -> "char*"
# pcchCanonicalized : DWORD* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn UrlCanonicalizeA(
pszUrl: [*c]const u8, // LPCSTR
pszCanonicalized: [*c]u8, // LPSTR out
pcchCanonicalized: [*c]u32, // DWORD* in/out
dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc UrlCanonicalizeA(
pszUrl: cstring, # LPCSTR
pszCanonicalized: ptr char, # LPSTR out
pcchCanonicalized: ptr uint32, # DWORD* in/out
dwFlags: uint32 # DWORD
): int32 {.importc: "UrlCanonicalizeA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int UrlCanonicalizeA(
const(char)* pszUrl, // LPCSTR
char* pszCanonicalized, // LPSTR out
uint* pcchCanonicalized, // DWORD* in/out
uint dwFlags // DWORD
);ccall((:UrlCanonicalizeA, "SHLWAPI.dll"), stdcall, Int32,
(Cstring, Ptr{UInt8}, Ptr{UInt32}, UInt32),
pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags)
# pszUrl : LPCSTR -> Cstring
# pszCanonicalized : LPSTR out -> Ptr{UInt8}
# pcchCanonicalized : DWORD* in/out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t UrlCanonicalizeA(
const char* pszUrl,
char* pszCanonicalized,
uint32_t* pcchCanonicalized,
uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags)
-- pszUrl : LPCSTR
-- pszCanonicalized : LPSTR out
-- pcchCanonicalized : DWORD* in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const UrlCanonicalizeA = lib.func('__stdcall', 'UrlCanonicalizeA', 'int32_t', ['str', 'char *', 'uint32_t *', 'uint32_t']);
// UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags)
// pszUrl : LPCSTR -> 'str'
// pszCanonicalized : LPSTR out -> 'char *'
// pcchCanonicalized : DWORD* in/out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
UrlCanonicalizeA: { parameters: ["buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags)
// pszUrl : LPCSTR -> "buffer"
// pszCanonicalized : LPSTR out -> "buffer"
// pcchCanonicalized : DWORD* in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t UrlCanonicalizeA(
const char* pszUrl,
char* pszCanonicalized,
uint32_t* pcchCanonicalized,
uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlCanonicalizeA(pszUrl, pszCanonicalized, pcchCanonicalized, dwFlags);
// pszUrl : LPCSTR
// pszCanonicalized : LPSTR out
// pcchCanonicalized : DWORD* in/out
// dwFlags : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
int UrlCanonicalizeA(
String pszUrl, // LPCSTR
byte[] pszCanonicalized, // LPSTR out
IntByReference pcchCanonicalized, // DWORD* in/out
int dwFlags // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun UrlCanonicalizeA = UrlCanonicalizeA(
pszUrl : UInt8*, # LPCSTR
pszCanonicalized : UInt8*, # LPSTR out
pcchCanonicalized : UInt32*, # DWORD* in/out
dwFlags : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef UrlCanonicalizeANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, Uint32);
typedef UrlCanonicalizeADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Uint32>, int);
final UrlCanonicalizeA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<UrlCanonicalizeANative, UrlCanonicalizeADart>('UrlCanonicalizeA');
// pszUrl : LPCSTR -> Pointer<Utf8>
// pszCanonicalized : LPSTR out -> Pointer<Utf8>
// pcchCanonicalized : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function UrlCanonicalizeA(
pszUrl: PAnsiChar; // LPCSTR
pszCanonicalized: PAnsiChar; // LPSTR out
pcchCanonicalized: Pointer; // DWORD* in/out
dwFlags: DWORD // DWORD
): Integer; stdcall;
external 'SHLWAPI.dll' name 'UrlCanonicalizeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "UrlCanonicalizeA"
c_UrlCanonicalizeA :: CString -> CString -> Ptr Word32 -> Word32 -> IO Int32
-- pszUrl : LPCSTR -> CString
-- pszCanonicalized : LPSTR out -> CString
-- pcchCanonicalized : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let urlcanonicalizea =
foreign "UrlCanonicalizeA"
(string @-> string @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* pszUrl : LPCSTR -> string *)
(* pszCanonicalized : LPSTR out -> string *)
(* pcchCanonicalized : DWORD* in/out -> (ptr uint32_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("UrlCanonicalizeA" url-canonicalize-a :convention :stdcall) :int32
(psz-url :string) ; LPCSTR
(psz-canonicalized :pointer) ; LPSTR out
(pcch-canonicalized :pointer) ; DWORD* in/out
(dw-flags :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $UrlCanonicalizeA = Win32::API::More->new('SHLWAPI',
'int UrlCanonicalizeA(LPCSTR pszUrl, LPSTR pszCanonicalized, LPVOID pcchCanonicalized, DWORD dwFlags)');
# my $ret = $UrlCanonicalizeA->Call($pszUrl, $pszCanonicalized, $pcchCanonicalized, $dwFlags);
# pszUrl : LPCSTR -> LPCSTR
# pszCanonicalized : LPSTR out -> LPSTR
# pcchCanonicalized : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f UrlCanonicalizeW (Unicode版) — URLを正規化し冗長な要素を整理した形式に変換する。