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

UrlFixupW

関数
誤りを含むURLを修正して正しい形式に整える。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHLWAPI.dll
#include <windows.h>

HRESULT UrlFixupW(
    LPCWSTR pcszUrl,
    LPWSTR pszTranslatedUrl,
    DWORD cchMax
);

パラメーター

名前方向説明
pcszUrlLPCWSTRin修正対象の URL を格納した null 終端文字列へのポインターです。この文字列の長さは、終端の NULL 文字を含めて INTERNET_MAX_PATH_LENGTH 文字を超えてはなりません。
pszTranslatedUrlLPWSTRoutこの関数が正常に終了したときに、コピーされた文字を受け取るバッファーへのポインターです。バッファーは、終端の NULL 文字を含めて cchMax パラメーターで指定された数の WCHAR 文字を格納できる大きさが必要です。このパラメーターは、URL をその場で修正するために pcszUrl パラメーターと同じにすることができます。pszTranslatedUrlpcszUrl と異なる場合、pszTranslatedUrl が指すバッファーは pcszUrl が指すバッファーと重なってはなりません。
cchMaxDWORDinpszTranslatedUrl が指すバッファーに格納できる WCHAR 文字の数です。このパラメーターは 0 より大きくなければなりません。

戻り値の型: HRESULT

公式ドキュメント

UrlFixupW は変更されるか、利用できなくなる可能性があります。

戻り値

型: HRESULT

提案された URL が既に受け入れ可能であったか、正常に修正された場合は S_OK を返します。pszTranslatedUrl バッファーには修正後の URL、または修正が不要であった場合は元の URL が格納されます。提案された URL を修正できるほど十分に認識できなかった場合は S_FALSE を返します。それ以外の場合は、標準的な COM エラーコードを返します。

解説(Remarks)

UrlFixup 関数は、URL_SCHEME 列挙体で指定されたスキームを認識します。

プロトコル識別子部分の最初の文字が優先されるため、htpftp ではなく http に変換されます。

注意 この関数を決定論的なデータ変換に使用しないでください。UrlFixupW が使用するヒューリスティックはリリースごとに変更される可能性があります。この関数は、無効である可能性のあるユーザー入力を修正する目的でのみ使用してください。
この関数は Unicode バージョンでのみ利用できます。

この例では UrlFixupW の使用方法を示します。最後の 4 つの自動修正は、おそらくユーザーの意図したものではなく、この関数が使用するヒューリスティックの限界を示している点に注意してください。


#include <windows.h>
#include <shlwapi.h>
#include <stdio.h>
#include <tchar.h>

void sample(LPCWSTR pszUrl)
{
    WCHAR szBuf[256];
    
    HRESULT hr = UrlFixupW(pszUrl, szBuf, 256);
    if (hr == S_OK) 
    {
        wprintf(L"%-35s %s\n", pszUrl, szBuf);
    } 
    else 
    {
        wprintf(L"%-35s failed\n", pszUrl);
    }
}

int __cdecl main()
{
    sample(L"http://www.microsoft.com");
    sample(L"mail:someone@example.com");
    sample(L"abc:def");
    sample(L"someone@example.com");
    sample(L"htpp:wwwmicrosoft.com");
    sample(L"htps:\\\\www.microsoft.com");
    sample(L"http:someone@example.com");

    return 0;
}

..................................

This example might produce the following output:

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

各言語での呼び出し定義

// SHLWAPI.dll
#include <windows.h>

