Win32 API 日本語リファレンス
ホーム › Devices.Fax › PFAXOPENPORT

PFAXOPENPORT

コールバック

シグネチャ

BOOL PFAXOPENPORT(
    HANDLE FaxHandle,
    DWORD DeviceId,
    DWORD Flags,
    HANDLE* FaxPortHandle
);

パラメーター

フィールド型説明
FaxHandleHANDLEFaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
DeviceIdDWORD受信デバイスの永続的な回線識別子である DWORD 変数を指定します。このパラメーターに指定する有効な値を取得するには、FaxEnumPorts 関数を呼び出します。詳細については、後述の「解説」セクションを参照してください。
FlagsDWORD

ポートのアクセスレベルを定義する一連のビットフラグを格納した DWORD 変数を指定します。このパラメーターには、次の値の 1 つ以上を指定できます。

PORT_OPEN_QUERY

ファクスポートのハンドルを取得するために必要なポートのアクセスレベルです。このアクセスレベルは、FaxGetPort 関数を呼び出してファクスポートの情報を照会する場合にも必要です。

PORT_OPEN_MODIFY

FaxGetPort 関数の呼び出しによってファクスポートの構成を変更するために必要なポートのアクセスレベルです。このアクセスレベルには、PORT_OPEN_QUERY アクセスレベルに関連付けられたアクセス権も含まれます。

FaxPortHandleHANDLE*以降の他のファクスクライアント関数の呼び出しで必要となるファクスポートのハンドルを受け取る変数へのポインターです。ファクスサーバーが NULL ハンドルを返した場合は、エラーが発生したことを示します。

公式ドキュメント

FaxOpenPort 関数は、ファクスポートのハンドルをファクスクライアントアプリケーションに返します。このポートハンドルは、デバイス管理やファクスドキュメントのルーティングを行う他のファクスクライアント関数をアプリケーションが呼び出すときに必要です。

戻り値

Type: BOOL

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。
ERROR_NOT_ENOUGH_MEMORY
メモリの割り当て中にエラーが発生しました。
ERROR_INVALID_HANDLE
ポートは既に PORT_OPEN_MODIFY アクセスで開かれています。
ERROR_BAD_UNIT
DeviceId パラメーターが無効です。

解説(Remarks)

ファクスポートのハンドルを取得するには、FaxOpenPort 関数を呼び出します。取得したハンドルは、次の関数を呼び出すときに使用します。

FaxEnumPorts 関数は、FAX_PORT_INFO 構造体の配列を返します。各構造体には、1 つのポートに関する詳細情報が格納され、DeviceId パラメーターに渡す有効な値も含まれます。このデバイス識別子はファクスサーバーへの関数呼び出しの間で変化する可能性があるため、アプリケーションは永続的な形で保存しないでください。

詳細については、Fax Ports、Fax Device Management、および Managing Fax Routing Data を参照してください。

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