RpcErrorAddRecord

関数

拡張エラー情報リストにエラーレコードを追加する。

DLLRPCRT4.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

RPC_STATUS RpcErrorAddRecord(
    RPC_EXTENDED_ERROR_INFO* ErrorInfo
);

パラメーター

名前	型	方向	説明
ErrorInfo	RPC_EXTENDED_ERROR_INFO*	in	追加するエラー情報。 RPC_EXTENDED_ERROR_INFO 構造体の形式で指定します。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcErrorAddRecord 関数は、拡張エラー情報レコードのチェーンに拡張エラー情報を追加します。

戻り値

正常に完了した場合は RPC_S_OK を返します。

メモ有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

RpcErrorAddRecord 関数を使用すると、RPC ランタイム以外のアプリケーションやサーバーが、拡張エラー情報レコードのチェーンに拡張エラー情報を追加できます。

ErrorInfo が指す文字列の管理責任は呼び出し元にあります。RpcErrorAddRecord 関数は、必要に応じてそれらの文字列のコピーを作成します。ErrorInfo のメンバーについては、次の制約を守る必要があります。

Version には、RPC_EEINFO_VERSION などの有効なバージョンを設定する必要があります。

ComputerName には NULL を設定する必要があります。それ以外の値を指定すると ERROR_INVALID_PARAMETER になります。

ProcessID には 0 を設定する必要があります。それ以外の値を指定すると ERROR_INVALID_PARAMETER になります。

SystemTime と FileTime は入力時には無視され、RPC ランタイムによって設定されます。

GeneratingComponent には 0 を設定する必要があります。それ以外の値を指定すると ERROR_INVALID_PARAMETER になります。RPC ランタイムは、このメンバーを EEInfoGCApplication に設定します。

Status には、呼び出し元がチェーンに追加したいエラーコードを設定できます。

DetectionLocation には 0 を設定する必要があります。それ以外の値を指定すると ERROR_INVALID_PARAMETER になります。

NumberOfParameters は、Parameters 配列に含まれるパラメーターの数を示します。この値は 0 以上 MaxNumberOfEEInfoParams 以下である必要があります。RPC ランタイムは、指定された数を超える位置のメモリを使用しないため、呼び出し元は MaxNumberOfEEInfoParams 未満のパラメーター分だけメモリを割り当てても安全です。

Parameters は、拡張エラー情報レコードのパラメーターを表します。Parameters に関する唯一の制約は、ポインターを表すために Pval を使用し、これが常に 64 ビットであることです。使用しているシステムが 32 ビットか 64 ビットかにかかわらず、Pval を使用してください。Lval は使用しないでください。

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

各言語での呼び出し定義

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

RPC_STATUS RpcErrorAddRecord(
    RPC_EXTENDED_ERROR_INFO* ErrorInfo
);

[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcErrorAddRecord(
    IntPtr ErrorInfo   // RPC_EXTENDED_ERROR_INFO*
);

<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcErrorAddRecord(
    ErrorInfo As IntPtr   ' RPC_EXTENDED_ERROR_INFO*
) As Integer
End Function

' ErrorInfo : RPC_EXTENDED_ERROR_INFO*
Declare PtrSafe Function RpcErrorAddRecord Lib "rpcrt4" ( _
    ByVal ErrorInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcErrorAddRecord = ctypes.windll.rpcrt4.RpcErrorAddRecord
RpcErrorAddRecord.restype = ctypes.c_int
RpcErrorAddRecord.argtypes = [
    ctypes.c_void_p,  # ErrorInfo : RPC_EXTENDED_ERROR_INFO*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcErrorAddRecord = Fiddle::Function.new(
  lib['RpcErrorAddRecord'],
  [
    Fiddle::TYPE_VOIDP,  # ErrorInfo : RPC_EXTENDED_ERROR_INFO*
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcErrorAddRecord(
        ErrorInfo: *mut RPC_EXTENDED_ERROR_INFO  // RPC_EXTENDED_ERROR_INFO*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll")]
public static extern int RpcErrorAddRecord(IntPtr ErrorInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcErrorAddRecord' -Namespace Win32 -PassThru
# $api::RpcErrorAddRecord(ErrorInfo)

#uselib "RPCRT4.dll"
#func global RpcErrorAddRecord "RpcErrorAddRecord" sptr
; RpcErrorAddRecord varptr(ErrorInfo)   ; 戻り値は stat
; ErrorInfo : RPC_EXTENDED_ERROR_INFO* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcErrorAddRecord "RpcErrorAddRecord" var
; res = RpcErrorAddRecord(ErrorInfo)
; ErrorInfo : RPC_EXTENDED_ERROR_INFO* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcErrorAddRecord "RpcErrorAddRecord" sptr
; res = RpcErrorAddRecord(varptr(ErrorInfo))
; ErrorInfo : RPC_EXTENDED_ERROR_INFO* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。