Win32 API 日本語リファレンス
ホーム › Storage.FileSystem › PFE_EXPORT_FUNC

PFE_EXPORT_FUNC

コールバック

シグネチャ

DWORD PFE_EXPORT_FUNC(
    BYTE* pbData,
    void* pvCallbackContext,
    DWORD ulLength
);

パラメーター

フィールド型説明
pbDataBYTE*バックアップ対象となる、暗号化されたファイルのデータブロックへのポインターです。このデータブロックはシステムによって割り当てられます。
pvCallbackContextvoid*アプリケーション定義で、アプリケーションが割り当てたコンテキストブロックへのポインターです。アプリケーションはこのポインターを ReadEncryptedFileRaw に渡し、ReadEncryptedFileRaw がこのポインターをコールバック関数に渡すことで、コールバック関数はアプリケーション固有のデータにアクセスできます。このデータは構造体でもよく、暗号化されたファイルのバックアップコピーを格納するファイルのハンドルなど、アプリケーションが必要とする任意のデータを含めることができます。
ulLengthDWORDpbData パラメーターが指すデータのサイズ (バイト単位) です。

公式ドキュメント

ReadEncryptedFileRaw と共に使用される、アプリケーション定義のコールバック関数です。システムは、ファイルのデータをすべて受け取るまで、暗号化されたファイルのデータのブロックを渡しながら ExportCallback を 1 回以上呼び出します。ExportCallback は、暗号化されたファイルのデータを別の記憶媒体に書き込みます。これは通常、そのファイルをバックアップする目的で行われます。

PFE_EXPORT_FUNC 型は、このコールバック関数へのポインターを定義します。ExportCallback は、アプリケーション定義の関数名のプレースホルダーです。

戻り値

関数が成功した場合は、戻り値に ERROR_SUCCESS を設定する必要があります。

関数が失敗した場合は、WinError.h で定義されている 0 以外のエラーコードを戻り値に設定します。たとえば、この関数が呼び出した API の失敗が原因で失敗した場合は、失敗した API に対する GetLastError の戻り値を設定できます。

解説(Remarks)

アプリケーション定義のコンテキストブロックは、ファイルハンドルやファイル内の現在のオフセットなどの情報を内部的に追跡するために使用できます。

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