７. 付属APIの詳細

定義

bool setOutputPDFFilenameFullPath(const char* path)

bool setOutputPDFFilenameFullPath(const wchar_t* path)

引数

path：出力するPDFファイルのフルパス名

戻り値

true=成功　／　false=失敗

説明

出力先となるPDFファイルパスを指定します。UNC（Universal Naming Convention）パス名での指定も可能です。

PDFへ出力する際、指定されたファイル名で上書きするためプログラム側でファイルの存在チェックが必要です。

また、出力先フォルダは存在していなければなりません。

定義

bool setOutputPDFFilenameClear()

引数

なし

戻り値

true=成功　／　false=失敗

説明

指定した出力先PDFファイルパスをクリアします。

定義

bool setSettingsFile(const char* settingsFile)

bool setSettingsFile(const wchar_t* settingsFile)

引数

settingsFile ：PDF出力設定ファイル名（フルパス名またはパスなしのファイル名）

戻り値

true=成功　／　false=失敗

説明

PDF出力設定ファイル名を指定します。パスを含まないファイル名が指定された場合は、

1) PDF Driver V8.0のインストールフォルダ\Settings

2)「CSIDL_APPDATA」で取得されるフォルダ\

AntennaHouse\PDF_Driver\<パージョン>\

CustomSettings

の順に検索します。

定義

bool setSettingsFileClear()

引数

なし

戻り値

true=成功　／　false=失敗

説明

指定したPDF出力設定ファイル名をクリアします。

定義

bool setOpenPDF(bool openFlag)

引数

openFlag ：rue=オープンする　／　false=オープンしない

戻り値

true=成功　／　false=失敗

説明

PDF出力後にPDF表示するかどうかを指定します。

本関数による設定は、印刷設定の「作成後PDFを表示」の設定値より優先されます。

定義

int SelectPrinter(const wchar_t* printerName)

引数

printerName：

・NULL：「Antenna House PDF Driver 8.0」プリンターを選択

・空文字列：処理可能状態にあるプリンターを自動で選択

・プリンター名（NULL文字終端で32文字(= 64バイト)まで）

戻り値

AHPD_ErrorCode.h を参照してください。

説明

PDFの出力先指定を行うプリンターを選択します。

定義

int ReleasePrinter()

引数

なし

戻り値

AHPD_ErrorCode.h を参照してください。

説明

SelectPrinterで選択したプリンターを解放し、他のプロセスやスレッドでも使えるようにします。

この関数は、デストラクタで呼ばれます。

定義

int GetSelectedPrinter(wchar_t* buf, size_t bufsizeInWORD)

引数

buf：選択されているプリンター名が格納されるバッファ。

bufsizeInWORD：bufのバッファ文字数。最低32文字（=64バイト）確保してください。

戻り値

AHPD_ErrorCode.h を参照してください。

説明

SelectPrinterで選択したプリンター名をバッファ（buf）に返します。

定義

int load(const char* settingFile)

int load(const wchar_t* settingFile)

引数

settingFile：読み込む出力設定ファイル名（フルパス名またはパスなしのファイル名）

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

指定された出力設定ファイルを読み込みます。パスを含まないファイル名が指定された場合は、

1) PDF Driver V8.0のインストールフォルダ\Settings

2)「CSIDL_APPDATA」で取得されるフォルダ\

AntennaHouse\PDF_Driver\<パージョン>\

CustomSettings

の順に検索します。

定義

int save()

引数

なし

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

編集した設定内容をロードした出力設定ファイル名で上書き保存します。

定義

int saveAs(const char* fileName)

int saveAs(const wchar_t* fileName)

引数

fileName：保存先の設定ファイルのフルパス名

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

編集した設定内容に名前を付けて保存します。

定義

int getCommon(PDFCommon * pdfCommonSet)

引数

pdfCommonSet：取得した値を格納するための「一般」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「一般」設定を取得します。

PDFCommon構造体定義は「PDFTableSet.h」を参照してください。

定義

int setCommon(const PDFCommon * pdfCommonSet)

引数

pdfCommonSet：格納する「一般」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「一般」設定を格納します。

PDFCommon構造体定義は「PDFTableSet.h」を参照してください。

定義

int getPDFVersion(PDFVersion* value)

引数

value：取得した値を格納するための「PDFバージョン」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「PDFバージョン」設定を取得します。

PDFVersion構造体定義は「PDFTableSet.h」を参照してください。

定義

int setPDFVersion(const PDFVersion* value)

