ページの先頭行へ戻る
Systemwalker Centric Manager API・スクリプトガイド
第2部 API > 第4章 APIリファレンス > 4.16 Mp_GetMsgMap（）関数【Windows版】
前次

4.16 Mp_GetMsgMap（）関数【Windows版】

機能説明

Mp_ReadMsg（）関数発行後にメッセージの受信が完了し、Mp_GetMsgMap（）関数を呼び出すことにより、メッセージのデータを取り出します。

呼び出し形式

#include <mp_opagt_api.h>
BOOL Mp_GetMsgMap( fp,buf,hostxflg,level,time1,node,NodeID,DatabaseID,
                 time2,category,msgtext,blkno,msgtype,ostype,
                 submsgnum,voicenum,msgcolor,backcolor,domtype,
                 domnum,replyid,systype,ext );

HANDLE fp;                /* Mp_OpenMsg()で獲得したハンドル        */
                          /* を指定する                            */
void  *buf;               /* Mp_ReadMsg()で指定したバッファ        */
                          /* を指定する                            */
unsigned char *hostxflg;  /* 強制表示フラグ                        */
short *level;             /* メッセージの重要度格納領域のア        */
                          /* ドレスを指定する                      */
                          /* 1:最重要 2:重要 3:一般 4:警告5:通知   */
time_t *time1;            /* メッセージが自システムに通知さ        */
                          /* れた日時格納領域のアドレスを指        */
                          /* 定する                                */
char  *node;              /* メッセージが出力されたシステム        */
                          /* 名格納領域のアドレスを指定する        */
DWORD      *NodeID;       /* リザーブ領域                          */
DWORD      *DatabaseID;   /* リザーブ領域                          */
time_t *time2;            /* メッセージが出力された日時格納        */
                          /* 領域のアドレスを指定する              */
char  *category;          /* メッセージの種別格納領域のアド        */
                          /* レスを指定する                        */
char  *msgtext;           /* メッセージ格納領域のアドレスを        */
                          /* 指定する                              */
unsigned short *blkno;    /* メッセージのブロック番号格納領        */
                          /* 域のアドレスを指定する                */
unsigned short *msgtype;  /* メッセージ種別格納領域のアドレ        */
                          /* スを指定する                          */
unsigned short *ostype;   /* OS種別格納領域のアドレスを指定        */
                          /* する                                  */
unsigned short*submsgnum; /* 補助説明文番号格納領域のアドレ        */
                          /* スを指定する                          */
unsigned short *voicenum; /* 音声番号格納領域のアドレスを指        */
                          /* 定する                                */
unsigned char  *msgcolor; /* 文字色格納領域のアドレスを指定        */
                          /* する                                  */
unsigned char *backcolor; /* 背景色格納領域のアドレスを指定        */
                          /* する                                  */
unsigned short *domtype;  /* DOM種別格納領域のアドレスを指定       */
                          /* する                                  */
long  *domnum;            /* DOM番号格納領域のアドレスを指定       */
                          /* する                                  */
char  *replyid;           /* 返答識別子格納領域のアドレスを        */
                          /* 指定する                              */
unsigned char  *systype;  /* 系区別格納領域のアドレスを指定        */
                          /* する                                  */
EXTENDDATA     *ext;      /* 拡張データ格納領域のアドレスを        */
                          /* 指定する                              */

パラメタ

fp:

Mp_OpenMsg（）で獲得したハンドルを指定します。

buf:

Mp_ReadMsg（）で指定したバッファを指定します。

hostxflg:

リザーブ領域。Charの領域を作成し、そのアドレスを指定してください。

level:

発生したメッセージの重要度レベルが格納されます。

MPOP_RE_SPEMG:

最重要

MPOP_RE_EMG:

重要

MPOP_RE_WARN:

警告

MPOP_RE_NOTICE:

通知

MPOP_RE_MSG:

一般
なお、メッセージ種別(msgtype)が、OP_APIMSGTYPESTAT, OP_APIMSGTYPESTOP, OP_APIMSGTYPECHNGのときは、必ずMPOP_RE_MSGが格納されます。

time1:

システム監視エージェントサービスが、メッセージログファイルに格納した日時が格納されます。
Mp_OpenMsg（）直後に通知されるメッセージには、以下の値が格納されます。
システム監視エージェント起動メッセージには、システム監視エージェントが、Mp_ReadMsg（）に通知した日時が格納されます。
ただし、日時が正しく獲得できなかった場合は、0x00FFFFFFが設定されます。

