Win32 API 日本語リファレンス
ホームUI.Shell › UrlCanonicalizeA

UrlCanonicalizeA

関数
URLを正規化し冗長な要素を整理した形式に変換する。
DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT UrlCanonicalizeA(
    LPCSTR pszUrl,
    LPSTR pszCanonicalized,
    DWORD* pcchCanonicalized,
    DWORD dwFlags
);

パラメーター

名前方向
pszUrlLPCSTRin
pszCanonicalizedLPSTRout
pcchCanonicalizedDWORD*inout
dwFlagsDWORDin

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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   // HRESULT
function 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)。