記述形式
int LW_CreatePDFFileEx(int iServerApiHandle, char * lpSplFilePath, char * lpPDFDirPath, char * lpPDFFileName, LPPDFINFO lpPDFInfo, void * reserve)
int LW_CreatePDFFileEx(LWAPIHANDLE iServerApiHandle, char * lpSplFilePath, char * lpPDFDirPath, char * lpPDFFileName, LPPDFINFO lpPDFInfo, void * reserve)
機能
保管フォルダにある帳票をSPL形式からPDF形式へ変換します。またセキュリティ情報などを指定することもできます。
PDF変換時の留意事項については“解説書”を、PDF変換の機能については“設計・運用ガイド”を参照してください。
パラメタの説明
サーバAPI識別子を指定します。
PDFに変換するList Works帳票の論理パスを指定します。必ず指定します。
本情報の最終文字にはNULLが設定されている必要があります。
保管フォルダの共有運用の場合は、UNC名(\\サーバ名~)を指定する必要があります。
注意
第一階層の保管フォルダを指定する場合、List Worksの予約語名の保管フォルダ(NFORM-FOLDER-CWXNFORMRCVLWK)内の帳票を指定しないでください。
PDFファイルを格納するフォルダの物理パスを指定します。必ず指定します。
本情報の最終文字にはNULLが設定されている必要があります。
フォルダの物理パスには、実際に存在するパスを指定してください。
lpPDFDirPathおよび、lpPDFFileNameに指定したファイルの物理パスの合計が、256バイトを超えた場合はエラーになります。
lpPDFDirPathおよび、lpPDFFileNameで指定されたファイルと同一のファイルが存在する場合、そのファイルに上書きされます。
Linux版の場合、全角文字(半角カナ)を指定した場合、動作は保証されません。
生成するPDFファイルの名前を指定します。本情報の最終文字にはNULLが設定されている必要があります。
lpPDFDirPathおよび、lpPDFFileNameに指定したファイルの物理パスの合計が、256バイトを超えた場合はエラーになります。
lpPDFDirPathおよび、lpPDFFileNameで指定されたファイルと同一のファイルが存在する場合、そのファイルに上書きされます。
本情報を省略する場合はNULLを指定します。省略された場合は、lpSplFilePathで指定したList Works帳票のファイル名の拡張子を“.pdf”に変更したファイル名で作成します。
なお、指定したPDFファイルの名前に拡張子“.pdf”が付加されていない場合でも、自動的に拡張子“.pdf”を付加したファイル名で作成します。
Linux版の場合、全角文字(半角カナ)を指定した場合、動作は保証されません。
PDFINFO構造体 (PDF変換情報構造体)のアドレスを指定します。
本情報を省略する場合はNULLを指定します。省略された場合は、デフォルト動作としてのPDF変換が行われます。
PDFINFO構造体を以下に示します。
typedef struct CreatePDFInfo { unsigned short usp_Length; /* 領域長 */ char cp_OvlOrigin; /* オーバレイ原点位置の参照方法 */ char cp_Rsv1[1]; /* リザーブ */ char cp_OpenPwd[32+4]; /* "文書を開く"パスワード */ char cp_SecuPwd[32+4]; /* "セキュリティオプションの変更"パスワード */ int ip_Print; /* 印刷許可指定 */ int ip_Modify; /* 文書変更許可指定 */ int ip_Select; /* テキスト/グラフィックス選択許可指定 */ int ip_Annotate; /* 注釈/フォームフィールド追加変更許可指定 */ int ip_Embed; /* エンベッド指定 */ } PDFINFO; typedef PDFINFO* LPPDFINFO;
lpPDFInfoにNULLを指定した場合の設定内容のデフォルト値は以下のとおりです。
設定内容 | デフォルト値 |
---|---|
オーバレイ原点位置の参照方法 | オーバレイごとに保存してある帳票項目から参照します。 |
“文書を開く”パスワード | 設定されません。 |
“セキュリティオプションの変更”パスワード | 設定されません。 |
印刷許可指定 | 印刷を許可します。 |
文書変更許可指定 | 変更を許可します。 |
テキスト/グラフィックス選択許可指定 | 選択を許可します。 |
注釈/フォームフィールド追加変更許可指定 | 追加・変更を許可します。 |
エンベッド指定 | 埋め込みません。 |
予約されています。NULLを指定してください。
メンバ変数 | 項目 | 説明 |
---|---|---|
usp_Length | 領域長 | 構造体のサイズを指定します。 本APIを実行する前に、呼び出し元でsizeof(PDFINFO)を実行してください。 |
cp_OvlOrigin | オーバレイ原点位置の参照方法 | オーバレイ原点位置情報の参照方法を指定します。 0:オーバレイごとに保存してある帳票項目から参照する 1:帳票名ごとに保存してある帳票項目から参照する List Worksクライアント環境設定の【帳票項目】タブで「帳票名ごとに利用する」を選択している場合は「1」を、「オーバレイごとに利用する」を選択している場合は「0」を指定します。 |
cp_Rsv1 | リザーブ | NULLを指定します。 |
cp_OpenPwd | “文書を開く”パスワード | PDFファイルを開くときのパスワードを32バイト以内の半角英数字、または記号(ASCIIコードの文字範囲)で指定します。最終文字にはNULLが設定されている必要があります。 その他の文字を指定した場合、また32バイトを超えたパスワードを指定した場合はエラーとなります。 指定しない場合パスワードは設定されません。 |
cp_SecuPwd | “セキュリティオプションの変更”パスワード | PDFファイルのセキュリティオプションを変更するときのパスワードを32バイト以内の半角英数字、または記号(ASCIIコードの文字範囲)で指定します。最終文字にはNULLが設定されている必要があります。 その他の文字を指定した場合、また32バイトを超えたパスワードを指定した場合はエラーとなります。 “文書を開く”パスワードと同じパスワードを指定した場合、この“セキュリティオプションの変更”パスワードは無効となります。 指定しない場合はパスワードなしでセキュリティオプションの変更ができるようになります。 |
ip_Print | 印刷許可指定 | PDFファイルの印刷を許可するかどうかを指定します。 0:印刷を許可する 1:印刷を許可しない |
ip_Modify | 文書変更許可指定 | PDFファイルの文書の変更を許可するかどうかを指定します。 0:変更を許可する 1:変更を許可しない |
ip_Select | テキスト/グラフィックス選択許可指定 | PDFファイルのテキストとグラフィックスの選択を許可するかどうかを指定します。 0:選択を許可する 1:選択を許可しない |
ip_Annotate | 注釈/フォームフィールド追加変更許可指定 | PDFファイルの注釈と、フォームフィールドの追加と変更を許可するかどうかを指定します。 0:追加・変更を許可する 1:追加・変更を許可しない |
ip_Embed | エンベッド指定 | PDFファイルに文字を埋め込むかどうかを指定します。 0:埋め込まない 1:外字を埋め込む 2:すべての文字を埋め込む 外字のエンベッドはList Worksに帳票を登録する時に、外字を文字コードとして登録した場合のみ有効となります。 |
復帰値
正常終了しました。
異常終了しました。
参考
異常終了した場合に以下のサーバ機能APIを実行すると、エラーの詳細を取得することができます。
LW_GetServerApiErrCode(サーバ機能APIエラーコード取得)
LW_GetServerApiErrCodeについては、“1.3.1 LW_GetServerApiErrCode(サーバ機能APIエラーコード取得)”を参照してください。 |
LW_GetServerApiErrMsg(サーバ機能APIエラーメッセージ取得)
LW_GetServerApiErrMsgについては、“1.3.2 LW_GetServerApiErrMsg(サーバ機能APIエラーメッセージ取得)”を参照してください。 |