ホーム › Devices.Fax › PFAXGETDEVICESTATUSA

PFAXGETDEVICESTATUSA

コールバック

シグネチャ

BOOL PFAXGETDEVICESTATUSA(
    HANDLE FaxPortHandle,
    FAX_DEVICE_STATUSA** DeviceStatus
);

パラメーター

フィールド	型	説明
FaxPortHandle	HANDLE	FaxOpenPort 関数の呼び出しによって返されたファックスポートのハンドルを指定します。
DeviceStatus	FAX_DEVICE_STATUSA**	FAX_DEVICE_STATUS 構造体を受け取るバッファーのアドレスへのポインターです。この構造体は、1 つのファックスデバイスの状態を表します。メモリの割り当てについては、後述の「解説」セクションを参照してください

公式ドキュメント

FaxGetDeviceStatus 関数は、対象のファックスデバイスの現在の状態情報をファックスクライアントアプリケーションに返します。返されるデータには、デバイスとステーションの識別子、送信者名と受信者名、ルーティング情報などが含まれます。

戻り値

型: BOOL

関数が成功すると、0 以外の値が返ります。

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

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

解説(Remarks)

ファックス管理アプリケーションは通常、ファックスサーバーに関連付けられたファックスデバイスの状態を表示するために FaxGetDeviceStatus 関数を呼び出します。FaxGetDeviceStatus 関数は、DeviceStatus パラメーターが指す FAX_DEVICE_STATUS バッファーに必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために FaxFreeBuffer 関数を呼び出す必要があります。

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

メモ

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

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