PFE_EXPORT_FUNC コールバック関数 (winbase.h)

[アーティクル]
03/03/2024

ReadEncryptedFileRaw で使用される、アプリケーション定義のコールバック関数。システムは、すべてのファイルデータを受信するまで、暗号化されたファイルのデータのブロックを使用して ExportCallback を 1 回以上呼び出します。 ExportCallback は、暗号化されたファイルのデータを別のストレージメディアに書き込みます。通常は、ファイルをバックアップする目的で書き込みます。

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

構文

PFE_EXPORT_FUNC PfeExportFunc;

DWORD PfeExportFunc(
  [in]           PBYTE pbData,
  [in, optional] PVOID pvCallbackContext,
  [in]           ULONG ulLength
)
{...}

パラメーター

[in] pbData

バックアップする暗号化されたファイルのデータのブロックへのポインター。このデータブロックは、システムによって割り当てられます。

[in, optional] pvCallbackContext

アプリケーション定義および割り当てられたコンテキストブロックへのポインター。アプリケーションは、このポインターを ReadEncryptedFileRaw に渡し、 ReadEncryptedFileRaw はこのポインターをコールバック関数に渡して、アプリケーション固有のデータにアクセスできるようにします。このデータは構造体にすることができ、暗号化されたファイルのバックアップコピーを含むファイルへのハンドルなど、アプリケーションで必要な任意のデータを含めることができます。

[in] ulLength

pbData パラメーターが指すデータのサイズ (バイト単位)。

戻り値

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

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

注釈

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

要件

要件	値
サポートされている最小のクライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	winbase.h (Windows.h を含む)