ホーム › System.Diagnostics.Debug › SymGetOmaps

SymGetOmaps

関数

モジュールの最適化アドレスマップ情報を取得する。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymGetOmaps(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    OMAP** OmapTo,
    ULONGLONG* cOmapTo,
    OMAP** OmapFrom,
    ULONGLONG* cOmapFrom
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseOfDll	ULONGLONG	in	モジュールのベースアドレス。
OmapTo	OMAP**	out	元のレイアウトから取得した、新しいイメージレイアウトへのアドレスマップエントリの配列。マップエントリの詳細については、OMAP 構造体を参照してください。
cOmapTo	ULONGLONG*	out	OmapTo 配列内のエントリ数。
OmapFrom	OMAP**	out	新しいイメージレイアウトから(デバッグシンボルで記述される)元のレイアウトへのアドレスマップエントリの配列。マップエントリの詳細については、OMAP 構造体を参照してください。
cOmapFrom	ULONGLONG*	out	OmapFrom 配列内のエントリ数。

戻り値の型: BOOL

公式ドキュメント

ロード済みモジュール内の omap テーブルを取得します。

戻り値

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

関数が失敗した場合(omap が見つからない場合)、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

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

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

各言語での呼び出し定義

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

BOOL SymGetOmaps(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    OMAP** OmapTo,
    ULONGLONG* cOmapTo,
    OMAP** OmapFrom,
    ULONGLONG* cOmapFrom
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymGetOmaps(
    IntPtr hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    IntPtr OmapTo,   // OMAP** out
    out ulong cOmapTo,   // ULONGLONG* out
    IntPtr OmapFrom,   // OMAP** out
    out ulong cOmapFrom   // ULONGLONG* out
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetOmaps(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As ULong,   ' ULONGLONG
    OmapTo As IntPtr,   ' OMAP** out
    <Out> ByRef cOmapTo As ULong,   ' ULONGLONG* out
    OmapFrom As IntPtr,   ' OMAP** out
    <Out> ByRef cOmapFrom As ULong   ' ULONGLONG* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' OmapTo : OMAP** out
' cOmapTo : ULONGLONG* out
' OmapFrom : OMAP** out
' cOmapFrom : ULONGLONG* out
Declare PtrSafe Function SymGetOmaps Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal OmapTo As LongPtr, _
    ByRef cOmapTo As LongLong, _
    ByVal OmapFrom As LongPtr, _
    ByRef cOmapFrom As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetOmaps = ctypes.windll.dbghelp.SymGetOmaps
SymGetOmaps.restype = wintypes.BOOL
SymGetOmaps.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    ctypes.c_void_p,  # OmapTo : OMAP** out
    ctypes.POINTER(ctypes.c_ulonglong),  # cOmapTo : ULONGLONG* out
    ctypes.c_void_p,  # OmapFrom : OMAP** out
    ctypes.POINTER(ctypes.c_ulonglong),  # cOmapFrom : ULONGLONG* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetOmaps = Fiddle::Function.new(
  lib['SymGetOmaps'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    Fiddle::TYPE_VOIDP,  # OmapTo : OMAP** out
    Fiddle::TYPE_VOIDP,  # cOmapTo : ULONGLONG* out
    Fiddle::TYPE_VOIDP,  # OmapFrom : OMAP** out
    Fiddle::TYPE_VOIDP,  # cOmapFrom : ULONGLONG* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetOmaps(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        OmapTo: *mut *mut OMAP,  // OMAP** out
        cOmapTo: *mut u64,  // ULONGLONG* out
        OmapFrom: *mut *mut OMAP,  // OMAP** out
        cOmapFrom: *mut u64  // ULONGLONG* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern bool SymGetOmaps(IntPtr hProcess, ulong BaseOfDll, IntPtr OmapTo, out ulong cOmapTo, IntPtr OmapFrom, out ulong cOmapFrom);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetOmaps' -Namespace Win32 -PassThru
# $api::SymGetOmaps(hProcess, BaseOfDll, OmapTo, cOmapTo, OmapFrom, cOmapFrom)

#uselib "dbghelp.dll"
#func global SymGetOmaps "SymGetOmaps" sptr, sptr, sptr, sptr, sptr, sptr
; SymGetOmaps hProcess, BaseOfDll, varptr(OmapTo), varptr(cOmapTo), varptr(OmapFrom), varptr(cOmapFrom)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "sptr"
; OmapTo : OMAP** out -> "sptr"
; cOmapTo : ULONGLONG* out -> "sptr"
; OmapFrom : OMAP** out -> "sptr"
; cOmapFrom : ULONGLONG* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymGetOmaps "SymGetOmaps" sptr, int64, var, var, var, var
; res = SymGetOmaps(hProcess, BaseOfDll, OmapTo, cOmapTo, OmapFrom, cOmapFrom)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "int64"
; OmapTo : OMAP** out -> "var"
; cOmapTo : ULONGLONG* out -> "var"
; OmapFrom : OMAP** out -> "var"
; cOmapFrom : ULONGLONG* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "dbghelp.dll"
#cfunc global SymGetOmaps "SymGetOmaps" sptr, int64, sptr, sptr, sptr, sptr
; res = SymGetOmaps(hProcess, BaseOfDll, varptr(OmapTo), varptr(cOmapTo), varptr(OmapFrom), varptr(cOmapFrom))
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "int64"
; OmapTo : OMAP** out -> "sptr"
; cOmapTo : ULONGLONG* out -> "sptr"
; OmapFrom : OMAP** out -> "sptr"
; cOmapFrom : ULONGLONG* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。