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

SymCleanup

関数
プロセスのシンボルハンドラを解放しリソースを後始末する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymCleanup(
    HANDLE hProcess
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡されたプロセスへのハンドル。

戻り値の型: BOOL

公式ドキュメント

プロセスハンドルに関連付けられたすべてのリソースを解放します。

戻り値

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

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

解説(Remarks)

この関数は、プロセスハンドルに関連付けられたすべてのリソースを解放します。この関数を呼び出さないと、呼び出し元アプリケーションでメモリリークおよびリソースリークが発生します。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性が高くなります。これを回避するため、 SymInitialize はプロセスの開始時にのみ呼び出し、 SymCleanup はプロセスの終了時にのみ呼び出してください。プロセス内の各スレッドがこれらの関数を呼び出す必要はありません。

例については、 Terminating 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>

BOOL SymCleanup(
    HANDLE hProcess
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymCleanup(
    IntPtr hProcess   // HANDLE
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymCleanup(
    hProcess As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
Declare PtrSafe Function SymCleanup Lib "dbghelp" ( _
    ByVal hProcess As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('dbghelp.dll')
SymCleanup = Fiddle::Function.new(
  lib['SymCleanup'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymCleanup(
        hProcess: *mut core::ffi::c_void  // HANDLE
    ) -> 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 SymCleanup(IntPtr hProcess);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymCleanup' -Namespace Win32 -PassThru
# $api::SymCleanup(hProcess)
#uselib "dbghelp.dll"
#func global SymCleanup "SymCleanup" sptr
; SymCleanup hProcess   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymCleanup "SymCleanup" sptr
; res = SymCleanup(hProcess)
; hProcess : HANDLE -> "sptr"
; BOOL SymCleanup(HANDLE hProcess)
#uselib "dbghelp.dll"
#cfunc global SymCleanup "SymCleanup" intptr
; res = SymCleanup(hProcess)
; hProcess : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymCleanup = dbghelp.NewProc("SymCleanup")
)

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

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

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

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

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

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

関連項目

公式の関連項目