はじめに

このマニュアルは，JP1/Baseの機能を拡張してJP1/IMと連携するシステムを開発する際に必要な，JP1/Baseの提供する関数の詳細および作業の手順について説明したものです。このマニュアルは各OS共通のマニュアルです。OSごとに差異がある場合は，本文中でそのつど内容を書き分けています。

〈はじめにの構成〉

対象読者
マニュアルの構成
JP1/Baseマニュアルの使い分けについて
コマンドの文法で使用する記号
JP1/Baseのインストール先フォルダの表記
このマニュアルで使用する「Administrators権限」について
このほかの参考情報

■ 対象読者

このマニュアルは，JP1/IMとJP1/Baseを使ってJP1/IMと連携するシステムを開発するソフトウェア開発者の方を対象としています。また，JP1/IMおよびJP1/Baseの機能を理解していることを前提としています。

ページの先頭へ

■ マニュアルの構成

このマニュアルは，次に示す編から構成されています。

第1編　概要: JP1/Baseの機能を拡張してできることの概要について説明しています。
第2編　運用: JP1/Baseの機能を拡張する方法について説明しています。
第3編　リファレンス: JP1/Baseの関数についてリファレンス形式で説明しています。

ページの先頭へ

■ JP1/Baseマニュアルの使い分けについて

JP1/Baseのマニュアルは3冊に分かれています。次に示す表で各マニュアルの記載内容をご確認の上，利用目的に合わせてマニュアルをお読みください。

マニュアル名	記載内容
JP1/Base 運用ガイド	JP1/Baseの概要・機能各機能の設定コマンド，定義ファイル，JP1イベントトラブルシューティングプロセス，ポート番号，操作ログ
JP1/Base メッセージ	メッセージ
JP1/Base 関数リファレンス	JP1プログラムやユーザーアプリケーションでJP1イベントを発行・取得する方法関数

ページの先頭へ

■ コマンドの文法で使用する記号

コマンドとパラメーターの説明で使用する記号を，次のように定義します。

記号	意味
｜ (ストローク)	複数の項目に対し，項目間の区切りを示し，「または」の意味を示す。（例）「A｜B｜C」は，「A，BまたはC」を示す。
｛　｝	この記号で囲まれている複数の項目の中から，必ず1組の項目を選択する。項目の区切りは｜で示す。（例）｛A｜B｜C｝は「A，BまたはCのどれかを指定する」ことを示す。
[　]	この記号で囲まれている項目は任意に指定できる（省略してもよい）。複数の項目が記述されている場合には，すべてを省略するか，どれか一つを選択する。（例） [A]は「何も指定しない」か「Aを指定する」ことを示す。 [B｜C]は「何も指定しない」か「BまたはCを指定する」ことを示す。
… (点線)	この記号の直前に示された項目を繰り返して複数個，指定できる。（例）「A，B，…」は「Aの後にBを必要な個数だけ指定する」ことを示す。
（　）	この記号で囲まれている項目をグループ化したことを示す。（例）（A`\|`B）は，AまたはBを1個以上指定することを示す。
△	空白を空けることを意味する。（例） AAA△BBBは「AAA」と「BBB」の間に1個の空白を入れることを示す。
`\`	上記の文字を指定値として使用する場合には，「`\`」を前に付けて表現する。（例）「`\|`」の文字を指定値として使いたい場合には「`\\|`」と表記する。

記号

意味

｜

(ストローク)

複数の項目に対し，項目間の区切りを示し，「または」の意味を示す。

（例）

「A｜B｜C」は，「A，BまたはC」を示す。

｛　｝

この記号で囲まれている複数の項目の中から，必ず1組の項目を選択する。項目の区切りは｜で示す。

（例）

｛A｜B｜C｝は「A，BまたはCのどれかを指定する」ことを示す。

[　]

この記号で囲まれている項目は任意に指定できる（省略してもよい）。

複数の項目が記述されている場合には，すべてを省略するか，どれか一つを選択する。

（例）

[A]は「何も指定しない」か「Aを指定する」ことを示す。

[B｜C]は「何も指定しない」か「BまたはCを指定する」ことを示す。

…

(点線)

この記号の直前に示された項目を繰り返して複数個，指定できる。

（例）

「A，B，…」は「Aの後にBを必要な個数だけ指定する」ことを示す。

（　）

この記号で囲まれている項目をグループ化したことを示す。

（例）

（A|B）は，AまたはBを1個以上指定することを示す。

△

空白を空けることを意味する。

（例）

AAA△BBBは「AAA」と「BBB」の間に1個の空白を入れることを示す。

\

上記の文字を指定値として使用する場合には，「\」を前に付けて表現する。

（例）

「|」の文字を指定値として使いたい場合には「\|」と表記する。

ページの先頭へ

■ JP1/Baseのインストール先フォルダの表記

このマニュアルでは，JP1/Baseのインストール先フォルダを次のように表記しています。

製品名	インストール先フォルダの表記	インストール先フォルダ^※
JP1/Base	インストール先フォルダ	x86環境の場合システムドライブ`:\Program Files\Hitachi\JP1Base` x64環境の場合システムドライブ`:\Program Files (x86)\Hitachi\JP1Base`

注※　各製品を初期設定のままインストールした場合のインストール先フォルダを表しています。「システムドライブ:\ProgramData」と表記している部分は，インストール時のOS環境変数によって決定されるため，環境によって異なる場合があります。

（例）

ソースファイルのコンパイル時に必要なヘッダーファイル，JevApi.hのフルパス表記は，マニュアルでは次のようになります。

インストール先フォルダ\include\JevApi.h

x86環境で初期設定のままインストールした場合，実際にはシステムドライブ:\Program Files\Hitachi\JP1Base\include\JevApi.hとなります。

ページの先頭へ

■ このマニュアルで使用する「Administrators権限」について

このマニュアルで表記している「Administrators権限」とは，ローカルPCに対するAdministrators権限です。ローカルPCに対してAdministrators権限を持つユーザーであれば，ローカルユーザー，ドメインユーザー，およびActive Directory環境で動作に違いはありません。

ページの先頭へ

■ このほかの参考情報

このほかの参考情報については，マニュアル「JP1/Base 運用ガイド」の「このマニュアルの参考情報」を参照してください。

ページの先頭へ