定義
function awPDF_ConvertToPDF(
const | SessionID : Integer, |
const | FileName : PChar, |
const | SaveFileName : PChar, |
const | OverWrite : Boolean |
) : Integer;
機能
セッションオブジェクトを指定して変換サーバに変換依頼を行います。
引数
SessionID | 関数 awPDF_ConnectServer で取得したセッションIDを設定します。 |
FileName | 変換を行う対象ファイル名をフルパスで設定します。 |
SaveFileName | 変換後ファイル名をフルパスで設定します。 |
OverWrite | 変換後ファイル名が既に存在する場合に上書きする場合はTrueを設定します。 |
解説
対象ファイルをPDFファイルへ変換し、変換後ファイル名で指定されたパスへ保存します。
セッションオブジェクトはPDFファイルを受信するまで待機せずに次の操作を待ちます。関数 awPDF_CheckStatus を呼び出し、変換ステータスをチェックしてください。
セッションオブジェクトはPDFファイルを受信するまで変換サーバへの操作を受け付けません。(但し変換ステータスチェック、キャンセルは除く)
ヒント
変換サーバで変換が完了するまでは関数 awPDF_ConvertCancel を呼び出しキャンセルすることができます。
!!注意!!
変換サーバで設定されている最大ファイルサイズを超えるファイルの変換はできません。ファイルサイズが最大ファイルサイズを超える場合関数 awPDF_ConvertPDF はエラーコード値を返します。変換サーバの最大ファイルサイズは、関数 awPDF_GetMaxFileSize で取得することができます。
変換設定ファイルを使用することにより、文書へのセキュリティ設定、透かし、ヘッダー・フッターの追加、またはCADファイルのPDF変換に関する設定を追加することができます。
!!注意!!
変換設定ファイルを使用する場合、関数 awPDF_ConvertToPDF を呼び出す前に関数 awPDF_LoadConfigFile から変換設定ファイルを読み込んでください。
戻り値
成功した場合は0 を、エラーが発生した場合はエラーコード値を返します。