node:

メッセージが発生したシステムのノード名が格納されます。
MPOP_NODENAMELENバイト分呼び出し元で準備します。

time2:

nodeで示されたシステムで、メッセージが出力された日時が格納されます。
ただし、日時が正しく獲得できなかった場合は、以下のように値が設定されます。

日付、時刻が獲得できない/項目がない場合:

0x00FFFFFF

日付だけ獲得できない場合:

0x00hhmmss

hh:

時(0x00～0x17)

mm:

分(0x00～0x3B)

ss:

秒(0x00～ox3B)

category:

発生したメッセージの監視イベント種別が格納されます。
MPOP_CATEGORYLENバイト分呼び出し元で準備します。

msgtext:

発生したメッセージテキストが格納されます。
2048バイト分呼び出し元で準備します。メッセージ長が2047バイトを超える場合は、2047バイト以降は破棄されます。

blkno:

マルチラインメッセージのように、複数のメッセージで意味を持つ場合に、複数メッセージをブロック化するための番号が格納されます。
単一メッセージの場合は、OP_ONLYBLK(0x0000)が格納され、マルチラインメッセージの場合は、0x0001～0xFFFFが格納されます。
ブロックの最後のメッセージには、必ずOP_MLTBLK_END(0xFFFF)が格納されます。

msgtype:

発生したメッセージのメッセージ種別が格納されます。メッセージ種別を以下に示します。

OP_APIMSGTYPENORM:

通常メッセージ

OP_APIMSGTYPEREP:

返答要求メッセージ

OP_APIMSGTYPEHB:

高輝度メッセージ

OP_APIMSGTYPEDEL:

メッセージ削除データ（以下、DOMデータという）

OP_APIMSGTYPESTAT:

システム監視エージェントサービス起動メッセージ

OP_APIMSGTYPESTOP:

システム監視エージェントサービス停止メッセージ

OP_APIMSGTYPECHNG:

システム状態変更メッセージ

ostype:

発生したメッセージのOS種別が格納されます。
OS種別を以下に示します。

OP_UXPDS :

UXP/DS

OP_SOLARIS1 :

Solaris1.x系

OP_SOLARIS2 :

Solaris2.x系

OP_HPUX10:

HP-UX

OP_AIX :

AIX

OP_MVS :

MVS

OP_LINUX :

Linux

OP_UXPM :

UXP/M

OP_UXPVPP :

UXP/VPP

OP_WINDOWS2000:

Windows(R) 2000

OP_WINDOWSNT :

Windows NT(R)

OP_WINNTSERVER:

Windows NT(R) Server

OP_WINNTWS:

Windows NT(R) Workstation

OP_WINDOWS31 :

Windows(R) 3.1, Windows(R) 3.11, Windows(R) 3.11 WorkGroup

OP_WINDOWS95 :

Windows(R) 95

OP_WINDOWS98 :

Windows(R) 98

OP_WINDOWSXP:

Windows(R) XP

OP_WINDOWSXPPRO:

Windows(R) XP Professional

OP_WINDOWSXPHOME:

Windows(R) XP Home Edition

OP_SXO :

SXO

OP_SYMFOWAREPS :

Symfoware(R) Parallel Server

OP_RAID :

RAID

OP_MSPE20 :

MSP E20

OP_MSPAF2 :

MSP AFII

OP_XSPAF2 :

XSP AFII

OP_AVMEX :

AVM/EX

OP_FTOPS2 :

SVPM（FTOPS-II）

OP_MVSG :

MVS 系（IBMおよび他社互換機）

OP_MSERV :

ホスト連携オプション

OP_ASP :

ASP

OP_WINDOWSSV2003 :

Windows Server(R) 2003

OP_WINDOWSSV2003STD :

Windows Server(R) 2003,Standard Edition

OP_WINDOWSSV2003ENT :

Windows Server(R) 2003,Enterprise Edition

OP_WINDOWSSV2003DATA :

Windows Server(R) 2003,Datacenter Edition

OP_WINDOWSSV2003WEB :

Windows Server(R) 2003,Web Edition

OP_WINDOWSVISTA:

Windows Vista(R)

OP_WINDOWSVISTAUL:

Windows Vista(R) Ultimate

OP_WINDOWSVISTAENT:

Windows Vista(R) Enterprise

OP_WINDOWSVISTABIZ:

Windows Vista(R) Business

OP_WINDOWSVISTAHP:

Windows Vista(R) Home Premium

