Systemwalker Centric Manager APIガイド - UNIX共通 -

3.12 Mp_GetActionInfo2（）関数

◆機能説明

指定されたアクションの現在の状態を通知します。

◆呼び出し形式

long Mp_GetActionInfo2(long handle,MpActionInfo2 **ActionInfo,int *nActionInfo)

◆パラメタ

handle:

アクションの管理番号（アクション実行APIの復帰値）を指定します。

ActionInfo:

アクション状態情報構造体（MpActionInfo2）を指定する領域のアドレスを指定します。
APIでアクション状態情報構造体が確保されます。本パラメタが指す領域にアクション状態情報構造体が設定されます。
アクション状態情報構造体は、アクション情報領域の解放API（Mp_FreeActionInfo2）で解放されます。

nActionInfo:

アクションの数を格納する領域のアドレスを指定します。本パラメタが指定する領域に、アクション状態情報構造体の配列数が設定されます。

◆構造体の説明

アクション状態情報構造体（MpActionInfo2）の形式

typedef struct MpActionInfo2_tag {
    long no ;
    long action ;
    char *exehost ;
    MpActionAddr *addr ;
    int  naddr ;
    int  status ;
    int  code ;
} MpActionInfo2 ;

no:

アクションの管理番号が設定されます。

action:

アクションの種類が設定されます。

ACTION_EMAIL:

E−Mailの送信です。

ACTION_MSMAIL:

MS−Mailの送信です。

ACTION_POPUP:

ポップアップメッセージの送信です。

ACTION_PAGER:

ポケットベルへのメッセージ送信です。

ACTION_SOUND:

サウンドの再生です。

exehost:

アクションを実行するホスト名が設定されます。

addr:

アクション実行先情報構造体（MpActionAddr）のアドレスを指定します。アクションの実行先のアドレス情報を格納します。

naddr:

addrに設定したアドレス数が設定されます。

status:

アクションの状態が設定されます。

STATUS_NORMAL:

正常終了しました。

STATUS_EXEC:

実行中です。

STATUS_EXEWAIT:

実行待ちです。

STATUS_ERROR:

異常終了しました。

STATUS_STOP:

一時停止中です。

code:

状態が異常終了の場合に設定します。
なお、詳細コードについては、後述の“詳細コード”を参照してください。

アクション実行先情報構造体（MpActionAddr）の形式

typedef struct MpActionAddr_tag {
    unsigned char *name ;
    char *address ;
} MpActionAddr ;

name:

アクション実行APIで、あて先名を指定した場合は、指定されたあて先名のアドレスが設定されます。アドレスを指定した場合は、NULLが設定されます。

address:

送信先（アドレス）のアドレスが設定されます。

メールの場合:

メールアドレスが設定されます。

ポップアップメッセージの場合:

ユーザ名、またはコンピュータ名が設定されます。

ポケットベルの場合:

電話番号が設定されます。

詳細コード

アクション状態通知API（Mp_GetActionInfo2）内で、獲得されたアクションの状態について記述します。

 

詳細コード	意 味	アクション
MPACT_D_NOMEMORY	アクション実行中にメモリ不足が発生した	すべて
MPACT_D_FILEACCESS	アクション実行中にファイル操作でエラーが発生した
MPACT_D_NOFILE	指定されたファイルが存在しない
MPACT_D_DEFFILE	アクション実行環境が定義されていない
MPACT_D_FAIL	何かの理由でアクション実行に失敗した
MPACT_D_NOTMOVE	アクション実行サーバが起動されていない
MPACT_D_NOHOST	指定されたアクション実行ホストが存在しない
MPACT_D_SENDFAIL	メッセージの送信に失敗した	ポップアップ
MPACT_D_NOTSERVER	SMTPサーバが見つからない	E−Mail
MPACT_D_NOTMYHOST	自ホスト名が獲得できない
MPACT_D_SMTPCOMMAND	SMTPサーバでの処理でエラーが発生した
MPACT_D_SMTPCOMM	SMTPサーバとの通信でエラーが発生した
MPACT_D_NOTCONNECT	SMTPサーバと接続できない
MPACT_D_FROMADDR	送信元アドレスが指定されていない
MPACT_D_SIGNIN	サインインに失敗した	MS−Mail
MPACT_D_NOSEND	メール送信処理で失敗した
MPACT_D_COMMOPEN	COMポート（モデム）のオープンに失敗した	ポケベル
MPACT_D_COMMFAIL	COMポート（モデム）の入出力でエラーが発生した
MPACT_D_INITCOMM	COMポート（モデム）の設定に失敗した
MPACT_D_LINEBUSY	通話中のため、送信できなかった
MPACT_D_LINEFAIL	電話回線の異常のため、送信できなかった
MPACT_D_CONVERTFAIL	メッセージの変換処理に失敗した
MPACT_D_NOTSOUND	音声再生用の環境が設定されていない	音声通知
MPACT_D_NOTDEVICE	他のアプリケーションが音声再生用のドライバを使用中
MPACT_D_CREATESOUND	音声再生処理に失敗した

◆参照

Mp_FreeActionInfo2（）関数、アクション管理のAPI

◆復帰値

0:

正常に情報を獲得しました。

MPACT_NOTACTION:

指定されたアクションは存在しません（すでに終了しています）。

MPACT_PARAMERR:

パラメタエラーです。

MPACT_ALLOCFAIL:

領域の獲得に失敗しました。

MPACT_NOTMOVE:

アクション管理サーバが起動されていません。

MPACT_COMFAIL:

アクション管理サーバとの通信に失敗しました。

MPACT_SYSERR:

アクション管理サーバでエラーが発生しました。

◆API格納場所

アクション管理のAPIを参照。

◆使用例

アクション状態通知APIの使用例を以下に示します。

#include "f3crhxac.h"

long handle = 1 ;                                          // 状態を獲得するアクションの管理番号
MpActionInfo2 *pInfo = NULL ;                              // 情報の領域のアドレス設定域
int nInfo = 0 ;

lrc = Mp_GetActionInfo2(handle,&pInfo,&nInfo);
if ( lrc != 0 ) {
    /* エラー処理 */
}

/* アクション情報(pInfo)の参照 */

/* アクション情報域(pInfo)の解散 */
Mp_FreeActionInfo2(pInfo,nInfo) ;