引数

value：格納する「PDFバージョン」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「PDFバージョン」設定を格納します。

PDFVersion構造体定義は「PDFTableSet.h」を参照してください。

定義

int getCompress(PDFCompress * pdfCompressSet)

引数

pdfCompressSet:

取得した値を格納するための「圧縮」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「圧縮」設定を取得します。

PDFCompress構造体定義は「PDFTableSet.h」を参照してください。

定義

int setCompress(const PDFCompress * pdfCompressSet)

引数

pdfCompressSet：格納する「圧縮」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「圧縮」設定を格納します。

PDFCompress構造体定義は「PDFTableSet.h」を参照してください。

定義

PDFFont* getFont()

引数

なし

戻り値

「フォント」設定の構造体ポインタ

説明

「フォント」設定を取得します。

取得したポインタや「フォント」設定内のポインタを上位で開放する必要はありません。

PDFFont構造体定義は「PDFTableSet.h」を参照してください。

定義

int setFont(const PDFFont * pdfFontSet)

引数

pdfFontSet：格納する「フォント」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「フォント」設定を格納します。

PDFFont構造体定義は「PDFTableSet.h」を参照してください。

定義

int getSecurity(PDFSecurity * pdfSecuritySet)

引数

pdfSecuritySet：取得した値を格納するための「セキュリティ」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「セキュリティ」設定を取得します。

PDFSecurity構造体定義は「PDFTableSet.h」を参照してください。

定義

int setSecurity(const PDFSecurity * pdfSecuritySet)

引数

pdfSecuritySet：格納する「セキュリティ」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「セキュリティ」設定を格納します。

PDFSecurity構造体定義は「PDFTableSet.h」を参照してください。

定義

int getWaterMark(PDFWaterMark * pdfWaterMarkSet)

引数

pdfWaterMarkSet：取得した値を格納するための「透かし」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「透かし」設定を取得します。

PDFWaterMark構造体定義は「PDFTableSet.h」を参照してください。

定義

int setWaterMark(const PDFWaterMark * pdfWaterMarkSet)

引数

pdfWaterMarkSet：格納する「透かし」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「透かし」設定を格納します。

PDFWaterMark構造体定義は「PDFTableSet.h」を参照してください。

定義

int getOpenMode(PDFOpenMode * pdfOpenModeSet)

引数

pdfOpenModeSet：取得した値を格納するための「開き方」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「開き方」設定を取得します。

PDFOpenMode構造体定義は「PDFTableSet.h」を参照してください。

定義

int setOpenMode(const PDFOpenMode * pdfOpenModeSet)

引数

pdfOpenModeSet：格納する「開き方」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「開き方」設定を格納します。

PDFOpenMode構造体定義は「PDFTableSet.h」を参照してください。

定義

int getInformation(PDFInformation * pdfInformationSet)

引数

pdfInformationSet：取得した値を格納するための「情報」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「情報」設定を取得します。

PDFInformation構造体定義は「PDFTableSet.h」を参照してください。

定義

int setInformation(const PDFInformation * pdfInformationSet)

引数

pdfInformationSet：格納する「情報」設定の構造体ポインタ

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

「情報」設定を格納します。

PDFInformation構造体定義は「PDFTableSet.h」を参照してください。

定義

int getName(wchar_t* buf, size_t bufsize)

引数

buf：取得した設定表示名を格納する文字列変数のポインタ

bufsize ：bufのサイズ。WORD単位でNULL文字分を含めてください。

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

印刷設定ダイアログ上で表示される設定の表示名を取得します。設定ファイル名とは一致しません。表示名がない場合は空文字列が取得されます。

定義

int setName(const wchar_t* value)

引数

value：設定する設定表示名の文字列変数のポインタ。終端はNULL文字にしてください。

指定可能な文字数は、UNICODEで100文字(200バイト)までです。以降は切り捨てられます。

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

印刷設定ダイアログ上で表示される設定の表示名を指定します。設定ファイル名とは一致しません。ファイル名に使用できない文字や記号の指定が可能です。

プログラムでsetNameを行わない場合、あるいは、setNameで空文字列やNULLを指定した場合は、印刷設定ダイアログ上では拡張子を除く設定ファイル名で表示されます。

定義

int initSetting()

引数

なし

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

設定内容を規定値に戻します。

定義

int sendToDriver ()

引数

なし

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

設定内容をPDF Driver V6へ渡します。