OP_WINDOWSVISTAHB:

Windows Vista(R) Home Basic

OP_WINDOWSSV2008:

Windows Server(R) 2008

OP_WINDOWSSV2008STD:

Windows Server(R) 2008 Standard

OP_WINDOWSSV2008ENT:

Windows Server(R) 2008 Enterprise

OP_WINDOWSSV2008DATA:

Windows Server(R) 2008 Datacenter

OP_WINDOWSSV2008STDWOHV:

Windows Server(R) 2008 Standard without Hyper-V

OP_WINDOWSSV2008ENTWOHV:

Windows Server(R) 2008 Enterprise without Hyper-V

OP_WINDOWSSV2008DATAWOHV:

Windows Server(R) 2008 Datacenter without Hyper-V

OP_WINDOWSSV2008ITANIUM:

Windows Server(R) 2008 for Itanium-Based systems

OP_WINDOWSSV2008WEBSV:

Windows(R) Web Server 2008

OP_HVSV2008:

Microsoft(R) Hyper-V Server 2008

OP_WINDOWSSV2008FD:

Windows Server(R) 2008 Foundation

OP_WINDOWS7:

Windows(R) 7

OP_WINDOWS7UL:

Windows(R) 7 Ultimate

OP_WINDOWS7ENT:

Windows(R) 7 Enterprise

OP_WINDOWS7PRO:

Windows(R) 7 Professional

OP_WINDOWS7HP:

Windows(R) 7 Home Premium

OP_WINDOWS7STNOTE:

Windows(R) 7 Starter for Small Notebook PCs

OP_OS_UNKNOWN :

不明

submsgnum:

GEEおよびUNIX版集中監視マネージャのGS連携オプションが使用する、メッセージの補助説明文の番号が格納されます。
この値は、GEEおよびGS連携オプション以外では使用しません(Windowsでは無効)。

voicenum:

UNIX版集中監視マネージャで音声を出力する場合の、音声に対する番号が格納されます。
音声出力機能は未サポートです(Windowsでは無効)。

msgcolor:

[Systemwalkerコンソール]の[監視イベント一覧]に表示する、メッセージの文字の色が格納されます。
文字色の種類を以下に示します。

OP_COLOR_BLACK :

黒色

OP_COLOR_WHITE :

白色

OP_COLOR_RED :

赤色

OP_COLOR_GREEN :

緑色

OP_COLOR_BLUE :

青色

OP_COLOR_YELLOW :

黄色

OP_COLOR_LIGHTBLUE :

明青色

OP_COLOR_PURPLE :

紫色

OP_COLOR_DARKGRAY :

濃い灰色

OP_COLOR_ORANGE :

黄緑色

OP_COLOR_SKYBLUE :

空色

OP_COLOR_PINK :

桃色

OP_COLOR_PALEGREEN :

青緑色

OP_COLOR_BROWN :

茶色

OP_COLOR_GRAY :

淡い灰色

OP_COLOR_CREAM :

黄土色

OP_COLOR_DEF :

メッセージ属性に応じた初期設定色

backcolor:

[Systemwalkerコンソール]の[監視イベント一覧]に表示する、メッセージの背景色が格納されます。
文字色の種類は、msgcolorと同じです。

domtype:

返答要求メッセージ、および高輝度メッセージの種類が格納されます。
これは、返答要求メッセージ、高輝度メッセージ、およびDOM対応メッセージとDOMデータとの対応をとるために使用します。
DOM種別を以下に示します。

OP_NORMDOM :

返答要求メッセージおよび高輝度メッセージ以外。

OP_NIPDOM :

NIPDOM。MSPのNIP時のメッセージ、およびDOMデータです（Windowsでは無効）。

OP_MSPDOM :

MSPDOM。MSPの通常時のメッセージ、およびDOMデータです（Windowsでは無効）。

OP_XSPDOM :

XSPのNIP時以外の返答要求メッセージ、高輝度メッセージ、およびDOMデータです（Windowsでは無効）。

OP_WORKITDOM :

WORKITDOM。BS*NET/WORKITが通知する返答要求メッセージ、およびDOMデータです。

OP_ASPDOM:

ASPが通知する返答要求メッセージ、高輝度メッセージ、およびDOMデータです。

OP_APLDOM:

Systemwalker Centric Managerアプリケーションが通知するDOM対応メッセージ、およびDOMデータです。

OP_GENERALDOM:

一般のアプリケーションが通知するDOM対応メッセージ、およびDOMデータです。

domnum:

