UrlHashA

関数

URL文字列からハッシュ値を計算して取得する。

DLLSHLWAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT UrlHashA(
    LPCSTR pszUrl,
    BYTE* pbHash,
    DWORD cbHash
);

パラメーター

名前	型	方向	説明
pszUrl	LPCSTR	in	URL を格納する、最大長 INTERNET_MAX_URL_LENGTH の null 終端文字列です。
pbHash	BYTE*	out	この関数が正常に終了したときに、ハッシュ化された配列を受け取るバッファへのポインターです。
cbHash	DWORD	in	pbHash の配列の要素数です。256 を超えないようにしてください。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

HRESULT UrlHashA(
    LPCSTR pszUrl,
    BYTE* pbHash,
    DWORD cbHash
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int UrlHashA(
    [MarshalAs(UnmanagedType.LPStr)] string pszUrl,   // LPCSTR
    IntPtr pbHash,   // BYTE* out
    uint cbHash   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function UrlHashA(
    <MarshalAs(UnmanagedType.LPStr)> pszUrl As String,   ' LPCSTR
    pbHash As IntPtr,   ' BYTE* out
    cbHash As UInteger   ' DWORD
) As Integer
End Function

' pszUrl : LPCSTR
' pbHash : BYTE* out
' cbHash : DWORD
Declare PtrSafe Function UrlHashA Lib "shlwapi" ( _
    ByVal pszUrl As String, _
    ByVal pbHash As LongPtr, _
    ByVal cbHash As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

UrlHashA = ctypes.windll.shlwapi.UrlHashA
UrlHashA.restype = ctypes.c_int
UrlHashA.argtypes = [
    wintypes.LPCSTR,  # pszUrl : LPCSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pbHash : BYTE* out
    wintypes.DWORD,  # cbHash : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
UrlHashA = Fiddle::Function.new(
  lib['UrlHashA'],
  [
    Fiddle::TYPE_VOIDP,  # pszUrl : LPCSTR
    Fiddle::TYPE_VOIDP,  # pbHash : BYTE* out
    -Fiddle::TYPE_INT,  # cbHash : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn UrlHashA(
        pszUrl: *const u8,  // LPCSTR
        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.Ansi)]
public static extern int UrlHashA([MarshalAs(UnmanagedType.LPStr)] string pszUrl, IntPtr pbHash, uint cbHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_UrlHashA' -Namespace Win32 -PassThru
# $api::UrlHashA(pszUrl, pbHash, cbHash)

#uselib "SHLWAPI.dll"
#func global UrlHashA "UrlHashA" sptr, sptr, sptr
; UrlHashA pszUrl, varptr(pbHash), cbHash   ; 戻り値は stat
; pszUrl : LPCSTR -> "sptr"
; pbHash : BYTE* out -> "sptr"
; cbHash : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global UrlHashA "UrlHashA" str, var, int
; res = UrlHashA(pszUrl, pbHash, cbHash)
; pszUrl : LPCSTR -> "str"
; pbHash : BYTE* out -> "var"
; cbHash : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global UrlHashA "UrlHashA" str, sptr, int
; res = UrlHashA(pszUrl, varptr(pbHash), cbHash)
; pszUrl : LPCSTR -> "str"
; pbHash : BYTE* out -> "sptr"
; cbHash : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。