ホーム › Devices.Fax › PFAXCONNECTFAXSERVERA

PFAXCONNECTFAXSERVERA

コールバック

シグネチャ

BOOL PFAXCONNECTFAXSERVERA(
    LPSTR MachineName,
    HANDLE* FaxHandle
);

パラメーター

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

公式ドキュメント

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

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

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

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

解説(Remarks)

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

FAX クライアントアプリケーションは、他の FAX クライアント関数を呼び出す前に、FaxConnectFaxServer 関数を正常に呼び出しておく必要があります。

FAX クライアントアプリケーションは、FAX サーバーとの接続を切断し、FaxConnectFaxServer 関数が返したハンドルを解放するために、FaxClose 関数を呼び出す必要があります。詳細については、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)