4.20 Mp_OpenEventLog（）関数

Systemwalker Centric Manager API・スクリプトガイド - UNIX/Windows(R)共通 -

目次索引

第2部 API

> 第4章 APIリファレンス

4.20 Mp_OpenEventLog（）関数

■機能説明

Mp_OpenEventLog（）関数を発行することにより、ロギングされた過去の監視イベントの読み出しを要求します。

■呼び出し形式

【Windows for Itanium版で64ビットのアプリケーションを作成する場合】

  
#include <mp_opmgr_api.h>
HANDLE    Mp_OpenEventLog( rdmode, strhisnum, endhisnum,
                              nodename,NodeID, DatabaseID,
                              category, status,level, evttype );

DWORD     rdmode;     /* 監視イベントの読み出し方向を指定する*/
long      strhisnum;  /* 読み出し開始監視イベント番号を指定  */
                      /* する                                */
long      endhisnum;  /* 読み出し終了監視イベント番号を指定  */
                      /* する                                */
char      *nodename;  /* 読み出しイベントのノード名を指定する*/
DWORD     NodeID;     /* リザーブ領域                        */
DWORD     DatabaseID; /* リザーブ領域                        */
char      *category;  /* 読み出しイベントの種別を指定する    */
DWORD     status;     /* 読み出しイベントの状態指定する      */
DWORD     level;      /* 読み出しイベントの重要度レベルを指定*/
                      /* する                                */
DWORD     evttype;    /* 読み出しイベントの属性を指定する    */

【Windows for Itanium版以外の場合】

  
#include <mp_opmgr_api.h>
int    Mp_OpenEventLog( rdmode, strhisnum, endhisnum, nodename,
                        NodeID, DatabaseID, category, status, 
                        level, evttype );

DWORD     rdmode;     /* 監視イベントの読み出し方向を指定する*/
long      strhisnum;  /* 読み出し開始監視イベント番号を指定  */
                      /* する                                */
long      endhisnum;  /* 読み出し終了監視イベント番号を指定  */
                      /* する                                */
char      *nodename;  /* 読み出しイベントのノード名を指定する*/
DWORD     NodeID;     /* リザーブ領域                        */
DWORD     DatabaseID; /* リザーブ領域                        */
char      *category;  /* 読み出しイベントの種別を指定する    */
DWORD     status;     /* 読み出しイベントの状態指定する      */
DWORD     level;      /* 読み出しイベントの重要度レベルを指定*/
                      /* する                                */
DWORD     evttype;    /* 読み出しイベントの属性を指定する    */

【UNIX版（Linux for Itanium版を除く）の場合】

  
#include <mp_opmgr_api.h>
int    Mp_OpenEventLog( rdmode, strhisnum, endhisnum, nodename,
                        NodeID, DatabaseID, category, status, 
                        level, evttype );

unsigned long rdmode; /* 監視イベントの読み出し方向を指定する*/
long     strhisnum;   /* 読み出し開始監視イベント番号を指定  */
                      /* する                                */
long     endhisnum;   /* 読み出し終了監視イベント番号を指定  */
                      /* する                                */
char     *nodename;   /* 読み出しイベントのノード名を指定する*/
unsigned long NodeID; /* リザーブ領域                        */
unsigned long DatabaseID; /* リザーブ領域                    */
char     *category;   /* 読み出しイベントの種別を指定する    */
unsigned long status; /* 読み出しイベントの状態指定する      */
unsigned long level;  /* 読み出しイベントの重要度レベルを指定*/
                      /* する                                */
unsigned long evttype;  /* 読み出しイベントの属性を指定する  */

【Linux for Itanium版】

  
#include <mp_opmgr_api.h>
long   Mp_OpenEventLog( rdmode, strhisnum, endhisnum, nodename,
                        NodeID, DatabaseID, category, status, 
                        level, evttype );

unsigned long rdmode; /* 監視イベントの読み出し方向を指定する*/
long     strhisnum;   /* 読み出し開始監視イベント番号を指定  */
                      /* する                                */
long     endhisnum;   /* 読み出し終了監視イベント番号を指定  */
                      /* する                                */
char     *nodename;   /* 読み出しイベントのノード名を指定する*/
unsigned long NodeID; /* リザーブ領域                        */
unsigned long DatabaseID; /* リザーブ領域                    */
char     *category;   /* 読み出しイベントの種別を指定する    */
unsigned long status; /* 読み出しイベントの状態指定する      */
unsigned long level;  /* 読み出しイベントの重要度レベルを指定*/
                      /* する                                */
