4.69 ORMMessage（）関数【UNIX版】

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

目次索引

第2部 API

> 第4章 APIリファレンス

4.69 ORMMessage（）関数【UNIX版】

■機能説明

運用管理サーバにメッセージの通知のみを行います。ORMRequest()APIによる返答要求メッセージの前後に、関連メッセージを通知する場合に使用します。

■呼び出し形式

  
#include " ORMessage.h"
int  ORMMessage (char *apname, char *msg)

■パラメタ

char *apname:: 要求元名(任意の文字列)を示す文字列です。最終文字のNULL文字を含め、最大文字数は32バイトです。指定可能な文字は半角英数字のみです。なお、要求元名には、1バイト以上の文字列を、必ず設定する必要があります。
char *msg:: NULLで終わるメッセージ文字列です。最大文字数はNULL文字を含めて1024バイトです。なお、メッセージ文字列には、1バイト以上の文字列を必ず設定する必要があります。

■復帰値

PR_OK(0):: 正常終了しました。
PR_ERR_PARAM(-1):: パラメタエラーが発生しました。
PR_STOP(-3):: Open ReplyMessageサービスがユーザ要求により停止しました。
PR_ERR_CONECT(-11):: Open ReplyMessageサービスと接続できません
PR_ERR_SEND(-12):: Open ReplyMessageサービスへの送信はできませんでした。
PR_ERR_RCV(-13):: Open ReplyMessageサービスからの応答を受信できませんでした。
PR_ERR_ORMSTOP(-26):: Open ReplyMessageサービスの緩和停止中のため受け付けできません。
PR_ERR_UEXPCT(-99):: 予期せぬエラーが発生しました。

■参照

メッセージ返答要求・返答API、ORMRequest（）関数を参照してください。

■API格納場所

Solaris	/usr/lib
Linux	/usr/lib

■INCLUDE格納場所

Solaris	/usr/include
Linux	/usr/include

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

環境: 運用管理サーバ/部門管理サーバ/業務サーバで実行可能です。

■注意事項

メッセージのエラー種別は、情報となります。そのため、監視イベント一覧画面には、このAPIで発行されたメッセージは表示されません。メッセージ一覧画面に表示されます。以下にメッセージフォーマットとメッセージの形式を示します。
- メッセージフォーマット
  SWORM : INFO: 要求元メッセージ
- メッセージの形式
  ラベル：SWORM 重要度：一般エラー種別：情報監視イベント種別：システム
メッセージ、および応答内容の文字コードはシステムに設定されているロケールの文字コードを使用します。
COBOLからのCALL命令を用いたAPI呼び出しはCOBOL97仕様以降のCOBOLに対応しています。

■使用例

◆C言語によるプログラム例

オペレータに『返答文字列にエラーが発生しました。』というメッセージをORMSampleというサーバプログラムから発行します。

  
//ORMSample.c（サーバプログラム）

int main(int argc, char **argv){

  ret = ORMMessage
          ( "ORMSample",                            /* 要求元名   */
            "返答文字列にエラーが発生しました。" );  /* メッセージ */
}

◆COBOLによるプログラム例

APP1.cob(サーバプログラム)は、オペレータに『返答文字列にエラーが発生しました。』というメッセージをAPP1というサーバプログラムから発行します。

  
*APP1.cob（サーバプログラム）
000010 IDENTIFICATION   DIVISION.
000020 PROGRAM-ID.      APP1.
000030 ENVIRONMENT      DIVISION.
000040 DATA             DIVISION.
000050 WORKING-STORAGE  SECTION.
000060 01  CALLINFO.
000070     03  SUB-PG       PIC X(256).                        *API名
000080     03  APNAME       PIC X(32).                         *呼び出し元AP名
000090     03  MSG          PIC X(1024).                       *表示メッセージ
000100     03  RETURNVALUE  PIC S9(09) COMP-5 VALUE 0.         *API復帰値
000110 PROCEDURE        DIVISION.
000120*初期化部
000130     INITIALIZE CALLINFO.
000140     MOVE "ORMMessage"  TO SUB-PG.                       *API名のセット
000150     MOVE LOW-VALUE     TO SUB-PG(11:).                  *終端文字のセット
000160     MOVE "APP1"        TO APNAME.                       *呼び出し元AP名のセット
000170     MOVE LOW-VALUE     TO APNAME(5:).                   *終端文字のセット
000180     MOVE "返答文字列にエラーが発生しました。" TO MSG.   *メッセージのセット
000190     MOVE LOW-VALUE     TO MSG(35:).                     *終端文字のセット
000200*API呼び出し
000210     CALL SUB-PG                                         *API呼び出し
000220         USING
000230             BY  REFERENCE   APNAME
000240             BY  REFERENCE   MSG
000250         RETURNING RETURNVALUE
000260     END-CALL.
000270     STOP RUN.

目次索引