ホーム › Devices.Fax › PFAXCONNECTFAXSERVERW

PFAXCONNECTFAXSERVERW

コールバック

シグネチャ

BOOL PFAXCONNECTFAXSERVERW(
    LPWSTR MachineName,
    HANDLE* FaxHandle
);

パラメーター

フィールド	型	説明
MachineName	LPWSTR	このポインターは NULL(空の文字列)でなければなりません。これにより、アプリケーションはローカルコンピューター上のファックスサーバーに接続します。
FaxHandle	HANDLE*	他のファックスクライアント関数への後続の呼び出しで必要となる、ファックスサーバーハンドルを受け取る変数へのポインターです。ファックスサーバーが null ハンドルを返した場合は、エラーが発生したことを示します。

公式ドキュメント

FaxConnectFaxServer 関数は、ファックスクライアントアプリケーションをローカルのファックスサーバーに接続します。この関数は、ジョブ、デバイス、構成、ドキュメントの管理を行う他のファックスクライアント関数を呼び出す際に必要となる、ファックスサーバーハンドルを返します。

戻り値

Type: BOOL

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

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

戻り値	説明
ERROR_INVALID_PARAMETER	FaxHandle パラメーターが NULL です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。
ERROR_ACCESS_DENIED	呼び出しが行われたアカウントのユーザーに、ファックスサーバーに対する十分な権限がありません。

解説(Remarks)

この関数はローカルサーバーに対してのみ使用できます。リモートサーバーの使用は Fax Service Extended COM API で有効になります。詳細については、IFaxServer::Connect メソッドを参照してください。

ファックスクライアントアプリケーションは、他のファックスクライアント関数を呼び出す前に、FaxConnectFaxServer 関数の呼び出しを成功させておく必要があります。

ファックスクライアントアプリケーションは、FaxClose 関数を呼び出して、ファックスサーバーとの接続を切断し、FaxConnectFaxServer 関数が返したハンドルを解放する必要があります。詳細については、Connecting to the Fax Server および Disconnecting from a Fax Server を参照してください。

メモ

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

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