定義
function awPDF_CombineExecuteW(
const | SessionID : Integer, |
const | SaveFileName : PWideChar, |
const | OverWrite : Boolean |
) : Integer;
機能
セッションオブジェクトを指定して変換サーバにファイル結合依頼を行います。
引数
SessionID | 関数 awPDF_ConnectServer で取得したセッションIDを設定します。 |
SaveFileName | 変換後ファイル名をフルパスで設定します。(※1) |
OverWrite | 変換後ファイル名が既に存在する場合に上書きする場合はTrueを設定します。 |
!!注意!! ※1
awPDFはUnicodeに対応していません。Unicode版の関数はデフォルト文字列型がUnicodeである開発環境での本ライブラリの使用を簡便にするために用意されたものですが、引数の文字列にANSI文字に変換できないUnicode特有の文字が含まれている場合正しく動作しません。
解説
結合対象ファイル一覧に設定されている複数ファイルを1つのPDFファイルへ変換し、変換後ファイル名で指定されたパスへ保存します。
セッションオブジェクトはPDFファイルを受信するまで待機せずに次の操作を待ちます。関数 awPDF_CheckStatus を呼び出し、変換ステータスをチェックしてください。
セッションオブジェクトはPDFファイルを受信するまで変換サーバへの操作を受け付けません。(但し変換ステータスチェック、キャンセルは除く)
ヒント
変換サーバで変換が完了するまでは関数 awPDF_ConvertCancel を呼び出しキャンセルすることができます。
ヒント
結合対象ファイル一覧に1ファイルのみ設定されている場合、関数 awPDF_ConvertPDF を使用し変換を行った場合と同じになります。
変換設定ファイルを使用することにより、文書へのセキュリティ設定、透かし、ヘッダー・フッターの追加、またはCADファイルのPDF変換に関する設定を追加することができます。
!!注意!!
変換設定ファイルを使用する場合、関数 awPDF_CombineExecute を呼び出す前に関数 awPDF_LoadConfigFile から変換設定ファイルを読み込んでください。
変換終了後に関数 awPDF_CombineClearFiles を呼び出し結合対象ファイル一覧をクリアしてください。
!!注意!!
変換終了後、関数 awPDF_CombineExecute はオブジェクトセッションの結合対象ファイル一覧をクリアしません。クリアせずにファイル結合を行った場合、結合対象ファイル一覧に残っているファイルも対象ファイルとみなされます。
戻り値
成功した場合は0 を、エラーが発生した場合はエラーコード値を返します。