4.22 Mp_OpenMsg（）関数

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

目次索引

第2部 API

> 第4章 APIリファレンス

4.22 Mp_OpenMsg（）関数

■機能説明

Mp_OpenMsg（）関数を発行することにより、メッセージの通知を要求します。

■呼び出し形式

【Windows版】

  
#include <mp_opagt_api.h>
HANDLE  Mp_OpenMsg(node,NodeID,DatabaseID,mode);

char  *node;        /* 読み出しメッセージのノード名を指定する*/
DWORD  NodeID;      /* リザーブ領域                          */
DWORD  DatabaseID;  /* リザーブ領域                          */
int    mode;        /* モードを指定する                      */

【UNIX版】

  
#include <mp_opagt_api.h>
int Mp_OpenMsg(node,NodeID,DatabaseID,mode);

char  *node;              /* 読み出しメッセージのノード名を指*/
                          /* 定する                          */
unsigned long NodeID;     /* リザーブ領域                    */
unsigned long DatabaseID; /* リザーブ領域                    */
int    mode;              /* モードを指定する                */

■パラメタ

node:: 読み出すメッセージのノード名を128バイト以内で指定します。自システムで出力されたメッセージだけを要求する場合には、OWNNODEを指定してください。
自システムにメッセージを通知しているすべてのシステムで出力されたメッセージを要求する場合には、ALLNODEを指定してください。
mode:: メッセージを受信する際のモードを指定します。
必ず0を指定してください。

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

【Windows版】

運用管理サーバ/部門管理サーバ/業務サーバでは、Administrator権限/DmAdmin権限/DmOperation権限/DmReference権限が必要です。
運用管理クライアント/クライアントでは、一般ユーザ権限で実行可能です。
運用管理サーバ/部門管理サーバ/業務サーバで実行可能です。
運用管理クライアント/クライアントでは、[イベント監視]を選択インストールしたとき実行可能です。

【UNIX版】

運用管理サーバ/部門管理サーバ/業務サーバではシステム管理者(スーパーユーザ)権限が必要です。
運用管理クライアント/クライアントでは、一般ユーザ権限で実行可能です。
運用管理サーバ/部門管理サーバ/業務サーバで実行可能です。
運用管理クライアント/クライアントでは、[イベント監視]を選択インストールしたとき実行可能です。

■参照

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

Mp_ReadMsg（）関数
Mp_CloseMsg（）関数
Mp_GetMsgMap（）関数【Windows版】

■復帰値

－1以外:: 正常終了。関数の復帰値はメッセージを読み出すためのハンドル、またはファイル記述子（Mp_ReadMsg（）で使用）。
－1:: 異常終了。

備考

マイナス復帰した場合の詳細なエラーコードは、以下の方法で取得/参照してください。

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

■API格納場所

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

■動作環境による差異

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

運用管理サーバ
部門管理サーバ
業務サーバ
運用管理クライアント:Windows(R) 2000/ Windows NT(R)/ Windows(R) XP(注)/ Windows Vista(R)
クライアント　　　　:Windows(R) 2000/ Windows NT(R)/ Windows(R) XP(注)/ Windows Vista(R)
注)システム監視エージェントインストール選択時

目次索引