PFAXSETPORTA

コールバック

シグネチャ

BOOL PFAXSETPORTA(
    HANDLE FaxPortHandle,
    FAX_PORT_INFOA* PortInfo
);

パラメーター

フィールド	型	説明
FaxPortHandle	HANDLE	FaxOpenPort 関数の呼び出しによって返されたファックスポートのハンドルを指定します。
PortInfo	FAX_PORT_INFOA*	FAX_PORT_INFO 構造体へのポインターです。この構造体には、指定したファックスポートの構成を変更するためのデータが含まれます。

公式ドキュメント

ファックスクライアントアプリケーションは、対象のファックスポートの構成を変更するために FaxSetPort 関数を呼び出します。構成データには、ポートの機能、優先度、応答までの呼び出し回数、送信側および被呼側の局識別子などを含めることができます。

戻り値

Type: BOOL

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_PORT_SET アクセス権が必要です。
ERROR_DEVICE_IN_USE	FaxPortHandle パラメーターで示されるポートは使用中です。
ERROR_INVALID_PARAMETER	FaxPortHandle または PortInfo パラメーターの一方または両方が NULL です。

解説(Remarks)

アプリケーションは、FaxSetPort 関数を呼び出す前に、FaxOpenPort 関数を呼び出し、PORT_OPEN_MODIFY アクセスレベルを指定する必要があります。

この関数で設定できるのは、FAX_PORT_INFO 構造体の次のメンバーのみです: Flags、Rings、Priority、Tsid、Csid

ファックス管理アプリケーションは通常、ファックスサーバーに関連付けられたファックスデバイスを管理するために FaxSetPort 関数を呼び出します。デバイスを照会するには、FaxGetPort 関数を呼び出します。

FaxSetPort 関数の FaxPortHandle パラメーターに指定する有効なポートハンドルを取得するには、FaxOpenPort 関数を呼び出します。詳細については、Fax Device Management を参照してください。

メモ

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

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