Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiGetFileHashW

MsiGetFileHashW

関数
指定ファイルのハッシュ値を計算して取得する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiGetFileHashW(
    LPCWSTR szFilePath,
    DWORD dwOptions,
    MSIFILEHASHINFO* pHash
);

パラメーター

名前方向説明
szFilePathLPCWSTRinハッシュを計算する対象ファイルへのパス。
dwOptionsDWORDinこの列の値は 0 でなければなりません。このパラメーターは将来の使用のために予約されています。
pHashMSIFILEHASHINFO*inout返されるファイルハッシュ情報へのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiGetFileHash 関数は、ファイルへのパスを受け取り、そのファイルの 128 ビットハッシュを返します。オーサリングツールは、MsiFileHash テーブルに格納するために必要なファイルハッシュを取得するために MsiGetFileHash を使用できます。(Unicode)

戻り値

意味
ERROR_SUCCESS
関数は正常に完了しました。
ERROR_FILE_NOT_FOUND
ファイルが存在しません。
ERROR_ACCESS_DENIED
バージョン情報を取得するためにファイルを開くことができませんでした。
E_FAIL
予期しないエラーが発生しました。

解説(Remarks)

128 ビットのファイルハッシュ全体は、4 つの 32 ビットフィールドとして返されます。これら 4 つのフィールドの番号付けは 0 から始まります。 MsiGetFileHash が返す値は、 MSIFILEHASHINFO 構造体の 4 つのフィールドに対応します。最初のフィールドは MsiFileHash テーブルの HashPart1 列に、2 番目のフィールドは HashPart2 列に、3 番目のフィールドは HashPart3 列に、4 番目のフィールドは HashPart4 列に対応します。

MsiFileHash テーブルに入力するハッシュ情報は、 MsiGetFileHash または FileHash メソッドを呼び出して取得する必要があります。ファイルハッシュの生成に他の方法を使用しないでください。

メモ

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

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

各言語での呼び出し定義

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

DWORD MsiGetFileHashW(
    LPCWSTR szFilePath,
    DWORD dwOptions,
    MSIFILEHASHINFO* pHash
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetFileHashW(
    [MarshalAs(UnmanagedType.LPWStr)] string szFilePath,   // LPCWSTR
    uint dwOptions,   // DWORD
    IntPtr pHash   // MSIFILEHASHINFO* in/out
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetFileHashW(
    <MarshalAs(UnmanagedType.LPWStr)> szFilePath As String,   ' LPCWSTR
    dwOptions As UInteger,   ' DWORD
    pHash As IntPtr   ' MSIFILEHASHINFO* in/out
) As UInteger
End Function
' szFilePath : LPCWSTR
' dwOptions : DWORD
' pHash : MSIFILEHASHINFO* in/out
Declare PtrSafe Function MsiGetFileHashW Lib "msi" ( _
    ByVal szFilePath As LongPtr, _
    ByVal dwOptions As Long, _
    ByVal pHash As LongPtr) 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

MsiGetFileHashW = ctypes.windll.msi.MsiGetFileHashW
MsiGetFileHashW.restype = wintypes.DWORD
MsiGetFileHashW.argtypes = [
    wintypes.LPCWSTR,  # szFilePath : LPCWSTR
    wintypes.DWORD,  # dwOptions : DWORD
    ctypes.c_void_p,  # pHash : MSIFILEHASHINFO* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiGetFileHashW = msi.NewProc("MsiGetFileHashW")
)

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

extern "msi" fn MsiGetFileHashW(
    szFilePath: [*c]const u16, // LPCWSTR
    dwOptions: u32, // DWORD
    pHash: [*c]MSIFILEHASHINFO // MSIFILEHASHINFO* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiGetFileHashW(
    szFilePath: WideCString,  # LPCWSTR
    dwOptions: uint32,  # DWORD
    pHash: ptr MSIFILEHASHINFO  # MSIFILEHASHINFO* in/out
): uint32 {.importc: "MsiGetFileHashW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiGetFileHashW(
    const(wchar)* szFilePath,   // LPCWSTR
    uint dwOptions,   // DWORD
    MSIFILEHASHINFO* pHash   // MSIFILEHASHINFO* in/out
);
ccall((:MsiGetFileHashW, "msi.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{MSIFILEHASHINFO}),
      szFilePath, dwOptions, pHash)
# szFilePath : LPCWSTR -> Cwstring
# dwOptions : DWORD -> UInt32
# pHash : MSIFILEHASHINFO* in/out -> Ptr{MSIFILEHASHINFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiGetFileHashW(
    const uint16_t* szFilePath,
    uint32_t dwOptions,
    void* pHash);
]]
local msi = ffi.load("msi")
-- msi.MsiGetFileHashW(szFilePath, dwOptions, pHash)
-- szFilePath : LPCWSTR
-- dwOptions : DWORD
-- pHash : MSIFILEHASHINFO* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiGetFileHashW = lib.func('__stdcall', 'MsiGetFileHashW', 'uint32_t', ['str16', 'uint32_t', 'void *']);
// MsiGetFileHashW(szFilePath, dwOptions, pHash)
// szFilePath : LPCWSTR -> 'str16'
// dwOptions : DWORD -> 'uint32_t'
// pHash : MSIFILEHASHINFO* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiGetFileHashW: { parameters: ["buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.MsiGetFileHashW(szFilePath, dwOptions, pHash)
// szFilePath : LPCWSTR -> "buffer"
// dwOptions : DWORD -> "u32"
// pHash : MSIFILEHASHINFO* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiGetFileHashW(
    const uint16_t* szFilePath,
    uint32_t dwOptions,
    void* pHash);
