一般的なデータ格納関数

この節では、一般的なデータ格納活動に関する関数について説明します。

configure()

目的

構成文字列をデータ格納に渡します。

形式

int configure(const char *configp);

説明

configure() 関数はオプション (省略可能) です。必要とされるパブリックモジュール管理ビーンとともにこの関数が提供されている場合 (データサービス構成ツールと DHCP 管理ツールを参照)、フレームワーク構成層は、パブリックモジュールのロード時にこの関数を呼び出し、パブリックモジュール固有の構成文字列内に渡します。この文字列は、データ格納モジュールのために DHCP サーバー上のフレームワーク構成層によってキャッシュされます。

戻り値

DSVC_SUCCESS, DSVC_MODULE_CFG_ERR

configure() 関数は、モジュールがモジュールのロードをフレームワーク構成層に続けてもらいたければ DSVC_SUCCESS を返し、モジュールのロードを行なってもらいたくなければ DSVC_MODULE_CFG_ERR を返します。後者の例は、構成文字列の形式が適切でないためにモジュールの必要な構成を行えないような場合です。

mklocation()

目的

データ格納コンテナを置くディレクトリを作成します。

形式

int mklocation(const char *location);

説明

データ格納コンテナを置く場所として、location で指定されたディレクトリを作成します (ディレクトリが存在しない場合)。

戻り値

DSVC_SUCCESS, DSVC_ACCESS, DSVC_EXISTS, DSVC_BUSY, DSVC_INTERNAL, DSVC_UNSUPPORTED

status()

目的

データ格納の一般的な状態を取得します。

形式

int status(const char *location);

説明

status() 関数は、データ格納に対してその一般的な状態を返すよう指示します。もし location が NULL でなければ、そのコンテナが実際に存在し、アクセス可能であり、かつ形式がそのデータ格納タイプにとって正しいかどうかを判定することによって、データ格納コンテナのロケーションを検証します。データ格納は、必要な機能が利用できなかったり、準備されていない場合には、適切なエラーコードを返す必要があります。

戻り値

DSVC_SUCCESS, DSVC_ACCESS, DSVC_NO_LOCATION, DSVC_BUSY, DSVC_INTERNAL

version()

目的

データ格納によって実装される API のバージョン番号を取得します。

形式

int version(int *versionp);

説明

このマニュアルに記載されているサービスプロバイダ層 API をサポートするデータ格納はバージョン 1 です。バージョンは、int 内で versionp で示して返されます。

戻り値

DSVC_SUCCESS, DSVC_INTERNAL, DSVC_MODULE_ERR