ホーム › Devices.Fax › PFAXOPENPORT
PFAXOPENPORT
コールバックシグネチャ
BOOL PFAXOPENPORT(
HANDLE FaxHandle,
DWORD DeviceId,
DWORD Flags,
HANDLE* FaxPortHandle
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| FaxHandle | HANDLE | FaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。 |
| DeviceId | DWORD | 受信デバイスの永続的な回線識別子である DWORD 変数を指定します。このパラメーターに指定する有効な値を取得するには、FaxEnumPorts 関数を呼び出します。詳細については、後述の「解説」セクションを参照してください。 |
| Flags | DWORD | ポートのアクセスレベルを定義する一連のビットフラグを格納した DWORD 変数を指定します。このパラメーターには、次の値の 1 つ以上を指定できます。 PORT_OPEN_QUERYファクスポートのハンドルを取得するために必要なポートのアクセスレベルです。このアクセスレベルは、FaxGetPort 関数を呼び出してファクスポートの情報を照会する場合にも必要です。 PORT_OPEN_MODIFYFaxGetPort 関数の呼び出しによってファクスポートの構成を変更するために必要なポートのアクセスレベルです。このアクセスレベルには、PORT_OPEN_QUERY アクセスレベルに関連付けられたアクセス権も含まれます。 |
| FaxPortHandle | HANDLE* | 以降の他のファクスクライアント関数の呼び出しで必要となるファクスポートのハンドルを受け取る変数へのポインターです。ファクスサーバーが NULL ハンドルを返した場合は、エラーが発生したことを示します。 |
公式ドキュメント
FaxOpenPort 関数は、ファクスポートのハンドルをファクスクライアントアプリケーションに返します。このポートハンドルは、デバイス管理やファクスドキュメントのルーティングを行う他のファクスクライアント関数をアプリケーションが呼び出すときに必要です。
戻り値
Type: BOOL
関数が成功すると、戻り値は 0 以外の値になります。
関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は、次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。 | |
| メモリの割り当て中にエラーが発生しました。 | |
| ポートは既に PORT_OPEN_MODIFY アクセスで開かれています。 | |
| DeviceId パラメーターが無効です。 |
解説(Remarks)
ファクスポートのハンドルを取得するには、FaxOpenPort 関数を呼び出します。取得したハンドルは、次の関数を呼び出すときに使用します。
- FaxSetPort: ポートの構成を変更します
- FaxEnumRoutingMethods: デバイスに関連付けられたファクスルーティング方法に関する情報を取得します
詳細については、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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)