設定内容を印刷処理で正しく反映させるためには、印刷が終了するまでsendToDriverを行ったCEditSettingFileのインスタンスが有効でなければなりません。

PDF Driverへ渡した設定内容は、PDF Driverでの印刷後、本クラス消滅後、もしくはclearSettingsメソッド呼出し後にクリアされます。

定義

int clearSettings ()

引数

なし

戻り値

エラーコード：Settingerror.hを参照してください。

0=正常

説明

PDFDriver V6へ渡した設定内容をクリアします。

定義

int SelectPrinter(const wchar_t* printerName)

引数

printerName：

・NULL：「Antenna House PDF Driver 8.0」プリンターを選択

・空文字列：処理可能状態にあるプリンターを自動で選択

・プリンター名（NULL文字終端で32文字(= 64バイト)まで）

戻り値

AHPD_ErrorCode.h を参照してください。

説明

印刷設定編集を行うプリンターを選択します。

定義

int ReleasePrinter()

引数

なし

戻り値

AHPD_ErrorCode.h を参照してください。

説明

SelectPrinterで選択したプリンターを解放し、他のプロセスやスレッドでも使えるようにします。

この関数は、デストラクタで呼ばれます。

定義

int GetSelectedPrinter(wchar_t* buf, size_t bufsizeInWORD)

引数

buf：選択されているプリンター名。入力値は無視されます。

bufsizeInWORD：bufのバッファ文字数。最低32文字（=64バイト）確保してください。

戻り値

AHPD_ErrorCode.h を参照してください。

説明

SelectPrinterで選択したプリンター名をバッファ（buf）に返します。

定義

int getNotificationID(uintptr_t* id)

引数

id：識別番号を格納する変数へのポインタ

戻り値

EDIT_PARAM_ERR(0x130) = 引数エラー

その他の0以外の値 = その他のエラー

0 = 正常

説明

印刷の開始や終了を通知するための識別番号を取得します。

定義

int setNotificationID(uintptr_t id)

引数

id：通知を受け取るさいの識別番号

0 = 通知は行わない

0xFFFFFFFF、0xFFFFFFFFFFFFFFFF(64bitのみ) = GetCurrentThreadId()の値を識別番号とする

戻り値

EDIT_PARAM_ERR(0x130) = 引数エラー

その他の0以外の値 = その他のエラー

0 = 正常

説明

印刷の開始や終了を通知するための識別番号を設定します。

複数の印刷ジョブで同じ設定を使用するとidが重なります。印刷ジョブごとにidを変更、再設定してください。

識別番号設定を64bitプロセスで行い、Windowsメッセージ受信を32bitプロセスで行うと、識別番号の上位32bitが欠落します。

定義

int getNotificationMessageString (messageReason reason, wchar_t* buf, size_t bufsize)

引数

reason：文字列を取得するWindowsメッセージの種類。次の４種類からひとつを指定します。

num messageReason{

PrintStart = 0, // 印刷開始

PageStart = 1, // ページ開始

PageEnd = 2, // ページ終了

PrintEnd = 3, // 印刷終了

};

buf：文字列を格納する変数のポインタ

bufsize：bufのサイズ。WORD単位でNULL文字分を含めてください。

戻り値

EDIT_PARAM_ERR(0x130) = 引数エラー

EDIT_MEMORY_ERR(0x140) = 文字列処理エラー

その他の0以外の値 = その他のエラー

0 = 正常

説明

setNotificationMessageString()で指定された文字列を取得します。

定義

int setNotificationMessageString (messageReason reason, const wchar_t* str)

引数

reason：文字列を設定するWindowsメッセージの種類。次の４種類からひとつを指定します。

num messageReason{

PrintStart = 0, // 印刷開始

PageStart = 1, // ページ開始

PageEnd = 2, // ページ終了

PrintEnd = 3, // 印刷終了

};

str：Windowsメッセージを受信するための文字列。NULL終端でNULLを含み31文字以内。超過する場合はエラーになります。

空文字列(L"")、NULLが指定された場合、指定がない場合は、メッセージは送信されません。

戻り値

EDIT_PARAM_ERR(0x130) = 引数エラー

EDIT_MEMORY_ERR(0x140) = 文字列処理エラー

その他の0以外の値 = その他のエラー

0 = 正常

説明

印刷の開始や終了のWindowsメッセージを受け取るための文字列を指定します。この関数で指定した文字列でRegisterWindowMessageW()を行い、Windowsメッセージを受信することで、印刷の開始や終了を認識することができます。