|
awPDF_CheckStatusW |
  
|
|
awPDF_CheckStatusW |
|
定義
function awPDF_CheckStatusW(
| const | SessionID : Integer, |
| var | Status : Integer, |
| var | ServerQueue : Integer, |
| var | ErrorCode : Integer, |
| var | ErrorMsg : PWideChar |
) : Integer;
機能
指定したセッションオブジェクトの変換サーバでの変換状態を取得します。
引数
| SessionID | 関数 awPDF_ConnectServer で取得したセッションIDを設定します。 |
| Status | 変換ステータスを返します。 |
| ServerQueue | 変換待ち件数を返します。 |
| ErrorCode | 変換エラーコード値を返します。 |
| ErrorMsg | 変換エラーコード値に対するメッセージを返します。 |
解説
セッションオブジェクトからの変換依頼に対する変換サーバでの変換状態（変換ステータス、変換待ち件数、エラー情報）を取得します。
変換ステータスはセッションオブジェクトと変換サーバ間での送受信状態を整数値で表し、”７：変換完了”が取得できたら変換処理の完了です。
関数 awPDF_ConvertCancel による変換処理のキャンセルは変換ステータスに”５：変換完了”が返るまで可能で、それ以降はキャンセルできません。
変換ステータス値 |
説明 |
0 |
変換ステータスの初期値。セッションオブジェクトで一度も変換処理が行われていない状態。 |
1 |
変換サーバへファイル変換依頼の送信待ち |
2 |
変換サーバへファイル変換依頼の送信中 |
3 |
変換サーバでファイル変換開始待ち |
4 |
変換サーバでファイル変換中 |
5 |
変換サーバでファイル変換完了 |
6 |
変換サーバから変換済ファイルをダウンロード中 |
7 |
変換サーバから変換済ファイルのダウンロード完了 |
8 |
変換サーバでファイル変換エラー |
9 |
変換サーバでファイル変換のキャンセル中 |
10 |
変換サーバでファイル変換のキャンセル完了 |
戻り値
成功した場合は0 を、エラーが発生した場合はエラーコード値を返します。