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

UrlEscapeW

関数
URL中の安全でない文字をパーセントエンコードする。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT UrlEscapeW(
    LPCWSTR pszUrl,
    LPWSTR pszEscaped,
    DWORD* pcchEscaped,
    DWORD dwFlags
);

パラメーター

名前方向説明
pszUrlLPCWSTRin最大長 INTERNET_MAX_URL_LENGTH の NULL 終端文字列で、dwFlags の値に応じて完全な URL または URL の一部を格納します。
pszEscapedLPWSTRout変換後の文字列を受け取るバッファーです。安全でない文字はエスケープシーケンスに変換されます。
pcchEscapedDWORD*inout

DWORD 値へのポインターです。入力時には pszEscaped バッファー内の文字数を格納します。UrlEscape を呼び出す前に、呼び出し側アプリケーションは pcchEscaped が参照する値にバッファーのサイズを設定する必要があります。この関数が正常に返ると、この値には終端の NULL 文字を含まないバッファーに書き込まれた文字数が格納されます。

E_POINTER エラーコードが返された場合、バッファーが結果を保持するには小さすぎたことを意味し、pcchEscaped が参照する値には必要なバッファー内の文字数が設定されます。それ以外のエラーが返された場合、pcchEscaped が参照する値は未定義です。

dwFlagsDWORDin

pszURL に指定された URL の部分と、その文字列中のどの文字をエスケープシーケンスに変換するかを示すフラグです。次のフラグが定義されています。

URL_DONT_ESCAPE_EXTRA_INFO (0x02000000)

