Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › ImageGetDigestStream

ImageGetDigestStream

関数
イメージから署名対象のダイジェストストリームを取得する。
DLLimagehlp.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// imagehlp.dll
#include <windows.h>

BOOL ImageGetDigestStream(
    HANDLE FileHandle,
    DWORD DigestLevel,
    DIGEST_FUNCTION DigestFunction,
    void* DigestHandle
);

パラメーター

名前方向説明
FileHandleHANDLEinイメージ ファイルのハンドルです。このハンドルは FILE_READ_DATA アクセスでオープンされている必要があります。
DigestLevelDWORDin

返されるデータ ストリームに含めるイメージの要素です。このパラメーターには、次の値の 1 つ以上を指定できます。

意味
CERT_PE_IMAGE_DIGEST_ALL_IMPORT_INFO
0x04
すべてのインポート情報を含めます。
CERT_PE_IMAGE_DIGEST_DEBUG_INFO
0x01
シンボリック デバッグ情報を含めます。
CERT_PE_IMAGE_DIGEST_RESOURCES
0x02
リソース情報を含めます。
DigestFunctionDIGEST_FUNCTIONinデータを処理するコールバック ルーチンへのポインターです。詳細については、 DigestFunction を参照してください。
DigestHandlevoid*inユーザーが指定するダイジェストへのハンドルです。このパラメーターは、DigestFunction に最初の引数として渡されます。

戻り値の型: BOOL

公式ドキュメント

指定したイメージ ファイルから要求されたデータを取得します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

ImageGetDigestStream 関数は、渡された DigestLevel パラメーターに従って、指定したイメージ ファイルからダイジェスト対象のデータを返します。バイトの順序は呼び出しごとに一貫しており、これは取得したバイト ストリームから常に同じメッセージ ダイジェストが生成されることを保証するために必要です。

クロスプラットフォームの互換性を確保するため、この関数のすべての実装は、イメージ ファイルの各部分が返される順序に関して一貫した動作をする必要があります。

データは次の順序で返される必要があります。

  1. イメージ(実行可能データおよび静的データ)情報。
  2. リソース データ。
  3. デバッグ情報。
これらのいずれかが指定されていない場合でも、残りの部分は同じ順序で返される必要があります。

この関数を含むすべての ImageHlp 関数はシングル スレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからのこの関数への同時呼び出しをすべて同期する必要があります。

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

各言語での呼び出し定義

// imagehlp.dll
#include <windows.h>

