ホーム › System.ApplicationInstallationAndServicing › MsiGetFileHashA

MsiGetFileHashA

関数

指定ファイルのハッシュ値を計算して取得する。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiGetFileHashA(
    LPCSTR szFilePath,
    DWORD dwOptions,
    MSIFILEHASHINFO* pHash
);

パラメーター

名前	型	方向	説明
szFilePath	LPCSTR	in	ハッシュ化するファイルへのパス。
dwOptions	DWORD	in	この列の値は 0 でなければなりません。このパラメーターは将来使用するために予約されています。
pHash	MSIFILEHASHINFO*	inout	返されるファイルハッシュ情報へのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

値	意味
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 ヘッダーは MsiGetFileHash をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「関数プロトタイプの規約」を参照してください。

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

各言語での呼び出し定義

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

DWORD MsiGetFileHashA(
    LPCSTR szFilePath,
    DWORD dwOptions,
    MSIFILEHASHINFO* pHash
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiGetFileHashA(
    [MarshalAs(UnmanagedType.LPStr)] string szFilePath,   // LPCSTR
    uint dwOptions,   // DWORD
    IntPtr pHash   // MSIFILEHASHINFO* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiGetFileHashA(
    <MarshalAs(UnmanagedType.LPStr)> szFilePath As String,   ' LPCSTR
    dwOptions As UInteger,   ' DWORD
    pHash As IntPtr   ' MSIFILEHASHINFO* in/out
) As UInteger
End Function

' szFilePath : LPCSTR
' dwOptions : DWORD
' pHash : MSIFILEHASHINFO* in/out
Declare PtrSafe Function MsiGetFileHashA Lib "msi" ( _
    ByVal szFilePath As String, _
    ByVal dwOptions As Long, _
    ByVal pHash As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiGetFileHashA = ctypes.windll.msi.MsiGetFileHashA
MsiGetFileHashA.restype = wintypes.DWORD
MsiGetFileHashA.argtypes = [
    wintypes.LPCSTR,  # szFilePath : LPCSTR
    wintypes.DWORD,  # dwOptions : DWORD
    ctypes.c_void_p,  # pHash : MSIFILEHASHINFO* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetFileHashA = Fiddle::Function.new(
  lib['MsiGetFileHashA'],
  [
    Fiddle::TYPE_VOIDP,  # szFilePath : LPCSTR
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
    Fiddle::TYPE_VOIDP,  # pHash : MSIFILEHASHINFO* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiGetFileHashA(
        szFilePath: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint MsiGetFileHashA([MarshalAs(UnmanagedType.LPStr)] string szFilePath, uint dwOptions, IntPtr pHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetFileHashA' -Namespace Win32 -PassThru
# $api::MsiGetFileHashA(szFilePath, dwOptions, pHash)

#uselib "msi.dll"
#func global MsiGetFileHashA "MsiGetFileHashA" sptr, sptr, sptr
; MsiGetFileHashA szFilePath, dwOptions, varptr(pHash)   ; 戻り値は stat
; szFilePath : LPCSTR -> "sptr"
; dwOptions : DWORD -> "sptr"
; pHash : MSIFILEHASHINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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