返答要求メッセージ、および高輝度メッセージの場合に、メッセージとDOMデータとの対応をとるための番号が格納されます。
この番号は、メッセージ発生システム内でDOM種別ごとに一意です。

replyid:

返答要求メッセージに対してコマンドで返答するときの、メッセージを識別する文字列が格納されます。
9バイト分呼び出し元で準備します。

systype:

ホットスタンバイシステムの場合に、メッセージが発生した時点での運用系、待機系の区別が格納されます。
運用系および待機系の区別を以下に示します。

OP_SYSTYPE_NORM:

ホットスタンバイシステムではない。
または、ホットスタンバイシステムですが、運用系、待機系がまだ決定していない。

OP_SYSTYPE_MAIN:

ホットスタンバイシステムの運用系です。

OP_SYSTYPE_SUB:

ホットスタンバイシステムの待機系です。

OP_SYSTYPE_WP:

Windows NT(R) のマイクロソフトクラスタシステムの運用。

ext:

発生したメッセージの拡張データが格納されます。

構造体の説明

拡張データ(EXTENDDATA)の形式

/*
 *  EXTEND DATA
*/
typedef struct _EXTENDDATA {
   char       runtype[MPOP_RUNTYPELEN];
   unsigned char mailmsgflg;
   char       rsv1[2];
   DWORD      DatabaseID;
   unsigned   int     IPaddr;
   DWORD      DMInstallType;
   DWORD      JMInstallType;
   DWORD      MW_DM_vl;
   char       MW_DM_suffix[MPOP_SUFFIXLEN];
   char       MW_DM_updatenum[MPOP_UPDATENUMLEN];
   DWORD      MW_JM_vl;
   char       MW_JM_suffix[MPOP_SUFFIXLEN];
   char       MW_JM_updatenum[MPOP_UPDATENUMLEN];
   unsigned   char    auttrbtkt;
   char       domkey[MPOP_DOMKEYLEN];
}  EXTENDDATA;
runtype:

メッセージが発生したシステムの運用形態名が格納されます。

mailmsgflg:

発生したメッセージのメール連携フラグが格納されます。

OP_NOMAILMSG:

メール連携機能を使用していないメッセージです。

OP_MAILMSG:

メール連携機能により通知されたメッセージです。

domkey:

DOM拡張キーが格納されます。
DOM拡張キーがない場合は、NULLが設定されます。

DatabaseID:

リザーブ領域。

IPaddr:

メッセージが発生したシステムのIPアドレスが格納されます。
アドレスがない場合は、0が格納されます。

IPaddr:

メッセージが発生したシステムのIPアドレスが格納されます。

DMInstallType:

メッセージが発生したシステムのSystemwalker Centric Managerのインストールタイプが格納されます。

JMInstallType:

メッセージが発生したシステムのSystemwalker Operation Managerのインストールタイプが格納されます。

MW_DM_vl:

メッセージが発生したシステムのSystemwalker Centric Managerのメジャーバージョン、マイナーバージョン、メジャーレベルが格納されます。

 ０ｘ００００００００       a) メジャーバージョン
         ←→←→←→       b) マイナーバージョン
          a)  b)  c)        c) メジャーレベル
MW_DM_suffix:

メッセージが発生したシステムのSystemwalker Centric Managerのサフィックスが格納されます。

MW_DM_updatenum:

メッセージが発生したシステムのSystemwalker Centric Managerのアップデートパック修正番号が格納されます。

MW_JM_vl:

メッセージが発生したシステムのSystemwalker Operation Managerのメジャーバージョン、マイナーバージョン、メジャーレベルが格納されます。
形式は、MW_DM_vlと同様です。

MW_JM_suffix:

メッセージが発生したシステムのSystemwalker Operation Managerのサフィックスが格納されます。

MW_JM_updatenum:

メッセージが発生したシステムのSystemwalker Operation Managerのアップデートパック修正番号が格納されます。

Auttrbtkt:

リザーブ領域。

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

【Windows版】

参照

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

復帰値

TRUE:

正常終了。メッセージを正常に受信。

FALSE:

異常終了。詳細なエラーコードは、GetLastError（）で取得してください。

API格納場所

“監視メッセージのAPI”を参照してください。

注意事項

拡張データの各メンバの値は、SystemWalker/CentricMGR V4.0L10以前のシステムで発生したメッセージには設定されません。

動作環境による差異

以下のインストール種別で使用可能です。

前次
Copyright 1995-2010 FUJITSU LIMITED