PSHED_PI_FINALIZE_ERROR_RECORD コールバック関数 (ntddk.h)

[アーティクル]
04/21/2023

PSHED プラグインの FinalizeErrorRecord コールバック関数は、エラー状態をより詳しく説明する補足エラーレコードセクションをエラーレコードに追加します。

構文

PSHED_PI_FINALIZE_ERROR_RECORD PshedPiFinalizeErrorRecord;

NTSTATUS PshedPiFinalizeErrorRecord(
  [in, out, optional] PVOID PluginContext,
  [in]                PWHEA_ERROR_SOURCE_DESCRIPTOR ErrorSource,
  [in]                ULONG BufferLength,
  [in, out]           PWHEA_ERROR_RECORD ErrorRecord
)
{...}

パラメーター

[in, out, optional] PluginContext

PSHED プラグインが PSHED に登録するために PshedRegisterPlugin 関数を呼び出したときに、WHEA_PSHED_PLUGIN_REGISTRATION_PACKET構造体の Context メンバーで指定されたコンテキスト領域へのポインター。

[in] ErrorSource

ハードウェアエラーを報告したエラーソースを記述する WHEA_ERROR_SOURCE_DESCRIPTOR 構造体へのポインター。

[in] BufferLength

ErrorRecord パラメーターが指すバッファーのサイズ (バイト単位)。

[in, out] ErrorRecord

補足エラーレコード セクションで更新 されるエラーレコードを記述するWHEA_ERROR_RECORD構造体へのポインター。

戻り値

PSHED プラグインの FinalizeErrorRecord コールバック関数は、次のいずれかの NTSTATUS コードを返します。

リターンコード	説明
STATUS_SUCCESS	エラーレコードは、補助エラーレコードセクションで正常に更新されました。
STATUS_BUFFER_TOO_SMALL	BufferLength パラメーターで指定された ErrorRecord パラメーターが指すバッファーのサイズが小さすぎて、補助エラーレコードセクションで更新された場合、エラーレコードを格納できません。
STATUS_NOT_SUPPORTED	PSHED プラグインは、指定されたエラーソースをサポートしていません。
STATUS_UNSUCCESSFUL	エラーが発生しました。

解説

エラー情報取得に参加する PSHED プラグインは、PshedRegisterPlugin 関数を呼び出して PSHED に登録するときに、WHEA_PSHED_PLUGIN_REGISTRATION_PACKET 構造体の Callbacks.RetrieveErrorInfo、Callbacks.FinalizeErrorRecord、Callbacks.ClearErrorStatus メンバーを設定し、その RetrieveErrorInfo、FinalizeErrorRecord、ClearErrorStatus コールバック関数を指します。 PSHED プラグインは、WHEA_PSHED_PLUGIN_REGISTRATION_PACKET構造体の FunctionalAreaMask メンバーに PshedFAErrorInfoRetrieval フラグを設定する必要もあります。

Windows カーネルは PSHED を呼び出して、補助エラーレコードセクションをエラーレコードに追加できるようにします。 PSHED プラグインがエラー情報の取得に参加するように登録されている場合、PSHED は PSHED プラグインの FinalizeErrorRecord コールバック関数を呼び出して、PSHED プラグインがエラー状態をより詳しく説明するエラーレコードセクションをエラーレコードに追加できるようにします。

PSHED プラグインは、エラーレコードの末尾を超えて補助エラーレコードセクションが追加されないようにする必要があります。 Windows カーネルが特定のエラーレコードを格納するためにバッファーに割り当てるメモリの量は、ハードウェアエラーを報告したエラーソースを記述するWHEA_ERROR_SOURCE_DESCRIPTOR構造体の MaxRawDataLength および MaxSectionsPerRecord メンバーから計算されます。エラーレコードに追加する補助エラーレコードセクションを含めるために PSHED プラグインに追加のバッファー領域が必要な場合は、エラーソースの検出に参加し、補足エラーレコードセクションを考慮するために、各エラーソースのWHEA_ERROR_SOURCE_DESCRIPTOR構造の MaxSectionsPerRecord メンバーの値を増やす必要があります。