C, "msi.dll");
// $ffi->MsiGetFileHashW(szFilePath, dwOptions, pHash);
// szFilePath : LPCWSTR
// dwOptions : DWORD
// pHash : MSIFILEHASHINFO* in/out
// 構造体/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 Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.UNICODE_OPTIONS);
    int MsiGetFileHashW(
        WString szFilePath,   // LPCWSTR
        int dwOptions,   // DWORD
        Pointer pHash   // MSIFILEHASHINFO* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiGetFileHashW = MsiGetFileHashW(
    szFilePath : UInt16*,   # LPCWSTR
    dwOptions : UInt32,   # DWORD
    pHash : MSIFILEHASHINFO*   # MSIFILEHASHINFO* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiGetFileHashWNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Void>);
typedef MsiGetFileHashWDart = int Function(Pointer<Utf16>, int, Pointer<Void>);
final MsiGetFileHashW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiGetFileHashWNative, MsiGetFileHashWDart>('MsiGetFileHashW');
// szFilePath : LPCWSTR -> Pointer<Utf16>
// dwOptions : DWORD -> Uint32
// pHash : MSIFILEHASHINFO* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiGetFileHashW(
  szFilePath: PWideChar;   // LPCWSTR
  dwOptions: DWORD;   // DWORD
  pHash: Pointer   // MSIFILEHASHINFO* in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiGetFileHashW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiGetFileHashW"
  c_MsiGetFileHashW :: CWString -> Word32 -> Ptr () -> IO Word32
-- szFilePath : LPCWSTR -> CWString
-- dwOptions : DWORD -> Word32
-- pHash : MSIFILEHASHINFO* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msigetfilehashw =
  foreign "MsiGetFileHashW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* szFilePath : LPCWSTR -> (ptr uint16_t) *)
(* dwOptions : DWORD -> uint32_t *)
(* pHash : MSIFILEHASHINFO* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiGetFileHashW" msi-get-file-hash-w :convention :stdcall) :uint32
  (sz-file-path (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-options :uint32)   ; DWORD
  (p-hash :pointer))   ; MSIFILEHASHINFO* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiGetFileHashW = Win32::API::More->new('msi',
    'DWORD MsiGetFileHashW(LPCWSTR szFilePath, DWORD dwOptions, LPVOID pHash)');
# my $ret = $MsiGetFileHashW->Call($szFilePath, $dwOptions, $pHash);
# szFilePath : LPCWSTR -> LPCWSTR
# dwOptions : DWORD -> DWORD
# pHash : MSIFILEHASHINFO* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型