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

SymSetOptions

関数
シンボルハンドラの動作オプションを設定する。
DLLdbghelp.dll呼出規約winapi

シグネチャ

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

DWORD SymSetOptions(
    DWORD SymOptions
);

パラメーター

名前方向説明
SymOptionsDWORDin

シンボルオプション。0 は有効な値であり、すべてのオプションがオフであることを示します。オプション値は OR 演算子で結合して有効なオプション値を作成します。次の値が有効です。

意味
SYMOPT_ALLOW_ABSOLUTE_SYMBOLS
0x00000800
絶対アドレスで格納されているシンボルの使用を有効にします。ほとんどのシンボルはモジュールのベースからの RVA として格納されます。DbgHelp はそれらを絶対アドレスに変換します。絶対アドレスとして格納されるシンボルもあります。これらは非常に特殊な目的を持ち、通常は使用されません。

DbgHelp 5.1 以前: この値はサポートされていません。

SYMOPT_ALLOW_ZERO_ADDRESS
0x01000000
アドレスを持たないシンボルの使用を有効にします。既定では、DbgHelp はアドレスを持たないシンボルを除外します。
SYMOPT_AUTO_PUBLICS
0x00010000
アドレスでシンボルを検索する場合、またはシンボルを列挙する場合に、グローバルシンボルや現在のスコープ内で見つからない場合を除き、パブリックシンボルを検索しません。このオプションは SYMOPT_PUBLICS_ONLY とともに使用しても効果がありません。

DbgHelp 5.1 以前: この値はサポートされていません。

SYMOPT_CASE_INSENSITIVE
0x00000001
すべてのシンボル検索で大文字と小文字を区別しません。
SYMOPT_DEBUG
0x80000000
デバッグ出力を OutputDebugString または SymRegisterCallbackProc64 コールバック関数を通じて渡します。
SYMOPT_DEFERRED_LOADS
0x00000004
シンボルの読み込みが必要となる参照が行われるまで、シンボルは読み込まれません。これはシンボルハンドラーを使用する最も高速で効率的な方法です。
SYMOPT_DISABLE_SYMSRV_AUTODETECT
0x02000000
"SRV*" 指定がない場合でも、シンボルパス内のシンボルサーバーストアの自動検出を無効にし、以前の動作との互換性を維持します。

DbgHelp 6.6 以前: この値はサポートされていません。

SYMOPT_EXACT_SYMBOLS
0x00000400
一致しない .pdb ファイルを読み込みません。他のすべてが失敗した場合でも、エクスポートシンボルを読み込みません。
SYMOPT_FAIL_CRITICAL_ERRORS
0x00000200
ドライブにメディアがないなどのメディア障害が発生した場合に、システムダイアログボックスを表示しません。代わりに、障害は通知なしに発生します。
SYMOPT_FAVOR_COMPRESSED
0x00800000
非圧縮ファイルと圧縮ファイルの両方が利用可能な場合に、圧縮ファイルを優先します。このオプションは低速な接続に適しています。
SYMOPT_FLAT_DIRECTORY
0x00400000
シンボルは既定のダウンストリームストアのルートディレクトリに格納されます。

DbgHelp 6.1 以前: この値はサポートされていません。

SYMOPT_IGNORE_CVREC
0x00000080
.pdb ファイルを読み込む際に、イメージヘッダーの CodeView レコード内のパス情報を無視します。
SYMOPT_IGNORE_IMAGEDIR
0x00200000
イメージディレクトリを無視します。

DbgHelp 6.1 以前: この値はサポートされていません。

SYMOPT_IGNORE_NT_SYMPATH
0x00001000
ユーザーが有効なパスを指定せずに SymSetSearchPath を呼び出した場合に、_NT_SYMBOL_PATH で指定されたパスを使用しません。

DbgHelp 5.1: この値はサポートされていません。

SYMOPT_INCLUDE_32BIT_MODULES
0x00002000
64 ビット Windows でデバッグする際に、すべての 32 ビットモジュールを含めます。
SYMOPT_LOAD_ANYTHING
0x00000040
ファイル (.exe、.dbg、または .pdb) が正しいファイルであることを確認するチェックを無効にします。代わりに、最初に見つかったファイルを読み込みます。
SYMOPT_LOAD_LINES
0x00000010
行番号情報を読み込みます。
SYMOPT_NO_CPP
0x00000008
シンボル区切り文字 "::" を含むすべての C++ 修飾シンボルが "__" に置き換えられます。このオプションは、実際の C++ シンボル名の解析を扱えないデバッガーのために存在します。
SYMOPT_NO_IMAGE_SEARCH
0x00020000
モジュールヘッダーを読み取れない場合に、モジュールのシンボルを読み込む際にシンボルパスを求めてイメージを検索しません。

DbgHelp 5.1: この値はサポートされていません。

