機能説明
本関数は、以下の機能を提供します。
Interstage運用API環境を初期化します。運用APIの初期化は、アプリケーションで1度だけ発行してください。
Interstage運用API環境を回収します。運用API環境の回収は、アプリケーションで1度だけ発行してください。
形式
#include “ISOP.h” void ISOPenv(char *reqparm)
引数reqparmは、パラメタ構造体を指すポインタです。パラメタ構造体は使用する機能ごとに、指定された形式の構造体を獲得し、設定してください。
パラメタ構造体へのポインタをchar*型にキャストして、引数としてください。
獲得した領域は、あらかじめゼロクリアしてください。
1)Interstage運用API環境初期化
下記のISOP_CTRL構造体を獲得し、パラメタを設定してください。
typedef struct _isop_ctrl_t { /* 基本情報制御表定義 */ long request; /* 要求コード */ unsigned long pktvl; /* 本制御表のバージョン情報 */ long result; /* 実行結果 */ long detail; /* 原因コード */ char sysname[12]; /* 操作対象システム(Solarisのみ) */ char rsv[52]; /* リザーブ */ } ISOP_CTRL;
メンバ名 | 型 | 設定値 | 意味 |
---|---|---|---|
request | long | ISOP_RINIENV | 要求コード: |
pktvl | unsigned long | ISOP_006 | 制御表のバージョン情報 |
| char | システム名 | 操作対象とするシステム名 |
注)
システム名が省略された場合は、環境変数IS_SYSTEMに設定されているシステム名が有効となります。システム名と環境変数IS_SYSTEMが省略された場合は、デフォルトシステムが有効となります。
メンバ名 | 型 | 復帰値 | 意味 |
---|---|---|---|
pktvl(注1) | unsigned long | ISOP_006 | 復帰した制御表のバージョン情報 |
result | long | 0 | 正常終了 |
-1 | 異常終了 | ||
detail(注2) | long | 原因コード | エラーの詳細情報(実行結果詳細値を参照) |
注1)
APIが復帰時に通知する制御表のバージョン情報については、“OLTPサーバ運用ガイド”を参照してください。
注2)
異常終了した場合はdetailのみ正しい値を設定します。その他の値の内容は不定です。
define値 | 値 | 意味 |
---|---|---|
ISOP_EINVAL_REQ | 2101 | 要求コードに誤りがあります。 |
ISOP_ENOMEM | 3002 | メモリ不足が発生しました。 |
ISOP_ESYSERR | 4001 | システムエラー。 |
ISOP_ESTPIS | 4102 | Interstageが起動されていません。 |
| 4110 | 操作対象システムが存在しません。(注) |
| 4111 | 異なるシステムに対して環境初期化APIを発行しました。現在、環境初期化済みのシステムに対して、環境回収APIを発行後、再度発行してください。(注) |
注)
pktvlがISOP_005以降の場合に有効。
2)Interstage運用API環境回収
下記のISOP_CTRL構造体を獲得し、パラメタを設定してください。
typedef struct _isop_ctrl_t { /* 基本情報制御表定義 */ long request; /* 要求コード */ unsigned long pktvl; /* 本制御表のバージョン情報 */ long result; /* 実行結果 */ long detail; /* 原因コード */ char sysname[12]; /* 操作対象システム(Solarisのみ)*/ char rsv[52]; /* リザーブ */ } ISOP_CTRL;
メンバ名 | 型 | 設定値 | 意味 |
---|---|---|---|
request | long | ISOP_RTRMENV | 要求コード: |
pktvl | unsigned long | ISOP_006 | 制御表のバージョン情報 |
メンバ名 | 型 | 復帰値 | 意味 |
---|---|---|---|
pktvl(注1) | unsigned long | ISOP_006 | 復帰した制御表のバージョン情報 |
result | long | 0 | 正常終了 |
-1 | 異常終了 | ||
detail(注2) | long | 原因コード | エラーの詳細情報(実行結果詳細値を参照) |
注1)
APIが復帰時に通知する制御表のバージョン情報については、“OLTPサーバ運用ガイド”を参照してください。
注2)
異常終了した場合はdetailのみ正しい値を設定します。その他の値の内容は不定です。
define値 | 値 | 意味 |
---|---|---|
ISOP_ENOINIT | 2003 | API環境が初期化されていません。 |
ISOP_EINVAL_REQ | 2101 | 要求コードに誤りがあります。 |
ISOP_ESYSERR | 4001 | システムエラー。 |
ISOP_ESTPIS | 4102 | Interstageが起動されていません。 |
| 4107 | 割り込みが発生しました 。 |
注意事項
本関数を使用するには、isstartコマンドを使用し、Interstageの起動を行う必要があります。各コンポーネントから提供されている起動コマンドは使用しないでください。
なお、クラスタ構成で運用する場合には、isstartコマンドを使用する必要はありません。