BOOL ImageGetDigestStream(
    HANDLE FileHandle,
    DWORD DigestLevel,
    DIGEST_FUNCTION DigestFunction,
    void* DigestHandle
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ImageGetDigestStream(
    IntPtr FileHandle,   // HANDLE
    uint DigestLevel,   // DWORD
    IntPtr DigestFunction,   // DIGEST_FUNCTION
    IntPtr DigestHandle   // void*
);
<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ImageGetDigestStream(
    FileHandle As IntPtr,   ' HANDLE
    DigestLevel As UInteger,   ' DWORD
    DigestFunction As IntPtr,   ' DIGEST_FUNCTION
    DigestHandle As IntPtr   ' void*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileHandle : HANDLE
' DigestLevel : DWORD
' DigestFunction : DIGEST_FUNCTION
' DigestHandle : void*
Declare PtrSafe Function ImageGetDigestStream Lib "imagehlp" ( _
    ByVal FileHandle As LongPtr, _
    ByVal DigestLevel As Long, _
    ByVal DigestFunction As LongPtr, _
    ByVal DigestHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImageGetDigestStream = ctypes.windll.imagehlp.ImageGetDigestStream
ImageGetDigestStream.restype = wintypes.BOOL
ImageGetDigestStream.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    wintypes.DWORD,  # DigestLevel : DWORD
    ctypes.c_void_p,  # DigestFunction : DIGEST_FUNCTION
    ctypes.POINTER(None),  # DigestHandle : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
ImageGetDigestStream = Fiddle::Function.new(
  lib['ImageGetDigestStream'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    -Fiddle::TYPE_INT,  # DigestLevel : DWORD
    Fiddle::TYPE_VOIDP,  # DigestFunction : DIGEST_FUNCTION
    Fiddle::TYPE_VOIDP,  # DigestHandle : void*
  ],
  Fiddle::TYPE_INT)
#[link(name = "imagehlp")]
extern "system" {
    fn ImageGetDigestStream(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        DigestLevel: u32,  // DWORD
        DigestFunction: *const core::ffi::c_void,  // DIGEST_FUNCTION
        DigestHandle: *mut ()  // void*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern bool ImageGetDigestStream(IntPtr FileHandle, uint DigestLevel, IntPtr DigestFunction, IntPtr DigestHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_ImageGetDigestStream' -Namespace Win32 -PassThru
# $api::ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
#uselib "imagehlp.dll"
#func global ImageGetDigestStream "ImageGetDigestStream" sptr, sptr, sptr, sptr
; ImageGetDigestStream FileHandle, DigestLevel, DigestFunction, DigestHandle   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; DigestLevel : DWORD -> "sptr"
; DigestFunction : DIGEST_FUNCTION -> "sptr"
; DigestHandle : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "imagehlp.dll"
#cfunc global ImageGetDigestStream "ImageGetDigestStream" sptr, int, sptr, sptr
; res = ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
; FileHandle : HANDLE -> "sptr"
; DigestLevel : DWORD -> "int"
; DigestFunction : DIGEST_FUNCTION -> "sptr"
; DigestHandle : void* -> "sptr"
; BOOL ImageGetDigestStream(HANDLE FileHandle, DWORD DigestLevel, DIGEST_FUNCTION DigestFunction, void* DigestHandle)
#uselib "imagehlp.dll"
#cfunc global ImageGetDigestStream "ImageGetDigestStream" intptr, int, intptr, intptr
; res = ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
; FileHandle : HANDLE -> "intptr"
; DigestLevel : DWORD -> "int"
; DigestFunction : DIGEST_FUNCTION -> "intptr"
; DigestHandle : void* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imagehlp = windows.NewLazySystemDLL("imagehlp.dll")
	procImageGetDigestStream = imagehlp.NewProc("ImageGetDigestStream")
)

// FileHandle (HANDLE), DigestLevel (DWORD), DigestFunction (DIGEST_FUNCTION), DigestHandle (void*)
r1, _, err := procImageGetDigestStream.Call(
	uintptr(FileHandle),
	uintptr(DigestLevel),
	uintptr(DigestFunction),
	uintptr(DigestHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ImageGetDigestStream(
  FileHandle: THandle;   // HANDLE
  DigestLevel: DWORD;   // DWORD
  DigestFunction: Pointer;   // DIGEST_FUNCTION
  DigestHandle: Pointer   // void*
): BOOL; stdcall;
  external 'imagehlp.dll' name 'ImageGetDigestStream';
result := DllCall("imagehlp\ImageGetDigestStream"
    , "Ptr", FileHandle   ; HANDLE
    , "UInt", DigestLevel   ; DWORD
    , "Ptr", DigestFunction   ; DIGEST_FUNCTION
    , "Ptr", DigestHandle   ; void*
    , "Int")   ; return: BOOL
●ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle) = DLL("imagehlp.dll", "bool ImageGetDigestStream(void*, dword, void*, void*)")
# 呼び出し: ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
# FileHandle : HANDLE -> "void*"
# DigestLevel : DWORD -> "dword"
# DigestFunction : DIGEST_FUNCTION -> "void*"
# DigestHandle : void* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "imagehlp" fn ImageGetDigestStream(
    FileHandle: ?*anyopaque, // HANDLE
    DigestLevel: u32, // DWORD
    DigestFunction: ?*anyopaque, // DIGEST_FUNCTION
    DigestHandle: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) i32;
proc ImageGetDigestStream(
    FileHandle: pointer,  # HANDLE
    DigestLevel: uint32,  # DWORD
    DigestFunction: pointer,  # DIGEST_FUNCTION
    DigestHandle: pointer  # void*
): int32 {.importc: "ImageGetDigestStream", stdcall, dynlib: "imagehlp.dll".}
pragma(lib, "imagehlp");
extern(Windows)
int ImageGetDigestStream(
    void* FileHandle,   // HANDLE
    uint DigestLevel,   // DWORD
    void* DigestFunction,   // DIGEST_FUNCTION
    void* DigestHandle   // void*
);
ccall((:ImageGetDigestStream, "imagehlp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      FileHandle, DigestLevel, DigestFunction, DigestHandle)
# FileHandle : HANDLE -> Ptr{Cvoid}
# DigestLevel : DWORD -> UInt32
# DigestFunction : DIGEST_FUNCTION -> Ptr{Cvoid}
# DigestHandle : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ImageGetDigestStream(
    void* FileHandle,
    uint32_t DigestLevel,
    void* DigestFunction,
    void* DigestHandle);
]]
local imagehlp = ffi.load("imagehlp")
-- imagehlp.ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
-- FileHandle : HANDLE
-- DigestLevel : DWORD
-- DigestFunction : DIGEST_FUNCTION
-- DigestHandle : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('imagehlp.dll');
const ImageGetDigestStream = lib.func('__stdcall', 'ImageGetDigestStream', 'int32_t', ['void *', 'uint32_t', 'void *', 'void *']);
// ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
// FileHandle : HANDLE -> 'void *'
// DigestLevel : DWORD -> 'uint32_t'
// DigestFunction : DIGEST_FUNCTION -> 'void *'
// DigestHandle : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("imagehlp.dll", {
  ImageGetDigestStream: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle)
// FileHandle : HANDLE -> "pointer"
// DigestLevel : DWORD -> "u32"
// DigestFunction : DIGEST_FUNCTION -> "pointer"
// DigestHandle : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ImageGetDigestStream(
    void* FileHandle,
    uint32_t DigestLevel,
    void* DigestFunction,
    void* DigestHandle);
C, "imagehlp.dll");
// $ffi->ImageGetDigestStream(FileHandle, DigestLevel, DigestFunction, DigestHandle);
// FileHandle : HANDLE
// DigestLevel : DWORD
// DigestFunction : DIGEST_FUNCTION
// DigestHandle : void*
// 構造体/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 Imagehlp extends StdCallLibrary {
    Imagehlp INSTANCE = Native.load("imagehlp", Imagehlp.class);
    boolean ImageGetDigestStream(
        Pointer FileHandle,   // HANDLE
        int DigestLevel,   // DWORD
        Callback DigestFunction,   // DIGEST_FUNCTION
        Pointer DigestHandle   // void*
    );
}
@[Link("imagehlp")]
lib Libimagehlp
  fun ImageGetDigestStream = ImageGetDigestStream(
    FileHandle : Void*,   # HANDLE
    DigestLevel : UInt32,   # DWORD
    DigestFunction : Void*,   # DIGEST_FUNCTION
    DigestHandle : Void*   # void*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ImageGetDigestStreamNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef ImageGetDigestStreamDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final ImageGetDigestStream = DynamicLibrary.open('imagehlp.dll')
    .lookupFunction<ImageGetDigestStreamNative, ImageGetDigestStreamDart>('ImageGetDigestStream');
// FileHandle : HANDLE -> Pointer<Void>
// DigestLevel : DWORD -> Uint32
// DigestFunction : DIGEST_FUNCTION -> Pointer<Void>
// DigestHandle : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImageGetDigestStream(
  FileHandle: THandle;   // HANDLE
  DigestLevel: DWORD;   // DWORD
  DigestFunction: Pointer;   // DIGEST_FUNCTION
  DigestHandle: Pointer   // void*
): BOOL; stdcall;
  external 'imagehlp.dll' name 'ImageGetDigestStream';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImageGetDigestStream"
  c_ImageGetDigestStream :: Ptr () -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- FileHandle : HANDLE -> Ptr ()
-- DigestLevel : DWORD -> Word32
-- DigestFunction : DIGEST_FUNCTION -> Ptr ()
-- DigestHandle : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imagegetdigeststream =
  foreign "ImageGetDigestStream"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* DigestLevel : DWORD -> uint32_t *)
(* DigestFunction : DIGEST_FUNCTION -> (ptr void) *)
(* DigestHandle : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imagehlp (t "imagehlp.dll"))
(cffi:use-foreign-library imagehlp)

(cffi:defcfun ("ImageGetDigestStream" image-get-digest-stream :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (digest-level :uint32)   ; DWORD
  (digest-function :pointer)   ; DIGEST_FUNCTION
  (digest-handle :pointer))   ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImageGetDigestStream = Win32::API::More->new('imagehlp',
    'BOOL ImageGetDigestStream(HANDLE FileHandle, DWORD DigestLevel, LPVOID DigestFunction, LPVOID DigestHandle)');
# my $ret = $ImageGetDigestStream->Call($FileHandle, $DigestLevel, $DigestFunction, $DigestHandle);
# FileHandle : HANDLE -> HANDLE
# DigestLevel : DWORD -> DWORD
# DigestFunction : DIGEST_FUNCTION -> LPVOID
# DigestHandle : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型