SYMOPT_NO_PROMPTS
0x00080000
シンボルサーバーからの検証のプロンプト表示を防ぎます。
SYMOPT_NO_PUBLICS
0x00008000
シンボルを求めてパブリックテーブルを検索しません。パブリックシンボルのコピーがグローバルテーブルに存在するため、このオプションはほとんど効果がないはずです。

DbgHelp 5.1: この値はサポートされていません。

SYMOPT_NO_UNQUALIFIED_LOADS
0x00000100
呼び出し元が複数のモジュールにまたがってシンボルを調べる際に、シンボルが読み込まれるのを防ぎます。すでにシンボルが読み込まれているモジュールのみを調べます。
SYMOPT_OVERWRITE
0x00100000
シンボルストアからダウンレベルストアを上書きします。

DbgHelp 6.1 以前: この値はサポートされていません。

SYMOPT_PUBLICS_ONLY
0x00004000
プライベートシンボルを使用しません。以前の Windows リリースに同梱された DbgHelp のバージョンはパブリックシンボルのみをサポートしていました。このオプションはこの制限との互換性を提供します。

DbgHelp 5.1: この値はサポートされていません。

SYMOPT_SECURE
0x00040000
DbgHelp は SymSrv 以外のシンボルサーバーを読み込みません。SymSrv は _NT_SYMBOL_PATH で指定されたダウンストリームストアを使用しません。このフラグを設定した後は、クリアできません。

DbgHelp 6.0 および 6.1: このフラグはクリアできます。

DbgHelp 5.1: この値はサポートされていません。

SYMOPT_UNDNAME
0x00000002
すべてのシンボルが非修飾形式で提示されます。

グローバルシンボルやローカルシンボルは非修飾で格納されているため、このオプションは効果がありません。このオプションはパブリックシンボルにのみ適用されます。

戻り値の型: DWORD

公式ドキュメント

オプションマスクを設定します。

戻り値

この関数は現在のオプションマスクを返します。

解説(Remarks)

オプション値は、アプリケーションによってライブラリが使用されている間に何度でも変更できます。オプションの変更は、シンボルハンドラーへの以降のすべての呼び出しに影響します。

現在のオプションマスクを取得するには、 SymGetOptions 関数を呼び出します。

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

例については、 Initializing the Symbol Handler を参照してください。

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

各言語での呼び出し定義

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

DWORD SymSetOptions(
    DWORD SymOptions
);
[DllImport("dbghelp.dll", ExactSpelling = true)]
static extern uint SymSetOptions(
    uint SymOptions   // DWORD
);
<DllImport("dbghelp.dll", ExactSpelling:=True)>
Public Shared Function SymSetOptions(
    SymOptions As UInteger   ' DWORD
) As UInteger
End Function
' SymOptions : DWORD
Declare PtrSafe Function SymSetOptions Lib "dbghelp" ( _
    ByVal SymOptions As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymSetOptions = ctypes.windll.dbghelp.SymSetOptions
SymSetOptions.restype = wintypes.DWORD
SymSetOptions.argtypes = [
    wintypes.DWORD,  # SymOptions : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymSetOptions = Fiddle::Function.new(
  lib['SymSetOptions'],
  [
    -Fiddle::TYPE_INT,  # SymOptions : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymSetOptions(
        SymOptions: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll")]
public static extern uint SymSetOptions(uint SymOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymSetOptions' -Namespace Win32 -PassThru
# $api::SymSetOptions(SymOptions)
#uselib "dbghelp.dll"
#func global SymSetOptions "SymSetOptions" sptr
; SymSetOptions SymOptions   ; 戻り値は stat
; SymOptions : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymSetOptions "SymSetOptions" int
; res = SymSetOptions(SymOptions)
; SymOptions : DWORD -> "int"
; DWORD SymSetOptions(DWORD SymOptions)
#uselib "dbghelp.dll"
#cfunc global SymSetOptions "SymSetOptions" int
; res = SymSetOptions(SymOptions)
; SymOptions : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymSetOptions = dbghelp.NewProc("SymSetOptions")
)

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

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

typedef SymSetOptionsNative = Uint32 Function(Uint32);
typedef SymSetOptionsDart = int Function(int);
final SymSetOptions = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymSetOptionsNative, SymSetOptionsDart>('SymSetOptions');
// SymOptions : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymSetOptions(
  SymOptions: DWORD   // DWORD
): DWORD; stdcall;
  external 'dbghelp.dll' name 'SymSetOptions';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymSetOptions"
  c_SymSetOptions :: Word32 -> IO Word32
-- SymOptions : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symsetoptions =
  foreign "SymSetOptions"
    (uint32_t @-> returning uint32_t)
(* SymOptions : 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 ("SymSetOptions" sym-set-options :convention :stdcall) :uint32
  (sym-options :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymSetOptions = Win32::API::More->new('dbghelp',
    'DWORD SymSetOptions(DWORD SymOptions)');
# my $ret = $SymSetOptions->Call($SymOptions);
# SymOptions : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目