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

UrlHashW

関数
URL文字列からハッシュ値を計算して取得する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT UrlHashW(
    LPCWSTR pszUrl,
    BYTE* pbHash,
    DWORD cbHash
);

パラメーター

名前方向説明
pszUrlLPCWSTRinURL を含む、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。
pbHashBYTE*outこの関数が正常に終了したときに、ハッシュ化された配列を受け取るバッファーへのポインターです。
cbHashDWORDinpbHash が指す配列の要素数です。256 以下である必要があります。

戻り値の型: HRESULT

公式ドキュメント

URL 文字列をハッシュ化します。(Unicode)

戻り値

型: HRESULT

この関数が成功すると S_OK を返します。それ以外の場合は、HRESULT エラーコードを返します。

解説(Remarks)

URL を 1 バイトにハッシュ化するには、cbHash = sizeof(BYTE)、pbHash = (LPBYTE)&bHashedValue を設定します(bHashedValue は 1 バイトのバッファー)。URL を DWORD にハッシュ化するには、cbHash = sizeof(DWORD)、pbHash = (LPBYTE)&dwHashedValue を設定します(dwHashedValue は DWORD のバッファー)。

メモ

shlwapi.h ヘッダーは UrlHash をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、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>

HRESULT UrlHashW(
    LPCWSTR pszUrl,
    BYTE* pbHash,
    DWORD cbHash
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int UrlHashW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszUrl,   // LPCWSTR
    IntPtr pbHash,   // BYTE* out
    uint cbHash   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function UrlHashW(
    <MarshalAs(UnmanagedType.LPWStr)> pszUrl As String,   ' LPCWSTR
    pbHash As IntPtr,   ' BYTE* out
    cbHash As UInteger   ' DWORD
) As Integer
End Function
' pszUrl : LPCWSTR
' pbHash : BYTE* out
' cbHash : DWORD
Declare PtrSafe Function UrlHashW Lib "shlwapi" ( _
    ByVal pszUrl As LongPtr, _
    ByVal pbHash As LongPtr, _
    ByVal cbHash 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

UrlHashW = ctypes.windll.shlwapi.UrlHashW
UrlHashW.restype = ctypes.c_int
UrlHashW.argtypes = [
    wintypes.LPCWSTR,  # pszUrl : LPCWSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbHash : BYTE* out
    wintypes.DWORD,  # cbHash : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlHashW = Fiddle::Function.new(
  lib['UrlHashW'],
  [
    Fiddle::TYPE_VOIDP,  # pszUrl : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pbHash : BYTE* out
    -Fiddle::TYPE_INT,  # cbHash : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn UrlHashW(
        pszUrl: *const u16,  // LPCWSTR
        pbHash: *mut u8,  // BYTE* out
        cbHash: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern int UrlHashW([MarshalAs(UnmanagedType.LPWStr)] string pszUrl, IntPtr pbHash, uint cbHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlHashW' -Namespace Win32 -PassThru
# $api::UrlHashW(pszUrl, pbHash, cbHash)
#uselib "SHLWAPI.dll"
#func global UrlHashW "UrlHashW" wptr, wptr, wptr
; UrlHashW pszUrl, varptr(pbHash), cbHash   ; 戻り値は stat
; pszUrl : LPCWSTR -> "wptr"
; pbHash : BYTE* out -> "wptr"
; cbHash : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global UrlHashW "UrlHashW" wstr, var, int
; res = UrlHashW(pszUrl, pbHash, cbHash)
; pszUrl : LPCWSTR -> "wstr"
; pbHash : BYTE* out -> "var"
; cbHash : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UrlHashW(LPCWSTR pszUrl, BYTE* pbHash, DWORD cbHash)
#uselib "SHLWAPI.dll"
#cfunc global UrlHashW "UrlHashW" wstr, var, int
; res = UrlHashW(pszUrl, pbHash, cbHash)
; pszUrl : LPCWSTR -> "wstr"
; pbHash : BYTE* out -> "var"
; cbHash : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procUrlHashW = shlwapi.NewProc("UrlHashW")
)

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

extern "shlwapi" fn UrlHashW(
    pszUrl: [*c]const u16, // LPCWSTR
    pbHash: [*c]u8, // BYTE* out
    cbHash: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UrlHashW(
    pszUrl: WideCString,  # LPCWSTR
    pbHash: ptr uint8,  # BYTE* out
    cbHash: uint32  # DWORD
): int32 {.importc: "UrlHashW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
int UrlHashW(
    const(wchar)* pszUrl,   // LPCWSTR
    ubyte* pbHash,   // BYTE* out
    uint cbHash   // DWORD
);
ccall((:UrlHashW, "SHLWAPI.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt8}, UInt32),
      pszUrl, pbHash, cbHash)
# pszUrl : LPCWSTR -> Cwstring
# pbHash : BYTE* out -> Ptr{UInt8}
# cbHash : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t UrlHashW(
    const uint16_t* pszUrl,
    uint8_t* pbHash,
    uint32_t cbHash);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.UrlHashW(pszUrl, pbHash, cbHash)
-- pszUrl : LPCWSTR
-- pbHash : BYTE* out
-- cbHash : 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 UrlHashW = lib.func('__stdcall', 'UrlHashW', 'int32_t', ['str16', 'uint8_t *', 'uint32_t']);
// UrlHashW(pszUrl, pbHash, cbHash)
// pszUrl : LPCWSTR -> 'str16'
// pbHash : BYTE* out -> 'uint8_t *'
// cbHash : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  UrlHashW: { parameters: ["buffer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.UrlHashW(pszUrl, pbHash, cbHash)
// pszUrl : LPCWSTR -> "buffer"
// pbHash : BYTE* out -> "pointer"
// cbHash : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UrlHashW(
    const uint16_t* pszUrl,
    uint8_t* pbHash,
    uint32_t cbHash);
C, "SHLWAPI.dll");
// $ffi->UrlHashW(pszUrl, pbHash, cbHash);
// pszUrl : LPCWSTR
// pbHash : BYTE* out
// cbHash : 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 UrlHashW(
        WString pszUrl,   // LPCWSTR
        byte[] pbHash,   // BYTE* out
        int cbHash   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun UrlHashW = UrlHashW(
    pszUrl : UInt16*,   # LPCWSTR
    pbHash : UInt8*,   # BYTE* out
    cbHash : 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 UrlHashWNative = Int32 Function(Pointer<Utf16>, Pointer<Uint8>, Uint32);
typedef UrlHashWDart = int Function(Pointer<Utf16>, Pointer<Uint8>, int);
final UrlHashW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<UrlHashWNative, UrlHashWDart>('UrlHashW');
// pszUrl : LPCWSTR -> Pointer<Utf16>
// pbHash : BYTE* out -> Pointer<Uint8>
// cbHash : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UrlHashW(
  pszUrl: PWideChar;   // LPCWSTR
  pbHash: Pointer;   // BYTE* out
  cbHash: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'UrlHashW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UrlHashW"
  c_UrlHashW :: CWString -> Ptr Word8 -> Word32 -> IO Int32
-- pszUrl : LPCWSTR -> CWString
-- pbHash : BYTE* out -> Ptr Word8
-- cbHash : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

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