HRESULT UrlFixupW(
    LPCWSTR pcszUrl,
    LPWSTR pszTranslatedUrl,
    DWORD cchMax
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int UrlFixupW(
    [MarshalAs(UnmanagedType.LPWStr)] string pcszUrl,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszTranslatedUrl,   // LPWSTR out
    uint cchMax   // DWORD
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function UrlFixupW(
    <MarshalAs(UnmanagedType.LPWStr)> pcszUrl As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pszTranslatedUrl As System.Text.StringBuilder,   ' LPWSTR out
    cchMax As UInteger   ' DWORD
) As Integer
End Function
' pcszUrl : LPCWSTR
' pszTranslatedUrl : LPWSTR out
' cchMax : DWORD
Declare PtrSafe Function UrlFixupW Lib "shlwapi" ( _
    ByVal pcszUrl As LongPtr, _
    ByVal pszTranslatedUrl As LongPtr, _
    ByVal cchMax As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UrlFixupW = ctypes.windll.shlwapi.UrlFixupW
UrlFixupW.restype = ctypes.c_int
UrlFixupW.argtypes = [
    wintypes.LPCWSTR,  # pcszUrl : LPCWSTR
    wintypes.LPWSTR,  # pszTranslatedUrl : LPWSTR out
    wintypes.DWORD,  # cchMax : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlFixupW = Fiddle::Function.new(
  lib['UrlFixupW'],
  [
    Fiddle::TYPE_VOIDP,  # pcszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pszTranslatedUrl : LPWSTR out
    -Fiddle::TYPE_INT,  # cchMax : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shlwapi")]
extern "system" {
    fn UrlFixupW(
        pcszUrl: *const u16,  // LPCWSTR
        pszTranslatedUrl: *mut u16,  // LPWSTR out
        cchMax: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern int UrlFixupW([MarshalAs(UnmanagedType.LPWStr)] string pcszUrl, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszTranslatedUrl, uint cchMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlFixupW' -Namespace Win32 -PassThru
# $api::UrlFixupW(pcszUrl, pszTranslatedUrl, cchMax)
#uselib "SHLWAPI.dll"
#func global UrlFixupW "UrlFixupW" sptr, sptr, sptr
; UrlFixupW pcszUrl, varptr(pszTranslatedUrl), cchMax   ; 戻り値は stat
; pcszUrl : LPCWSTR -> "sptr"
; pszTranslatedUrl : LPWSTR out -> "sptr"
; cchMax : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global UrlFixupW "UrlFixupW" wstr, var, int
; res = UrlFixupW(pcszUrl, pszTranslatedUrl, cchMax)
; pcszUrl : LPCWSTR -> "wstr"
; pszTranslatedUrl : LPWSTR out -> "var"
; cchMax : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UrlFixupW(LPCWSTR pcszUrl, LPWSTR pszTranslatedUrl, DWORD cchMax)
#uselib "SHLWAPI.dll"
#cfunc global UrlFixupW "UrlFixupW" wstr, var, int
; res = UrlFixupW(pcszUrl, pszTranslatedUrl, cchMax)
; pcszUrl : LPCWSTR -> "wstr"
; pszTranslatedUrl : LPWSTR out -> "var"
; cchMax : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlFixupW = shlwapi.NewProc("UrlFixupW")
)

// pcszUrl (LPCWSTR), pszTranslatedUrl (LPWSTR out), cchMax (DWORD)
r1, _, err := procUrlFixupW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pcszUrl))),
	uintptr(pszTranslatedUrl),
	uintptr(cchMax),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function UrlFixupW(
  pcszUrl: PWideChar;   // LPCWSTR
  pszTranslatedUrl: PWideChar;   // LPWSTR out
  cchMax: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlFixupW';
result := DllCall("SHLWAPI\UrlFixupW"
    , "WStr", pcszUrl   ; LPCWSTR
    , "Ptr", pszTranslatedUrl   ; LPWSTR out
    , "UInt", cchMax   ; DWORD
    , "Int")   ; return: HRESULT
●UrlFixupW(pcszUrl, pszTranslatedUrl, cchMax) = DLL("SHLWAPI.dll", "int UrlFixupW(char*, char*, dword)")
# 呼び出し: UrlFixupW(pcszUrl, pszTranslatedUrl, cchMax)
# pcszUrl : LPCWSTR -> "char*"
# pszTranslatedUrl : LPWSTR out -> "char*"
# cchMax : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

foreign import stdcall safe "UrlFixupW"
  c_UrlFixupW :: CWString -> CWString -> Word32 -> IO Int32
-- pcszUrl : LPCWSTR -> CWString
-- pszTranslatedUrl : LPWSTR out -> CWString
-- cchMax : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlfixupw =
  foreign "UrlFixupW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* pcszUrl : LPCWSTR -> (ptr uint16_t) *)
(* pszTranslatedUrl : LPWSTR out -> (ptr uint16_t) *)
(* cchMax : 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 ("UrlFixupW" url-fixup-w :convention :stdcall) :int32
  (pcsz-url (:string :encoding :utf-16le))   ; LPCWSTR
  (psz-translated-url :pointer)   ; LPWSTR out
  (cch-max :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlFixupW = Win32::API::More->new('SHLWAPI',
    'int UrlFixupW(LPCWSTR pcszUrl, LPWSTR pszTranslatedUrl, DWORD cchMax)');
# my $ret = $UrlFixupW->Call($pcszUrl, $pszTranslatedUrl, $cchMax);
# pcszUrl : LPCWSTR -> LPCWSTR
# pszTranslatedUrl : LPWSTR out -> LPWSTR
# cchMax : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。