ホーム › Devices.Fax › PFAXGETCONFIGURATIONA

PFAXGETCONFIGURATIONA

コールバック

シグネチャ

BOOL PFAXGETCONFIGURATIONA(
    HANDLE FaxHandle,
    FAX_CONFIGURATIONA** FaxConfig
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーのハンドルを指定します。
FaxConfig	FAX_CONFIGURATIONA**	FAX_CONFIGURATION 構造体を受け取るバッファーのアドレスへのポインターです。この構造体には、ファックスサーバーの現在の構成設定が格納されます。メモリの割り当てについては、以下の「解説」セクションを参照してください。

公式ドキュメント

FaxGetConfiguration 関数は、クライアントが接続しているファックスサーバーのグローバル構成設定を、ファックスクライアントアプリケーションに返します。このデータには、再送信、ブランディング、アーカイブ、カバーページの各設定、割引料金の時間帯、ファックスサーバーのキューの状態などが含まれます。

戻り値

Type: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

戻り値	説明
ERROR_INVALID_PARAMETER	FaxConfig または FaxHandle パラメーターの一方または両方が NULL です。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_CONFIG_QUERY アクセス権が必要です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。

解説(Remarks)

ファックス管理アプリケーションは通常、ファックスサーバーのグローバル構成設定を表示するために FaxGetConfiguration 関数を呼び出します。構成設定を変更するには、FaxSetConfiguration 関数を呼び出します。

FaxGetConfiguration 関数は、FaxConfig パラメーターが指す FAX_CONFIGURATION バッファーに必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために FaxFreeBuffer 関数を呼び出す必要があります。

詳細については、Fax Server Configuration Management および Freeing Fax Resources を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxGetConfiguration を定義しています。エンコード中立のエイリアスの使用と、エンコード中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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