1.1 サーバ機能APIの概要

サーバ機能APIを使用して、以下の処理を行うことができます。

保管フォルダ内の帳票情報の取得
帳票の複写
帳票の移動
帳票の削除
帳票のPDF変換
メール送信
帳票情報の変更

なお、メール送信では、ファイルを添付することができます。

サーバ機能API一覧表

以下に、サーバ機能APIを示します。

API		機能
開始、終了	LW_StartServerApi (注1)	サーバ機能API開始
開始、終了	LW_EndServerApi (注1)	サーバ機能API終了
エラー情報取得	LW_GetServerApiErrCode	サーバ機能APIエラーコード取得
エラー情報取得	LW_GetServerApiErrMsg	サーバ機能APIエラーメッセージ取得
保管フォルダ	LW_StartKeepFolder	保管フォルダ一覧開始
	LW_EndKeepFolder	保管フォルダ一覧終了
	LW_GetKeepFolderCount	保管フォルダ数取得
	LW_GetKeepFolderItem	保管フォルダ一覧取得
	LW_StartKeepList	保管フォルダ内の帳票一覧開始
	LW_EndKeepList	保管フォルダ内の帳票一覧終了
	LW_GetKeepListCount	保管フォルダ内の帳票数取得
	LW_GetKeepListItem	保管フォルダ内の帳票一覧取得
	LW_DeleteKeepFile (注1) (注2)	保管フォルダ内の帳票の削除
	LW_ChangeKeepFile (注1) (注2)	保管フォルダ内の帳票情報の変更
	LW_CreatePDFFileEx (注1) (注2) (注3)	帳票のPDF変換(セキュリティ情報指定) (注4)
	LW_CopyKeepFile (注1) (注2)	保管フォルダ内の帳票の複写
	LW_MoveKeepFile (注1) (注2)	保管フォルダ内の帳票の移動

注1) リスト管理サーバと通信を行うサーバ機能APIです。これらのサーバ機能APIを実行する間隔より入力監視時間を長く設定する必要があります。

注2) 実行結果が操作ログ/実行履歴に出力されます。

参照

操作ログ/実行履歴の詳細については、“メッセージ集”を参照してください。

注3) LW_CreatePDFFile、LW_CreatePDFFileExを使用する場合には、以下が必要となります。

List Works サーバにList Creator Enterprise Editionがインストールされている。
環境変数「GLIBC_TUNABLES」の値に「glibc.rtld.dynamic_sort=1」が設定されている。

注4) 帳票をPDF形式に変換する場合には、セキュリティ情報を設定することができるLW_CreatePDFFileExをお勧めします。

サーバ機能APIは、以下のファイルに格納されています。

Windows版の場合
```
F5cwsapi.dll
```
Solaris版/Linux版の場合
```
liblwapi.so
```

サーバ機能APIの関数定義、サーバ機能APIで使用する構造体の形式を格納したヘッダファイルは、以下に格納されています。

Windows版の場合

List Works のインストール先フォルダ\Samples\lvsvapi.h

Solaris版の場合

List Works のインストールディレクトリ/FJSVlw-sv/include/lvsvapi.h

Linux版の場合
```
/opt/FJSVlw-sv/include/lvsvapi.h
```

サンプルプログラム

サーバ機能APIを用いたサンプルプログラムは、以下に格納されています。

Windows版の場合

List Works のインストール先フォルダ\Samples\ApiSample1.c

Solaris版の場合

List Works のインストールディレクトリ/FJSVlw-sv/etc/ApiSample1.c

Linux版の場合
```
/opt/FJSVlw-sv/etc/ApiSample1.c
```

参照

サーバ機能APIを用いたサンプルプログラムについては、“付録B サーバ機能APIのサンプルプログラム”を参照してください。

注意

Solaris版/Linux版の場合、サーバ機能APIを実行する前に、List Worksを操作するために必要な環境変数を設定してください。環境変数については、“セットアップガイド”を参照してください。
サーバ機能APIはマルチスレッドに対応していません。
サーバ機能APIを使用したアプリケーションは、Windowsサーバ(x64)では32ビットアプリケーションとして動作させる必要があります。64ビットアプリケーションとしての動作は保証していません。
Windows版の場合、サーバ機能APIを使用したアプリケーションは、管理者で実行する必要があります。管理者以外で実行した場合、LW_StartServerApi(サーバ機能API開始)でエラーとなります。
Solaris版/Linux版の場合、サーバ機能APIを使用したアプリケーションは、スーパーユーザで実行する必要があります。スーパーユーザ以外で実行した場合、LW_StartServerApi(サーバ機能API開始)でエラーとなります。
Solaris版の場合、サーバ機能APIを使用するプログラムのコンパイル時に、-licvオプションを指定する必要があります。
Solaris版の場合、サーバ機能APIを使用したアプリケーションはEUC、またはShift-JIS環境下で実行する必要があります。
アプリケーションの実行環境シェルに環境変数LC_ALLが設定されている場合は、環境変数LANGと同じロケール名に変更してください。
Linux版の場合、サーバ機能APIを使用したアプリケーションはEUC、UTF-8、またはShift-JIS環境下で実行する必要があります。
アプリケーションの実行環境シェルに環境変数LC_ALLが設定されている場合は、環境変数LANGと同じロケール名に変更してください。