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

SymSetScopeFromIndex

関数
シンボルインデックスから探索スコープを設定する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymSetScopeFromIndex(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    DWORD Index
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseOfDllULONGLONGinモジュールのベースアドレス。
IndexDWORDinシンボルの一意の値。

戻り値の型: BOOL

公式ドキュメント

指定したインデックスに一致するシンボルにローカルスコープを設定します。

戻り値

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

関数が失敗した場合、戻り値は 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 SymSetScopeFromIndex(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    DWORD Index
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymSetScopeFromIndex(
    IntPtr hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    uint Index   // DWORD
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymSetScopeFromIndex(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As ULong,   ' ULONGLONG
    Index As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' Index : DWORD
Declare PtrSafe Function SymSetScopeFromIndex Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal Index As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymSetScopeFromIndex = ctypes.windll.dbghelp.SymSetScopeFromIndex
SymSetScopeFromIndex.restype = wintypes.BOOL
SymSetScopeFromIndex.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    wintypes.DWORD,  # Index : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymSetScopeFromIndex = Fiddle::Function.new(
  lib['SymSetScopeFromIndex'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    -Fiddle::TYPE_INT,  # Index : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymSetScopeFromIndex(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        Index: u32  // DWORD
    ) -> 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 SymSetScopeFromIndex(IntPtr hProcess, ulong BaseOfDll, uint Index);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSetScopeFromIndex' -Namespace Win32 -PassThru
# $api::SymSetScopeFromIndex(hProcess, BaseOfDll, Index)
#uselib "dbghelp.dll"
#func global SymSetScopeFromIndex "SymSetScopeFromIndex" sptr, sptr, sptr
; SymSetScopeFromIndex hProcess, BaseOfDll, Index   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "sptr"
; Index : DWORD -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymSetScopeFromIndex "SymSetScopeFromIndex" sptr, int64, int
; res = SymSetScopeFromIndex(hProcess, BaseOfDll, Index)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "int64"
; Index : DWORD -> "int"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BOOL SymSetScopeFromIndex(HANDLE hProcess, ULONGLONG BaseOfDll, DWORD Index)
#uselib "dbghelp.dll"
#cfunc global SymSetScopeFromIndex "SymSetScopeFromIndex" intptr, int64, int
; res = SymSetScopeFromIndex(hProcess, BaseOfDll, Index)
; hProcess : HANDLE -> "intptr"
; BaseOfDll : ULONGLONG -> "int64"
; Index : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSetScopeFromIndex = dbghelp.NewProc("SymSetScopeFromIndex")
)

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

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

typedef SymSetScopeFromIndexNative = Int32 Function(Pointer<Void>, Uint64, Uint32);
typedef SymSetScopeFromIndexDart = int Function(Pointer<Void>, int, int);
final SymSetScopeFromIndex = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSetScopeFromIndexNative, SymSetScopeFromIndexDart>('SymSetScopeFromIndex');
// hProcess : HANDLE -> Pointer<Void>
// BaseOfDll : ULONGLONG -> Uint64
// Index : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSetScopeFromIndex(
  hProcess: THandle;   // HANDLE
  BaseOfDll: UInt64;   // ULONGLONG
  Index: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymSetScopeFromIndex';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymSetScopeFromIndex"
  c_SymSetScopeFromIndex :: Ptr () -> Word64 -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- BaseOfDll : ULONGLONG -> Word64
-- Index : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symsetscopefromindex =
  foreign "SymSetScopeFromIndex"
    ((ptr void) @-> uint64_t @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* BaseOfDll : ULONGLONG -> uint64_t *)
(* Index : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymSetScopeFromIndex" sym-set-scope-from-index :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base-of-dll :uint64)   ; ULONGLONG
  (index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSetScopeFromIndex = Win32::API::More->new('dbghelp',
    'BOOL SymSetScopeFromIndex(HANDLE hProcess, UINT64 BaseOfDll, DWORD Index)');
# my $ret = $SymSetScopeFromIndex->Call($hProcess, $BaseOfDll, $Index);
# hProcess : HANDLE -> HANDLE
# BaseOfDll : ULONGLONG -> UINT64
# Index : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目