定義
function awPDF_ConnectServer(
const | Host : PChar, |
const | PortNo : Integer, |
var | SessionID : Integer |
) : Integer;
機能
awPDF Pro サーバーに接続し、セッションIDを取得します。
引数
Host | 接続する変換サーバのホスト名称を設定します。 |
PortNo | 接続する変換サーバのポート番号を設定します。 |
SessionID | 接続に成功した場合、1以上の整数(セッションID)を返します。 |
解説
関数 awPDF_ConnectServer で指定した変換サーバとの接続が確立した場合、セッションオブジェクトが作成され、セッションIDを取得することができます。取得したセッションIDは、セッションオブジェクトを指定する必要がある関数を呼び出す際に引数として使用します。
セッションオブジェクトは関数 awPDF_DisconnectServer を呼び出してサーバとの接続を切断するか、関数 awPDF_DisposeLibrary を呼び出してた時に破棄されます。
!!注意!!
関数 awPDF_DisposeLibrary を呼び出した場合、その時点で保持している全てのセッションオブジェクトが破棄されます。
1つのセッションオブジェクトは同時に複数の変換処理をサーバーに依頼することは出来ません。1つの変換処理を依頼した場合、その処理が完了するか、キャンセルされると次の変換処理を依頼することが出来るようになります。
セッションオブジェクトは関数 awPDF_ConnectServer を呼び出す度に作成され、その度に異なるセッションIDが取得されます。複数のセッションIDを使用することで、複数の変換処理を同時にサーバに依頼することが出来ます。
!!注意!!
1つのセッションオブジェクトは、接続先サーバの同時接続クライアント数を1つ消費します。サーバに接続しているクライアントの数が同時接続数の上限に達している場合、関数 awPDF_ConnectServer はセッションオブジェクトの作成に失敗しエラーコード値を返します。
この場合、ライブラリによって引数 SessionID に設定される値の正当性は保障されません。
戻り値
成功した場合は0 を、エラーが発生した場合はエラーコード値を返します。