URL_ESCAPE_SPACES_ONLY と組み合わせた場合にのみ使用され、クエリ(文字列中で最初に現れる # または ? 文字以降の URL の部分)内の文字の変換を抑止します。このフラグを単独で使用したり、URL_ESCAPE_SEGMENT_ONLY と組み合わせたりしないでください。

URL_BROWSER_MODE

URL_DONT_ESCAPE_EXTRA_INFO と同じ値として定義されています。

URL_ESCAPE_SPACES_ONLY (0x04000000)

URL のクエリ部分に含まれるスペース文字も含め、スペース文字のみをエスケープシーケンスに変換します。それ以外の安全でない文字はエスケープシーケンスに変換されません。このフラグは pszURL が完全な URL を含まないことを前提とし、サーバー指定以降の部分のみが渡されることを想定しています。

このフラグを URL_DONT_ESCAPE_EXTRA_INFO と組み合わせると、URL のクエリ部分のスペース文字の変換を抑止できます。

このフラグは URL_ESCAPE_PERCENT または URL_ESCAPE_SEGMENT_ONLY と組み合わせることはできません。

URL_ESCAPE_PERCENT (0x00001000)

URL のセグメント部分(サーバー指定と最初の # または ? 文字の間にある部分)に含まれる % 文字を変換します。既定では、% 文字はエスケープシーケンスに変換されません。セグメント内のそれ以外の安全でない文字は通常どおり変換されます。

このフラグを URL_ESCAPE_SEGMENT_ONLY と組み合わせると、URL のクエリ部分の % 文字も対象に含まれます。ただし、URL_ESCAPE_SEGMENT_ONLY フラグは文字列全体をセグメントとみなすため、# や ? 文字も変換されます。

このフラグは URL_ESCAPE_SPACES_ONLY と組み合わせることはできません。

URL_ESCAPE_SEGMENT_ONLY (0x00002000)

pszURL がサーバーコンポーネント以降かつクエリより前の URL 部分のみを含むことを示します。文字列中のすべての安全でない文字が変換されます。このフラグを設定した状態で完全な URL を指定した場合、# や ? 文字を含む文字列全体のすべての安全でない文字が変換されます。

このフラグを URL_ESCAPE_PERCENT と組み合わせると、% 文字も変換の対象に含まれます。

このフラグは URL_ESCAPE_SPACES_ONLY または URL_DONT_ESCAPE_EXTRA_INFO と組み合わせることはできません。

URL_ESCAPE_AS_UTF8 (0x00040000)

Windows 7 以降。すべての非 ASCII 文字を、それらに対応する UTF-8 表現としてパーセントエンコードします。

URL_ESCAPE_ASCII_URI_COMPONENT (0x00080000)

Windows 8 以降。URI RFC 3986 の予約されていない文字集合(a-zA-Z0-9-.~_)に含まれないすべての ASCII 文字をパーセントエンコードします。

- dwFlags.URL_BROWSER_MODE

URL_DONT_ESCAPE_EXTRA_INFO と同じ値として定義されています。

- dwFlags.URL_DONT_ESCAPE_EXTRA_INFO (0x02000000)

URL_ESCAPE_SPACES_ONLY と組み合わせた場合にのみ使用され、クエリ(文字列中で最初に現れる # または ? 文字以降の URL の部分)内の文字の変換を抑止します。このフラグを単独で使用したり、URL_ESCAPE_SEGMENT_ONLY と組み合わせたりしないでください。

- dwFlags.URL_ESCAPE_ASCII_URI_COMPONENT (0x00080000)

Windows 8 以降。URI RFC 3986 の予約されていない文字集合(a-zA-Z0-9-.~_)に含まれないすべての ASCII 文字をパーセントエンコードします。

- dwFlags.URL_ESCAPE_AS_UTF8 (0x00040000)

Windows 7 以降。すべての非 ASCII 文字を、それらに対応する UTF-8 表現としてパーセントエンコードします。

- dwFlags.URL_ESCAPE_PERCENT (0x00001000)

URL のセグメント部分(サーバー指定と最初の # または ? 文字の間にある部分)に含まれる % 文字を変換します。既定では、% 文字はエスケープシーケンスに変換されません。セグメント内のそれ以外の安全でない文字は通常どおり変換されます。

このフラグを URL_ESCAPE_SEGMENT_ONLY と組み合わせると、URL のクエリ部分の % 文字も対象に含まれます。ただし、URL_ESCAPE_SEGMENT_ONLY フラグは文字列全体をセグメントとみなすため、# や ? 文字も変換されます。

このフラグは URL_ESCAPE_SPACES_ONLY と組み合わせることはできません。

- dwFlags.URL_ESCAPE_SEGMENT_ONLY (0x00002000)

pszURL がサーバーコンポーネント以降かつクエリより前の URL 部分のみを含むことを示します。文字列中のすべての安全でない文字が変換されます。このフラグを設定した状態で完全な URL を指定した場合、# や ? 文字を含む文字列全体のすべての安全でない文字が変換されます。

このフラグを URL_ESCAPE_PERCENT と組み合わせると、% 文字も変換の対象に含まれます。

このフラグは URL_ESCAPE_SPACES_ONLY または URL_DONT_ESCAPE_EXTRA_INFO と組み合わせることはできません。

- dwFlags.URL_ESCAPE_SPACES_ONLY (0x04000000)

URL のクエリ部分に含まれるスペース文字も含め、スペース文字のみをエスケープシーケンスに変換します。それ以外の安全でない文字はエスケープシーケンスに変換されません。このフラグは pszURL が完全な URL を含まないことを前提とし、サーバー指定以降の部分のみが渡されることを想定しています。

このフラグを URL_DONT_ESCAPE_EXTRA_INFO と組み合わせると、URL のクエリ部分のスペース文字の変換を抑止できます。

このフラグは URL_ESCAPE_PERCENT または URL_ESCAPE_SEGMENT_ONLY と組み合わせることはできません。

戻り値の型: HRESULT

公式ドキュメント

URL 内のインターネット上での転送中に変更される可能性がある文字またはサロゲートペア("安全でない"文字)を、対応するエスケープシーケンスに変換します。(Unicode)

戻り値

型: HRESULT

成功した場合は S_OK を返します。pcchEscaped バッファーが結果を保持するには小さすぎた場合は E_POINTER が返され、pcchEscaped が指す値に必要なバッファーサイズが設定されます。それ以外の場合は標準のエラー値が返されます。

解説(Remarks)

このドキュメントでは、典型的な URL をサーバー、セグメント、クエリの 3 つの部分に分けて説明します。例:

http://microsoft.com/test.asp?url=/example/abc.asp?frame=true#fragment

サーバー部分は "http://microsoft.com/" です。末尾のスラッシュはサーバー部分の一部とみなされます。

セグメント部分は、サーバー部分以降で最初の # または ? 文字より前にあるパスの部分で、この例では単に "test.asp" です。

クエリ部分は、最初の # または ? 文字(これを含む)から末尾までのパスの残りの部分です。この例では "?url=/example/abc.asp?frame=true#fragment" です。

安全でない文字とは、インターネット上での転送中に変更される可能性がある文字を指します。この関数は、安全でない文字を対応する "%xy" 形式のエスケープシーケンスに変換します。次の表に、安全でない文字とそのエスケープシーケンスを示します。

文字 エスケープシーケンス
^ %5E
& %26
` %60
{ %7B
} %7D
| %7C
] %5D
[ %5B
" %22
< %3C
> %3E
\ %5C

URL_ESCAPE_SEGMENT_ONLY フラグを使用すると、# (%23)、? (%3F)、/ (%2F) の各文字も変換されます。

既定では、UrlEscape は # または ? 文字以降のテキストを無視します。URL_ESCAPE_SEGMENT_ONLY フラグは文字列全体をセグメントとみなすことで、この動作を上書きします。URL_ESCAPE_SPACES_ONLY フラグもこの動作を上書きしますが、スペース文字に対してのみ適用されます。

次の例は、各フラグが URL に与える影響を示しています。この例の URL は有効なものではなく、説明のために誇張したものです。


// 完全な元の URL
http://microsoft.com/test/t%e<s t.asp?url=/{ex% ample</abc.asp?frame=true#fr%agment    

// URL_ESCAPE_SPACES_ONLY 
// スペース文字のみがエスケープされます。それ以外の安全でない文字は無視されます。
// 注: このフラグは URL のサーバー部分が省略されていることを想定しています。
Original = test/t%e<s t.asp?url=/{ex% ample</abc.asp?frame=true#fr%agment
Result   = test/t%e<s%20t.asp?url=/{ex%%20ample</abc.asp?frame=true#fr%agment

// URL_ESCAPE_SPACES_ONLY | URL_DONT_ESCAPE_EXTRA_INFO
// セグメント内のスペースはエスケープシーケンスに変換されますが、
// クエリ内のスペースは変換されません。
Original = test/t%e<s t.asp?url=/{ex% ample</abc.asp?frame=true#fr%agment
Result   = test/t%e<s%20t.asp?url=/{ex% ample</abc.asp?frame=true#fr%agment

// URL_ESCAPE_PERCENT
// ここではセグメントとクエリのみが指定され、サーバーコンポーネントは
// 省略されていますが、これは必須ではありません。セグメントのみが対象となります。
// セグメント内のすべての安全でない文字に加え、% 文字が変換されます。
Original = test/t%e<s t.asp?url=/{ex% ample</abc.asp?frame=true#fr%agment
Result   = test/t%25e%3Cs%20t.asp?url=/{ex% ample</abc.asp?frame=true#fr%agment

// URL_ESCAPE_SEGMENT_ONLY
// 注: このフラグはセグメントのみを想定しており、サーバーおよびクエリ
//       コンポーネントは省略されます。
// 通常の安全でない文字に加えて / 文字もエスケープされます。
Original = test/t%e<s t.asp
Result   = test%2Ft%e%3Cs%20t.asp
メモ

shlwapi.h ヘッダーは UrlEscape をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT UrlEscapeW(
    LPCWSTR pszUrl,
    LPWSTR pszEscaped,
    DWORD* pcchEscaped,
    DWORD dwFlags
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int UrlEscapeW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszUrl,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszEscaped,   // LPWSTR out
    ref uint pcchEscaped,   // DWORD* in/out
    uint dwFlags   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlEscapeW(
    <MarshalAs(UnmanagedType.LPWStr)> pszUrl As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszEscaped As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchEscaped As UInteger,   ' DWORD* in/out
    dwFlags As UInteger   ' DWORD
) As Integer
End Function
' pszUrl : LPCWSTR
' pszEscaped : LPWSTR out
' pcchEscaped : DWORD* in/out
' dwFlags : DWORD
Declare PtrSafe Function UrlEscapeW Lib "shlwapi" ( _
    ByVal pszUrl As LongPtr, _
    ByVal pszEscaped As LongPtr, _
    ByRef pcchEscaped 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

UrlEscapeW = ctypes.windll.shlwapi.UrlEscapeW
UrlEscapeW.restype = ctypes.c_int
UrlEscapeW.argtypes = [
    wintypes.LPCWSTR,  # pszUrl : LPCWSTR
    wintypes.LPWSTR,  # pszEscaped : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchEscaped : DWORD* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlEscapeW = Fiddle::Function.new(
  lib['UrlEscapeW'],
  [
    Fiddle::TYPE_VOIDP,  # pszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszEscaped : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchEscaped : DWORD* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn UrlEscapeW(
        pszUrl: *const u16,  // LPCWSTR
        pszEscaped: *mut u16,  // LPWSTR out
        pcchEscaped: *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.Unicode)]
public static extern int UrlEscapeW([MarshalAs(UnmanagedType.LPWStr)] string pszUrl, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszEscaped, ref uint pcchEscaped, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlEscapeW' -Namespace Win32 -PassThru
# $api::UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
#uselib "SHLWAPI.dll"
#func global UrlEscapeW "UrlEscapeW" wptr, wptr, wptr, wptr
; UrlEscapeW pszUrl, varptr(pszEscaped), varptr(pcchEscaped), dwFlags   ; 戻り値は stat
; pszUrl : LPCWSTR -> "wptr"
; pszEscaped : LPWSTR out -> "wptr"
; pcchEscaped : DWORD* in/out -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global UrlEscapeW "UrlEscapeW" wstr, var, var, int
; res = UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
; pszUrl : LPCWSTR -> "wstr"
; pszEscaped : LPWSTR out -> "var"
; pcchEscaped : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UrlEscapeW(LPCWSTR pszUrl, LPWSTR pszEscaped, DWORD* pcchEscaped, DWORD dwFlags)
#uselib "SHLWAPI.dll"
#cfunc global UrlEscapeW "UrlEscapeW" wstr, var, var, int
; res = UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
; pszUrl : LPCWSTR -> "wstr"
; pszEscaped : LPWSTR out -> "var"
; pcchEscaped : DWORD* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlEscapeW = shlwapi.NewProc("UrlEscapeW")
)

// pszUrl (LPCWSTR), pszEscaped (LPWSTR out), pcchEscaped (DWORD* in/out), dwFlags (DWORD)
r1, _, err := procUrlEscapeW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszUrl))),
	uintptr(pszEscaped),
	uintptr(pcchEscaped),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function UrlEscapeW(
  pszUrl: PWideChar;   // LPCWSTR
  pszEscaped: PWideChar;   // LPWSTR out
  pcchEscaped: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlEscapeW';
result := DllCall("SHLWAPI\UrlEscapeW"
    , "WStr", pszUrl   ; LPCWSTR
    , "Ptr", pszEscaped   ; LPWSTR out
    , "Ptr", pcchEscaped   ; DWORD* in/out
    , "UInt", dwFlags   ; DWORD
    , "Int")   ; return: HRESULT
●UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags) = DLL("SHLWAPI.dll", "int UrlEscapeW(char*, char*, void*, dword)")
# 呼び出し: UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
# pszUrl : LPCWSTR -> "char*"
# pszEscaped : LPWSTR out -> "char*"
# pcchEscaped : DWORD* in/out -> "void*"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn UrlEscapeW(
    pszUrl: [*c]const u16, // LPCWSTR
    pszEscaped: [*c]u16, // LPWSTR out
    pcchEscaped: [*c]u32, // DWORD* in/out
    dwFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UrlEscapeW(
    pszUrl: WideCString,  # LPCWSTR
    pszEscaped: ptr uint16,  # LPWSTR out
    pcchEscaped: ptr uint32,  # DWORD* in/out
    dwFlags: uint32  # DWORD
): int32 {.importc: "UrlEscapeW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int UrlEscapeW(
    const(wchar)* pszUrl,   // LPCWSTR
    wchar* pszEscaped,   // LPWSTR out
    uint* pcchEscaped,   // DWORD* in/out
    uint dwFlags   // DWORD
);
ccall((:UrlEscapeW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt16}, Ptr{UInt32}, UInt32),
      pszUrl, pszEscaped, pcchEscaped, dwFlags)
# pszUrl : LPCWSTR -> Cwstring
# pszEscaped : LPWSTR out -> Ptr{UInt16}
# pcchEscaped : DWORD* in/out -> Ptr{UInt32}
# dwFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t UrlEscapeW(
    const uint16_t* pszUrl,
    uint16_t* pszEscaped,
    uint32_t* pcchEscaped,
    uint32_t dwFlags);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
-- pszUrl : LPCWSTR
-- pszEscaped : LPWSTR out
-- pcchEscaped : DWORD* in/out
-- dwFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const UrlEscapeW = lib.func('__stdcall', 'UrlEscapeW', 'int32_t', ['str16', 'uint16_t *', 'uint32_t *', 'uint32_t']);
// UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
// pszUrl : LPCWSTR -> 'str16'
// pszEscaped : LPWSTR out -> 'uint16_t *'
// pcchEscaped : DWORD* in/out -> 'uint32_t *'
// dwFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  UrlEscapeW: { parameters: ["buffer", "buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags)
// pszUrl : LPCWSTR -> "buffer"
// pszEscaped : LPWSTR out -> "buffer"
// pcchEscaped : DWORD* in/out -> "pointer"
// dwFlags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UrlEscapeW(
    const uint16_t* pszUrl,
    uint16_t* pszEscaped,
    uint32_t* pcchEscaped,
    uint32_t dwFlags);
C, "SHLWAPI.dll");
// $ffi->UrlEscapeW(pszUrl, pszEscaped, pcchEscaped, dwFlags);
// pszUrl : LPCWSTR
// pszEscaped : LPWSTR out
// pcchEscaped : 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.UNICODE_OPTIONS);
    int UrlEscapeW(
        WString pszUrl,   // LPCWSTR
        char[] pszEscaped,   // LPWSTR out
        IntByReference pcchEscaped,   // DWORD* in/out
        int dwFlags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun UrlEscapeW = UrlEscapeW(
    pszUrl : UInt16*,   # LPCWSTR
    pszEscaped : UInt16*,   # LPWSTR out
    pcchEscaped : 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 UrlEscapeWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, Uint32);
typedef UrlEscapeWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Uint32>, int);
final UrlEscapeW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<UrlEscapeWNative, UrlEscapeWDart>('UrlEscapeW');
// pszUrl : LPCWSTR -> Pointer<Utf16>
// pszEscaped : LPWSTR out -> Pointer<Utf16>
// pcchEscaped : DWORD* in/out -> Pointer<Uint32>
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlEscapeW(
  pszUrl: PWideChar;   // LPCWSTR
  pszEscaped: PWideChar;   // LPWSTR out
  pcchEscaped: Pointer;   // DWORD* in/out
  dwFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlEscapeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlEscapeW"
  c_UrlEscapeW :: CWString -> CWString -> Ptr Word32 -> Word32 -> IO Int32
-- pszUrl : LPCWSTR -> CWString
-- pszEscaped : LPWSTR out -> CWString
-- pcchEscaped : DWORD* in/out -> Ptr Word32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlescapew =
  foreign "UrlEscapeW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* pszUrl : LPCWSTR -> (ptr uint16_t) *)
(* pszEscaped : LPWSTR out -> (ptr uint16_t) *)
(* pcchEscaped : 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 ("UrlEscapeW" url-escape-w :convention :stdcall) :int32
  (psz-url (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-escaped :pointer)   ; LPWSTR out
  (pcch-escaped :pointer)   ; DWORD* in/out
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlEscapeW = Win32::API::More->new('SHLWAPI',
    'int UrlEscapeW(LPCWSTR pszUrl, LPWSTR pszEscaped, LPVOID pcchEscaped, DWORD dwFlags)');
# my $ret = $UrlEscapeW->Call($pszUrl, $pszEscaped, $pcchEscaped, $dwFlags);
# pszUrl : LPCWSTR -> LPCWSTR
# pszEscaped : LPWSTR out -> LPWSTR
# pcchEscaped : DWORD* in/out -> LPVOID
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い