ホーム › System.Rpc › RpcErrorClearInformation
RpcErrorClearInformation
関数スレッドの拡張エラー情報をすべて消去する。
シグネチャ
// RPCRT4.dll
#include <windows.h>
void RpcErrorClearInformation(void);パラメーターなし。戻り値: void
公式ドキュメント
RpcErrorClearInformation 関数は、現在のスレッド上の拡張エラー情報をすべてクリアします。
戻り値
解説(Remarks)
拡張エラー情報のクリアは、通常は RPC ランタイムが処理します。呼び出し元が RpcErrorClearInformation を使用する必要があるのは、次の 2 つの場合だけです。
- 呼び出し元のコンポーネントが RpcErrorAddRecord 関数を使用してスレッドにレコードを追加した後、致命的なエラーは発生していないと判断して元の処理を続行する場合、または追加したレコードとエラーが関連していない場合。この場合、誤解を招く可能性のあるエラー情報が伝播しないように、呼び出し元のコンポーネントはスレッドからエラー情報をクリアする必要があります。
- 呼び出し元のコンポーネントが、拡張エラー情報を返す操作を複数回再試行する場合。RPC 呼び出しが開始されると、RPC ランタイムはスレッド上の拡張エラー情報をクリアします。ただし、呼び出し元のコンポーネントが RpcErrorAddRecord を反復回数の多いループ内で呼び出す場合は、拡張エラー情報が時間の経過とともに蓄積して利用可能なメモリを使い果たす可能性があるため、エラー情報をクリアすることが望ましい場合があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// RPCRT4.dll
#include <windows.h>
void RpcErrorClearInformation(void);[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern void RpcErrorClearInformation();<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Sub RpcErrorClearInformation()
End SubDeclare PtrSafe Sub RpcErrorClearInformation Lib "rpcrt4" ()
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RpcErrorClearInformation = ctypes.windll.rpcrt4.RpcErrorClearInformation
RpcErrorClearInformation.restype = None
RpcErrorClearInformation.argtypes = []require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('RPCRT4.dll')
RpcErrorClearInformation = Fiddle::Function.new(
lib['RpcErrorClearInformation'],
[],
Fiddle::TYPE_VOID)#[link(name = "rpcrt4")]
extern "system" {
fn RpcErrorClearInformation();
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("RPCRT4.dll")]
public static extern void RpcErrorClearInformation();
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcErrorClearInformation' -Namespace Win32 -PassThru
# $api::RpcErrorClearInformation()#uselib "RPCRT4.dll"
#func global RpcErrorClearInformation "RpcErrorClearInformation"
; RpcErrorClearInformation#uselib "RPCRT4.dll"
#func global RpcErrorClearInformation "RpcErrorClearInformation"
; RpcErrorClearInformation; void RpcErrorClearInformation()
#uselib "RPCRT4.dll"
#func global RpcErrorClearInformation "RpcErrorClearInformation"
; RpcErrorClearInformationimport (
"golang.org/x/sys/windows"
"unsafe"
)
var (
rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
procRpcErrorClearInformation = rpcrt4.NewProc("RpcErrorClearInformation")
)
r1, _, err := procRpcErrorClearInformation.Call()
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // voidprocedure RpcErrorClearInformation; stdcall;
external 'RPCRT4.dll' name 'RpcErrorClearInformation';result := DllCall("RPCRT4\RpcErrorClearInformation", "Int")●RpcErrorClearInformation() = DLL("RPCRT4.dll", "int RpcErrorClearInformation()")
# 呼び出し: RpcErrorClearInformation()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "rpcrt4" fn RpcErrorClearInformation() callconv(std.os.windows.WINAPI) void;proc RpcErrorClearInformation() {.importc: "RpcErrorClearInformation", stdcall, dynlib: "RPCRT4.dll".}pragma(lib, "rpcrt4");
extern(Windows)
void RpcErrorClearInformation();ccall((:RpcErrorClearInformation, "RPCRT4.dll"), stdcall, Cvoid,
(),
)
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
void RpcErrorClearInformation(void);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcErrorClearInformation()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcErrorClearInformation = lib.func('__stdcall', 'RpcErrorClearInformation', 'void', []);
// RpcErrorClearInformation()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("RPCRT4.dll", {
RpcErrorClearInformation: { parameters: [], result: "void" },
});
// lib.symbols.RpcErrorClearInformation()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
void RpcErrorClearInformation(void);
C, "RPCRT4.dll");
// $ffi->RpcErrorClearInformation();
// 構造体/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 Rpcrt4 extends StdCallLibrary {
Rpcrt4 INSTANCE = Native.load("rpcrt4", Rpcrt4.class);
void RpcErrorClearInformation();
}@[Link("rpcrt4")]
lib LibRPCRT4
fun RpcErrorClearInformation = RpcErrorClearInformation() : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RpcErrorClearInformationNative = Void Function();
typedef RpcErrorClearInformationDart = void Function();
final RpcErrorClearInformation = DynamicLibrary.open('RPCRT4.dll')
.lookupFunction<RpcErrorClearInformationNative, RpcErrorClearInformationDart>('RpcErrorClearInformation');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
procedure RpcErrorClearInformation; stdcall;
external 'RPCRT4.dll' name 'RpcErrorClearInformation';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RpcErrorClearInformation"
c_RpcErrorClearInformation :: IO ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rpcerrorclearinformation =
foreign "RpcErrorClearInformation"
(void @-> returning void)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)
(cffi:defcfun ("RpcErrorClearInformation" rpc-error-clear-information :convention :stdcall) :void)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RpcErrorClearInformation = Win32::API::More->new('RPCRT4',
'void RpcErrorClearInformation()');
# my $ret = $RpcErrorClearInformation->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f RpcErrorAddRecord — 拡張エラー情報リストにエラーレコードを追加する。
- f RpcErrorGetNextRecord — エラー列挙から次の拡張エラー情報レコードを取得する。
- f RpcErrorStartEnumeration — 拡張エラー情報レコードの列挙を開始する。