Systemwalker Operation Manager リファレンスマニュアル - UNIX/Windows(R)共通 -

17.4.5.1 アクション状態通知API

アクション状態通知API(Mp_GetActionInfo)について説明します。

■記述形式

long Mp_GetActionInfo (long handle,
　　　　　　　　　　　　　MpActionInfo **ActionInfo,
　　　　　　　　　　　　　int *nActionInfo)

■機能説明

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

■パラメタの説明

◆handle

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

◆ActionInfo

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

◆nActionInfo

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

■復帰値

0:

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

MPACT_NOTACTION:

指定されたアクションは存在しません(既に終了している)。

MPACT_PARAMERR:

パラメタエラーです。

MPACT_ALLOCFAIL:

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

MPACT_NOTMOVE:

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

MPACT_COMFAIL:

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

MPACT_SYSERR:

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

MPACT_NOTDLL:

アクション要求用DLLがロードできません。

MPACT_EXCEPT:

不当な領域のアドレスが指定されました。

■アクション状態情報構造体(MpActionInfo)の形式

typedef struct MpActionInfo_tag {  
    long no ;            // アクションの管理番号
    long action ;        // アクションの種類
    MpActionAddr *addr ; // アクション実行先情報構造体のアドレス
    int  naddr ;         // addrに設定したアドレス数
    int  status ;        // アクションの状態
    int  code ;          // 詳細コード
} MpActionInfo ;  

◆no

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

◆action

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

ACTION_EMAIL:

E-Mailの送信です。

ACTION_MSMAIL:

MS-Mailの送信です。

ACTION_POPUP:

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

ACTION_PAGER:

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

ACTION_SOUND:

サウンドの再生です。

◆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_GetActionInfo)内で獲得されたアクションの状態について記述します。

詳細コード	意 味	アクション
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	ＳＭＴＰサーバが見つからない	E-Mail
MPACT_D_NOTMYHOST	自ホスト名が獲得できない
MPACT_D_SMTPCOMMAND	ＳＭＴＰサーバでの処理でエラーが発生した
MPACT_D_SMTPCOMM	ＳＭＴＰサーバとの通信でエラーが発生した
MPACT_D_NOTCONNECT	ＳＭＴＰサーバと接続できない
MPACT_D_FROMADDR	送信元アドレスが指定されていない
MPACT_D_SIGNIN	サインインに失敗した	MS-Mail
MPACT_D_NOSEND	メール送信処理でエラーが発生した
MPACT_D_COMMOPEN	ＣＯＭポート(モデム)のオープンに失敗した	ポケットベル
MPACT_D_COMMFAIL	ＣＯＭポート(モデム)の入出力でエラーが発生した
MPACT_D_INITCOMM	ＣＯＭポート(モデム)の設定に失敗した
MPACT_D_LINEBUSY	通話中のため、送信できなかった
MPACT_D_LINEFAIL	電話回線の異常のため、送信できなかった
MPACT_D_CONVERTFAIL	メッセージの変換処理に失敗した
MPACT_D_NOTSOUND	音声再生用の環境が設定されていない	音声通知
MPACT_D_NOTDEVICE	他のアプリケーション音声再生用のドライバを使用中
MPACT_D_CREATESOUND	音声再生処理に失敗した

■プログラム例

アクション状態通知APIのプログラム例を以下に示します。

 

#include "f3crhxac.h"

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

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

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

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