ホーム › Devices.Fax › PFAXSETCONFIGURATIONA

PFAXSETCONFIGURATIONA

コールバック

シグネチャ

BOOL PFAXSETCONFIGURATIONA(
    HANDLE FaxHandle,
    FAX_CONFIGURATIONA* FaxConfig
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
FaxConfig	FAX_CONFIGURATIONA*	FAX_CONFIGURATION 構造体へのポインターです。この構造体には、現在のファクスサーバーの構成設定を変更するためのデータが格納されます。

公式ドキュメント

ファクスクライアントアプリケーションは、接続先のファクスサーバーのグローバルな構成設定を変更するために FaxSetConfiguration 関数を呼び出します。構成データには、再送信、ブランディング、アーカイブ、カバーページの設定、割引料金時間帯、ファクスサーバーキューの状態などを含めることができます。

戻り値

Type: BOOL

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_CONFIG_SET アクセス権が必要です。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。
ERROR_INVALID_PARAMETER	FaxConfig パラメーターが NULL であるか、指定された FAX_CONFIGURATION 構造体の SizeOfStruct メンバーが sizeof(FAX_CONFIGURATION) と等しくありません。

解説(Remarks)

ファクス管理アプリケーションは通常、ファクスサーバーのグローバルな構成設定を管理するために FaxSetConfiguration 関数を呼び出します。設定を照会するには、アプリケーションは FaxGetConfiguration 関数を呼び出します。詳細については、Fax Server Configuration Management を参照してください。

メモ

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

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