PFAX_EXT_GET_DATA

コールバック

シグネチャ

DWORD PFAX_EXT_GET_DATA(
    DWORD param0,
    FAX_ENUM_DEVICE_ID_SOURCE param1,
    LPWSTR param2,
    BYTE** param3,
    DWORD* param4
);

パラメーター

フィールド	型
param0	DWORD
param1	FAX_ENUM_DEVICE_ID_SOURCE
param2	LPWSTR
param3	BYTE**
param4	DWORD*

公式ドキュメント

FaxExtGetData コールバック関数は、特定のデバイスと GUID に対する構成データを取得します。

戻り値

型: DWORD

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は WinError.h で定義されている 0 以外のエラーコードです。Win32 の FormatMessage 関数を FORMAT_MESSAGE_FROM_SYSTEM フラグを指定して呼び出すと、エラーの一般的な説明を取得できます。

FaxExtGetData 関数は、次のエラーコードを返すことがあります。

リターンコード	説明
ERROR_SUCCESS	構成データが正常に取得されました。
ERROR_INVALID_PARAMETER	関数に渡されたパラメーターのうち、少なくとも 1 つが無効です。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために十分なメモリがありません。
ERROR_BAD_DB	構成データが破損しています。
ERROR_FILE_NOT_FOUND	dwDeviceId パラメーターで指定されたデバイス ID が見つからなかったか、lpcwstrDataGUID パラメーターで指定された GUID に、指定されたデバイスに関連するデータが含まれていません。
ERROR_GEN_FAILURE	ファクスサーバーで内部エラーが発生したため、データにアクセスできません。
ERROR_SHUTDOWN_IN_PROGRESS	サーバーがシャットダウン中です。

解説(Remarks)

ファクス拡張機能がこのファクスサービスのコールバック関数を呼び出すときは、ファクスサービスが FaxExtInitializeConfig 関数を呼び出した際に公開した関数ポインターを使用する必要があります。

セキュリティ要件: この関数を呼び出すには、呼び出し元がサーバーの構成を照会するアクセス権を持っている必要があります。

グローバルな構成データ、または特定のデバイスと GUID に対する構成データを変更するには、FaxExtSetData 関数を呼び出します。

ファクスサービスは、FaxExtInitializeConfig 関数を呼び出すときに、FaxExtGetData コールバック関数へのポインターを渡します。PFAX_EXT_GET_DATA データ型は、FaxExtGetData 関数へのポインターです。

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