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

GetImageUnusedHeaderBytes

関数
PEイメージヘッダーの未使用バイト数とオフセットを取得する。
DLLimagehlp.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetImageUnusedHeaderBytes(
    LOADED_IMAGE* LoadedImage,
    DWORD* SizeUnusedHeaderBytes
);

パラメーター

名前方向説明
LoadedImageLOADED_IMAGE*inMapAndLoad または ImageLoad の呼び出しから返された LOADED_IMAGE 構造体へのポインターです。
SizeUnusedHeaderBytesDWORD*outイメージのヘッダーのうち未使用部分のサイズ(バイト単位)を受け取る変数へのポインターです。

戻り値の型: DWORD

公式ドキュメント

PE ヘッダーのうち、現在使用されていない部分のオフセットとサイズを取得します。

戻り値

関数が成功した場合、戻り値は最初の未使用ヘッダーバイトのベースアドレスからのオフセットです。

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

解説(Remarks)

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

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

各言語での呼び出し定義

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

DWORD GetImageUnusedHeaderBytes(
    LOADED_IMAGE* LoadedImage,
    DWORD* SizeUnusedHeaderBytes
);
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern uint GetImageUnusedHeaderBytes(
    IntPtr LoadedImage,   // LOADED_IMAGE*
    out uint SizeUnusedHeaderBytes   // DWORD* out
);
<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetImageUnusedHeaderBytes(
    LoadedImage As IntPtr,   ' LOADED_IMAGE*
    <Out> ByRef SizeUnusedHeaderBytes As UInteger   ' DWORD* out
) As UInteger
End Function
' LoadedImage : LOADED_IMAGE*
' SizeUnusedHeaderBytes : DWORD* out
Declare PtrSafe Function GetImageUnusedHeaderBytes Lib "imagehlp" ( _
    ByVal LoadedImage As LongPtr, _
    ByRef SizeUnusedHeaderBytes As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetImageUnusedHeaderBytes = ctypes.windll.imagehlp.GetImageUnusedHeaderBytes
GetImageUnusedHeaderBytes.restype = wintypes.DWORD
GetImageUnusedHeaderBytes.argtypes = [
    ctypes.c_void_p,  # LoadedImage : LOADED_IMAGE*
    ctypes.POINTER(wintypes.DWORD),  # SizeUnusedHeaderBytes : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('imagehlp.dll')
GetImageUnusedHeaderBytes = Fiddle::Function.new(
  lib['GetImageUnusedHeaderBytes'],
  [
    Fiddle::TYPE_VOIDP,  # LoadedImage : LOADED_IMAGE*
    Fiddle::TYPE_VOIDP,  # SizeUnusedHeaderBytes : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "imagehlp")]
extern "system" {
    fn GetImageUnusedHeaderBytes(
        LoadedImage: *mut LOADED_IMAGE,  // LOADED_IMAGE*
        SizeUnusedHeaderBytes: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("imagehlp.dll", SetLastError = true)]
public static extern uint GetImageUnusedHeaderBytes(IntPtr LoadedImage, out uint SizeUnusedHeaderBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'imagehlp_GetImageUnusedHeaderBytes' -Namespace Win32 -PassThru
# $api::GetImageUnusedHeaderBytes(LoadedImage, SizeUnusedHeaderBytes)
#uselib "imagehlp.dll"
#func global GetImageUnusedHeaderBytes "GetImageUnusedHeaderBytes" sptr, sptr
; GetImageUnusedHeaderBytes varptr(LoadedImage), varptr(SizeUnusedHeaderBytes)   ; 戻り値は stat
; LoadedImage : LOADED_IMAGE* -> "sptr"
; SizeUnusedHeaderBytes : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "imagehlp.dll"
#cfunc global GetImageUnusedHeaderBytes "GetImageUnusedHeaderBytes" var, var
; res = GetImageUnusedHeaderBytes(LoadedImage, SizeUnusedHeaderBytes)
; LoadedImage : LOADED_IMAGE* -> "var"
; SizeUnusedHeaderBytes : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetImageUnusedHeaderBytes(LOADED_IMAGE* LoadedImage, DWORD* SizeUnusedHeaderBytes)
#uselib "imagehlp.dll"
#cfunc global GetImageUnusedHeaderBytes "GetImageUnusedHeaderBytes" var, var
; res = GetImageUnusedHeaderBytes(LoadedImage, SizeUnusedHeaderBytes)
; LoadedImage : LOADED_IMAGE* -> "var"
; SizeUnusedHeaderBytes : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	imagehlp = windows.NewLazySystemDLL("imagehlp.dll")
	procGetImageUnusedHeaderBytes = imagehlp.NewProc("GetImageUnusedHeaderBytes")
)

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

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

typedef GetImageUnusedHeaderBytesNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetImageUnusedHeaderBytesDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetImageUnusedHeaderBytes = DynamicLibrary.open('imagehlp.dll')
    .lookupFunction<GetImageUnusedHeaderBytesNative, GetImageUnusedHeaderBytesDart>('GetImageUnusedHeaderBytes');
// LoadedImage : LOADED_IMAGE* -> Pointer<Void>
// SizeUnusedHeaderBytes : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetImageUnusedHeaderBytes(
  LoadedImage: Pointer;   // LOADED_IMAGE*
  SizeUnusedHeaderBytes: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'imagehlp.dll' name 'GetImageUnusedHeaderBytes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetImageUnusedHeaderBytes"
  c_GetImageUnusedHeaderBytes :: Ptr () -> Ptr Word32 -> IO Word32
-- LoadedImage : LOADED_IMAGE* -> Ptr ()
-- SizeUnusedHeaderBytes : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getimageunusedheaderbytes =
  foreign "GetImageUnusedHeaderBytes"
    ((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* LoadedImage : LOADED_IMAGE* -> (ptr void) *)
(* SizeUnusedHeaderBytes : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imagehlp (t "imagehlp.dll"))
(cffi:use-foreign-library imagehlp)

(cffi:defcfun ("GetImageUnusedHeaderBytes" get-image-unused-header-bytes :convention :stdcall) :uint32
  (loaded-image :pointer)   ; LOADED_IMAGE*
  (size-unused-header-bytes :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetImageUnusedHeaderBytes = Win32::API::More->new('imagehlp',
    'DWORD GetImageUnusedHeaderBytes(LPVOID LoadedImage, LPVOID SizeUnusedHeaderBytes)');
# my $ret = $GetImageUnusedHeaderBytes->Call($LoadedImage, $SizeUnusedHeaderBytes);
# LoadedImage : LOADED_IMAGE* -> LPVOID
# SizeUnusedHeaderBytes : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型