unsigned long evttype;  /* 読み出しイベントの属性を指定する  */

■パラメタ

rdmode:

ロギングされた過去の監視イベントの読み出す方向を指定します。
このパラメタには、以下のモードフラグのどれかを指定します。

MPOP_OEL_NEWEVT:: ロギングされた最新の監視イベントから古いイベントへと読み出します。
MPOP_OEL_OLDEVT:: ロギングされた最古の監視イベントから新しいイベントへと読み出します。

strhisnum:

ロギングされた過去の監視イベントの読み出し開始監視イベント番号を指定します。監視イベント番号は、2,147,483,647以下の値です。
ロギングされている最古の監視イベント（rdmodeでMPOP_OEL_NEWEVTを指定した場合は、最新のイベント）から読み出す場合は、0を指定します。

endhisnum:

ロギングされた過去の監視イベントの読み出し終了監視イベント番号を指定します。監視イベント番号は、2,147,483,647以下の値です。
ロギングされている最新の監視イベント（rdmodeでMPOP_OEL_NEWEVTを指定した場合は、最古のイベント）まで読み出す場合は、0を指定します。

nodename:

読み出す監視イベントのノード名を128バイト以内で指定します。
ロギングされているすべてのシステムの監視イベントを読み出す場合には、MPOP_OEL_ALLNODENMを指定します。

category:

読み出す監視イベントの種別を、以下の範囲で指定します。
なお、ロギングされているすべての種別の監視イベントを読み出す場合には、MPOP_OEL_ALLCATEGを指定します。

【Windowsの場合】: 16バイト以内で指定します。
【UNIXの場合】: システムのデフォルトロケールがUTF-8の場合は32バイト以内で、それ以外の場合は16バイト以内で指定します。

status:

読み出す監視イベントの状態を指定します。
このパラメタには、以下のフラグを任意に組み合わせて指定します。

MPOP_OEL_NOFIXEVT:: “未対処”状態の監視イベントを読み出します。
MPOP_OEL_DEFEVT:: “保留”状態の監視イベントを読み出します。
MPOP_OEL_FIXEVT:: “対処済”状態の監視イベントを読み出します。
MPOP_OEL_REPEVT:: “返答済”状態の監視イベントを読み出します。
MPOP_OEL_ALLEVT:: ロギングされたすべての状態の監視イベントを読み出します。

level:

読み出す監視イベントの重要度レベルを指定します。
このパラメタに任意のフラグを任意に組み合わせて指定します。

MPOP_OEL_SPEMGLVL:: 最重要
MPOP_OEL_EMGLVL:: 重要
MPOP_OEL_WARNLVL:: 警告
MPOP_RE_NOTICE:: 通知
MPOP_OEL_ALLLVL:: ロギングされたすべての重要度レベルの監視イベントを読み出します。

evttype:

読み出す監視イベントの属性を指定します。
このパラメタには、フラグを任意に組み合わせて指定します。

MPOP_OEL_NORMTYP:: 属性が“一般”の監視イベントを読み出します。
MPOP_OEL_REPLYTYP:: 監視イベントの属性は“返答要求”
MPOP_OEL_SPCLTYP:: 監視イベントの属性は“高輝度”
MPOP_OEL_ALLTYP:: ロギングされたすべての属性の監視イベントを読み出します。

■実行に必要な権限/実行環境

【Windows版】

運用管理サーバでは、Administrator権限/DmAdmin権限/DmOperation/DmReference権限が必要です。
運用管理サーバで実行可能です。

【UNIX版】

運用管理サーバでは、システム管理者(スーパーユーザ)権限が必要です。
運用管理サーバで実行可能です。

■参照

以下のシステム監視のAPIを参照してください。

Mp_ReadEventLog（）関数
Mp_CloseEventLog（）関数

■復帰値

－1以外:: 正常終了。監視イベントを読み出すためのファイル識別子。
－1:: 異常終了。

備考

異常終了した場合の詳細なエラーコードは、以下の方法で取得/参照してください。

【Windows版】: GetLastError（）で取得してください。
【UNIX版】: エラーコードは、errnoに設定されます。
errnoにはシステムのエラーコード（/usr/include/sys/errno.hに定義）、または/opt/systemwalker/include/mp_operr_api.hに定義されている値が設定されます。

■API格納場所

“監視イベントのAPI”を参照してください。

■動作環境による差異

運用管理サーバだけで使用可能です。

目次索引