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

UrlCompareW

関数
2つのURLを比較し大小関係を返す。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT UrlCompareW(
    LPCWSTR psz1,
    LPCWSTR psz2,
    BOOL fIgnoreSlash
);

パラメーター

名前方向説明
psz1LPCWSTRin1 番目の URL を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。
psz2LPCWSTRin2 番目の URL を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。
fIgnoreSlashBOOLinいずれか一方または両方の URL の末尾にある '/' 文字を UrlCompare に無視させる場合は TRUE に設定する値です。

戻り値の型: INT

公式ドキュメント

2 つの URL 文字列を大文字と小文字を区別して比較します。(Unicode)

戻り値

型: int

2 つの文字列が等しい場合はゼロを返します。fIgnoreSlashTRUE に設定されており、いずれかの文字列の末尾に '' 文字がある場合も、この関数はゼロを返します。psz1 が指す文字列が psz2 が指す文字列より小さい場合は、負の整数を返します。それ以外の場合は、正の整数を返します。

解説(Remarks)

最良の結果を得るには、まず UrlCanonicalize で URL を正規化してください。その後、正規化された URL を UrlCompare で比較します。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして UrlCompare を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイル エラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

INT UrlCompareW(
    LPCWSTR psz1,
    LPCWSTR psz2,
    BOOL fIgnoreSlash
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int UrlCompareW(
    [MarshalAs(UnmanagedType.LPWStr)] string psz1,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string psz2,   // LPCWSTR
    bool fIgnoreSlash   // BOOL
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlCompareW(
    <MarshalAs(UnmanagedType.LPWStr)> psz1 As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> psz2 As String,   ' LPCWSTR
    fIgnoreSlash As Boolean   ' BOOL
) As Integer
End Function
' psz1 : LPCWSTR
' psz2 : LPCWSTR
' fIgnoreSlash : BOOL
Declare PtrSafe Function UrlCompareW Lib "shlwapi" ( _
    ByVal psz1 As LongPtr, _
    ByVal psz2 As LongPtr, _
    ByVal fIgnoreSlash 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

UrlCompareW = ctypes.windll.shlwapi.UrlCompareW
UrlCompareW.restype = ctypes.c_int
UrlCompareW.argtypes = [
    wintypes.LPCWSTR,  # psz1 : LPCWSTR
    wintypes.LPCWSTR,  # psz2 : LPCWSTR
    wintypes.BOOL,  # fIgnoreSlash : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlCompareW = Fiddle::Function.new(
  lib['UrlCompareW'],
  [
    Fiddle::TYPE_VOIDP,  # psz1 : LPCWSTR
    Fiddle::TYPE_VOIDP,  # psz2 : LPCWSTR
    Fiddle::TYPE_INT,  # fIgnoreSlash : BOOL
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn UrlCompareW(
        psz1: *const u16,  // LPCWSTR
        psz2: *const u16,  // LPCWSTR
        fIgnoreSlash: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int UrlCompareW([MarshalAs(UnmanagedType.LPWStr)] string psz1, [MarshalAs(UnmanagedType.LPWStr)] string psz2, bool fIgnoreSlash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlCompareW' -Namespace Win32 -PassThru
# $api::UrlCompareW(psz1, psz2, fIgnoreSlash)
#uselib "SHLWAPI.dll"
#func global UrlCompareW "UrlCompareW" wptr, wptr, wptr
; UrlCompareW psz1, psz2, fIgnoreSlash   ; 戻り値は stat
; psz1 : LPCWSTR -> "wptr"
; psz2 : LPCWSTR -> "wptr"
; fIgnoreSlash : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHLWAPI.dll"
#cfunc global UrlCompareW "UrlCompareW" wstr, wstr, int
; res = UrlCompareW(psz1, psz2, fIgnoreSlash)
; psz1 : LPCWSTR -> "wstr"
; psz2 : LPCWSTR -> "wstr"
; fIgnoreSlash : BOOL -> "int"
; INT UrlCompareW(LPCWSTR psz1, LPCWSTR psz2, BOOL fIgnoreSlash)
#uselib "SHLWAPI.dll"
#cfunc global UrlCompareW "UrlCompareW" wstr, wstr, int
; res = UrlCompareW(psz1, psz2, fIgnoreSlash)
; psz1 : LPCWSTR -> "wstr"
; psz2 : LPCWSTR -> "wstr"
; fIgnoreSlash : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlCompareW = shlwapi.NewProc("UrlCompareW")
)

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

extern "shlwapi" fn UrlCompareW(
    psz1: [*c]const u16, // LPCWSTR
    psz2: [*c]const u16, // LPCWSTR
    fIgnoreSlash: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UrlCompareW(
    psz1: WideCString,  # LPCWSTR
    psz2: WideCString,  # LPCWSTR
    fIgnoreSlash: int32  # BOOL
): int32 {.importc: "UrlCompareW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int UrlCompareW(
    const(wchar)* psz1,   // LPCWSTR
    const(wchar)* psz2,   // LPCWSTR
    int fIgnoreSlash   // BOOL
);
ccall((:UrlCompareW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Int32),
      psz1, psz2, fIgnoreSlash)
# psz1 : LPCWSTR -> Cwstring
# psz2 : LPCWSTR -> Cwstring
# fIgnoreSlash : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t UrlCompareW(
    const uint16_t* psz1,
    const uint16_t* psz2,
    int32_t fIgnoreSlash);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlCompareW(psz1, psz2, fIgnoreSlash)
-- psz1 : LPCWSTR
-- psz2 : LPCWSTR
-- fIgnoreSlash : BOOL
-- 構造体/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 UrlCompareW = lib.func('__stdcall', 'UrlCompareW', 'int32_t', ['str16', 'str16', 'int32_t']);
// UrlCompareW(psz1, psz2, fIgnoreSlash)
// psz1 : LPCWSTR -> 'str16'
// psz2 : LPCWSTR -> 'str16'
// fIgnoreSlash : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  UrlCompareW: { parameters: ["buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.UrlCompareW(psz1, psz2, fIgnoreSlash)
// psz1 : LPCWSTR -> "buffer"
// psz2 : LPCWSTR -> "buffer"
// fIgnoreSlash : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UrlCompareW(
    const uint16_t* psz1,
    const uint16_t* psz2,
    int32_t fIgnoreSlash);
C, "SHLWAPI.dll");
// $ffi->UrlCompareW(psz1, psz2, fIgnoreSlash);
// psz1 : LPCWSTR
// psz2 : LPCWSTR
// fIgnoreSlash : BOOL
// 構造体/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 UrlCompareW(
        WString psz1,   // LPCWSTR
        WString psz2,   // LPCWSTR
        boolean fIgnoreSlash   // BOOL
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun UrlCompareW = UrlCompareW(
    psz1 : UInt16*,   # LPCWSTR
    psz2 : UInt16*,   # LPCWSTR
    fIgnoreSlash : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UrlCompareWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Int32);
typedef UrlCompareWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final UrlCompareW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<UrlCompareWNative, UrlCompareWDart>('UrlCompareW');
// psz1 : LPCWSTR -> Pointer<Utf16>
// psz2 : LPCWSTR -> Pointer<Utf16>
// fIgnoreSlash : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlCompareW(
  psz1: PWideChar;   // LPCWSTR
  psz2: PWideChar;   // LPCWSTR
  fIgnoreSlash: BOOL   // BOOL
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlCompareW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlCompareW"
  c_UrlCompareW :: CWString -> CWString -> CInt -> IO Int32
-- psz1 : LPCWSTR -> CWString
-- psz2 : LPCWSTR -> CWString
-- fIgnoreSlash : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let urlcomparew =
  foreign "UrlCompareW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* psz1 : LPCWSTR -> (ptr uint16_t) *)
(* psz2 : LPCWSTR -> (ptr uint16_t) *)
(* fIgnoreSlash : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("UrlCompareW" url-compare-w :convention :stdcall) :int32
  (psz1 (:string :encoding :utf-16le))   ; LPCWSTR
  (psz2 (:string :encoding :utf-16le))   ; LPCWSTR
  (f-ignore-slash :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UrlCompareW = Win32::API::More->new('SHLWAPI',
    'int UrlCompareW(LPCWSTR psz1, LPCWSTR psz2, BOOL fIgnoreSlash)');
# my $ret = $UrlCompareW->Call($psz1, $psz2, $fIgnoreSlash);
# psz1 : LPCWSTR -> LPCWSTR
# psz2 : LPCWSTR -> LPCWSTR
# fIgnoreSlash : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目