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

SymGetOptions

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

シグネチャ

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

DWORD SymGetOptions(void);

パラメーターなし。戻り値: DWORD

公式ドキュメント

現在のオプションマスクを取得します。

戻り値

この関数は、現在設定されているオプションを返します。0 は有効な値であり、すべてのオプションがオフになっていることを示します。

解説(Remarks)

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

戻り値は、SymSetOptions 関数を使用して設定された次の値の組み合わせです。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損を引き起こす可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

SymGetOptions = ctypes.windll.dbghelp.SymGetOptions
SymGetOptions.restype = wintypes.DWORD
SymGetOptions.argtypes = []
require 'fiddle'
require 'fiddle/import'

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetOptions = dbghelp.NewProc("SymGetOptions")
)

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

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

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

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

let symgetoptions =
  foreign "SymGetOptions"
    (void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymGetOptions" sym-get-options :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetOptions = Win32::API::More->new('dbghelp',
    'DWORD SymGetOptions()');
# my $ret = $SymGetOptions->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。