トピック:   

関数リファレンス

前のページ上位のトピック次のページ

awPDF Server Pro. SDK で使用可能な関数の名称、機能は下記の通りです。

 

関数名

機能

引数

awPDF_InitializeLibrary

DLLの初期化を行う




awPDF_ConnectServer
(awPDF_ConnectServerW)

PDFサーバへ接続を行う

Host


PChar

PortNo


Integer

SessionID

[out]

Integer

awPDF_LoadConfigFile
(awPDF_LoadConfigFileW)

変換設定ファイルを読み込む

SessionID


Integer

ConfigFileName


PChar

UserPassword


PChar

OwnerPassword


PChar

awPDF_ClearConfig

変換設定をクリアする

SessionID


Integer

awPDF_ConvertToPDF
(awPDF_ConvertToPDFW)

ファイル変換を行う

SessionID


Integer

FileName


PChar

SaveFileName


PChar

OverWrite


Boolean

awPDF_CombineExecute
(awPDF_CombineExecuteW)

ファイル結合変換を実行する

SessionID


Integer

SaveFileName


PChar

OverWrite


Boolean

awPDF_CombineAddFile
(awPDF_CombineAddFileW)

結合対象ファイルを追加する

SessionID


Integer

FileName


PChar

awPDF_CombineClearFiles

結合対象ファイルをクリアする

SessionID


Integer

awPDF_RotatePages
(awPDF_RotatePagesW)

PDFファイルを回転する

SessionID


Integer

FileName


PChar

SaveFileName


PChar

OverWrite


Boolean

PageRange


PChar

RotateAngle


Integer

Password


PChar

RemoveSecurity


Boolean

awPDF_DeletePages
(awPDF_DeletePagesW)

PDFファイルからページを削除する

SessionID


Integer

FileName


PChar

SaveFileName


PChar

OverWrite


Boolean

PageRange


PChar

Password


PChar

RemoveSecurity


Boolean

awPDF_RemoveSecurity
(awPDF_RemoveSecurityW)

PDFファイルのセキュリティ解除を行う

SessionID


Integer

FileName


PChar

SaveFileName


PChar

OverWrite


Boolean

Password


PChar

awPDF_CheckStatus
(awPDF_CheckStatusW)

状態チェック

SessionID


Integer

Status

[out]

Integer

ServerQueue

[out]

Integer

ErrorCode

[out]

Integer

ErrorMsg

[out]

PChar

awPDF_ConvertCancel

変換キャンセル

SessionID


Integer

Status

[out]

Integer

awPDF_GetServerSetting
(awPDF_GetServerSettingW)

サーバー側の変換設定ファイル(共透かしを取得する)

SessionID


Integer

SaveFileName


PChar

awPDF_GetHost
(awPDF_GetHostW)

ホスト名を取得する

SessionID


Integer

Host


PChar

awPDF_GetPortNo

ポート番号を取得する

SessionID


Integer

PortNo

[out]

Integer

awPDF_GetMaxFileSize

最大ファイルサイズを取得する

SessionID


Integer

MaxFileSize

[out]

Integer

awPDF_GetServerVersion
(awPDF_GetServerVersionW)

サーバーバージョンを取得する

SessionID


Integer

ServerVersion

[out]

PChar

awPDF_GetServerInterfaceVersion

インターフェースバージョンを取得する

SessionID


Integer

ServerInterfaceVersion

[out]

Integer

awPDF_GetServerDriverVersion
(awPDF_GetServerDriverVersionW)

ドライババージョンを取得する

SessionID


Integer

ServerDriverVersion

[out]

PChar

awPDF_GetServerCADVersion
(awPDF_GetServerCADVersionW

CADコンポーネントバージョンを取得する

SessionID


Integer

ServerCADVersion

[out]

PChar

awPDF_GetServerCADDefaultColorMode

CADカラーモード(デフォルトを取得する

SessionID


Integer

ServerCADDefaultColorMode

[out]

Integer

awPDF_GetLibraryVersion
(awPDF_GetLibraryVersionW)

ライブラリのバージョンを取得する

LibraryVersion

[out]

PChar

awPDF_GetLibraryInterfaceVersion

ライブラリのインターフェースバージョンを取得する

LibraryInterfaceVersion

[out]

Integer

awPDF_DisconnectServer

サーバーとの接続を切断する

SessionID


Integer

awPDF_DisposeLibrary

DLLを破棄する




 

注1) 関数はすべてファンクションで返り値はエラーコードです。
注2) Unicode版は引数がPChar型→PWideChar型に変ります。
注3) [out] は参照渡し、記述が無いものは値渡しを表します。
注4) awPDFはUnicodeに対応していません。Unicode版の関数はデフォルト文字列型がUnicodeである開発環境での本ライブラリの使用を簡便にするために用意されたものでが、引数の文字列にUnicode特有の文字が含まれている場合正しく動作しません。