本項では、旧バージョンのSystemwalker Operation Managerで提供された“アクション実行API”について説明します。
“アクション実行API”の一覧を以下に示します。
音声通知API(Mp_PlaySound)
ポップアップメッセージ送信(指定ユーザ)API(Mp_PopupUser)
ポップアップメッセージ送信(ドメイン)API(Mp_PopupDomain)
ポップアップメッセージ送信(全ユーザ)API(Mp_PopupSession)
旧バージョンのSystemwalker Operation Managerとは、ここでは以下のバージョンを指しています。
SystemWalker/OperationMGR V4.0
音声通知API(Mp_PlaySound)について説明します。
記述形式
long Mp_PlaySound (unsigned char *AppName, |
機能説明
以下の音声を通知します。
メッセージテキストの読上げ
WAVファイルの再生
BEEP音
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
kind
通知する音声の種類を指定します。このパラメタには、次の値のいずれかを指定します。
メッセージテキストを読み上げます。
WAVファイルを再生します。
BEEP音です。
text_or_filename
kindの指定値により、次の値のいずれかを指定します。
読み上げるメッセージテキストのアドレスを指定します。
再生するファイルのフルパス名のアドレスをMAX_PATH以内で指定します。
無効です。
repeat
音声を通知する回数を指定します。0を指定した場合は、停止処理がされるまで繰り返します。
SoundParam
音声オプション情報構造体(MpSoundParam)のアドレスを指定します。SOUND_VOICEを指定した場合に、システムの設定値を変更する場合に指定します。SOUND_VOICE以外の場合は、無効になります。設定の必要がない場合は、NULLを指定します。また、各項目で0を指定した場合、システムの設定値が使われます。
復帰値
正常に要求を受け取った場合は、0以上の整数を返します。0未満の場合はエラーとなります。エラーの場合の詳細を以下に示します。
復帰値 | 意 味 | 対 処 |
---|---|---|
MPACT_PARAMERR | パラメタエラーです。 | パラメタに誤りがないか確認してください。 |
MPACT_NOMEMORY | メモリ不足です。 | ページファイルのサイズを拡張するか、メモリを増設してください。 |
MPACT_NOTSOUND | サウンド再生用の環境がインストールされていません。 | Microsoft Speech API(SAPI)5.x対応音声合成エンジンを実装された製品がインストールされているか確認してください。 |
MPACT_NOTMOVE | アクション管理サーバが起動されていません。 | サービスSystemwalker MpAosfBが起動されていることを確認してください。 |
MPACT_COMFAIL | アクション管理サーバとの通信に失敗しました。 | サービスSystemwalker MpAosfB、およびSystemwalker MpAosfXが起動されていることを確認してください。 |
MPACT_SYSERR | アクション管理サーバでエラーが発生しました。 | イベントログ/SYSLOGに出力されたメッセージを参照しエラーを取り除いた後、Systemwalkerを再起動してください。エラーを取り除き、Systemwalker を再起動しても再現する場合は、保守情報収集ツールを使用し[イベント監視]の資料を採取して、富士通技術員に連絡してください。 |
MPACT_NOTDLL | アクション要求用DLLがロードできません。 | 以下のフォルダにアクション管理に必要なファイルf3crhxac.dllがあるか確認してください。 |
MPACT_EXCEPT | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
音声オプション情報構造体(MpSoundParam)の形式
typedef struct MpSoundParam_tag { DWORD dwVoiceType ; DWORD dwIntonation ; DWORD dwPitch ; DWORD dwSpeed ; DWORD dwSpeedRate ; DWORD dwTone ; DWORD dwVolume ; } MpSoundParam ;
dwVoiceType
声種を指定します。
男性の声です。
女性の声です。
dwIntonation
イントネーションのレベルを1~4で指定します。
dwPitch
発声の声の高さを1~5で指定します。
dwSpeed
読上げスピードを1~10で指定します。
dwSpeedRate
読上げスピードの変化の割合を1~10で指定します。
dwTone
高域強調の有無を指定します。
1
2
DWORD dwVolume
ボリュームを1~10で指定します。
プログラム例
音声通知APIのプログラム例を以下に示します。
#include "f3crhxac.h" unsigned char *AppName = "音声通知API" ; // 依頼元アプリケーション名 int kind = SOUND_VOICE ; // テキストの読上げ unsigned char *text = "異常が発生しました。オペレータに連絡してください" ; int repeat = 0 ; // 停止処理がされるまで繰り返す MpSoundParam *SndPrm = NULL ; // 省略値を使用 long lrc ; /* 音声通知依頼 */ lrc = Mp_PlaySound(AppName,kind,text,repeat,NULL) ; if ( lrc < 0 ) { /* エラー処理 */ } /* 正常終了 */
ポップアップメッセージ送信(指定ユーザ)API(Mp_PopupUser)について説明します。
記述形式
long Mp_PopupUser (unsigned char *AppName, |
機能説明
指定されたユーザがログインしているコンピュータまたは、指定されたコンピュータにポップアップメッセージを表示します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
AddressList
宛先情報構造体(MpAddress)のアドレスを指定します。ポップアップメッセージを送信するユーザ名またはコンピュータ名を指定します。複数指定する場合は、配列で指定します。なお、NULLを指定した場合は、ドメインにログインしているすべてのユーザに送信します。
nAddressList
AddressListに指定した配列の数を指定します。
MsgText
ポップアップに表示するメッセージのアドレスを指定します。メッセージは128バイト以内で指定します。
復帰値
正常に要求を受け取った場合は、0以上の整数を返します。0未満の場合はエラーとなります。エラーの場合の詳細を以下に示します。
復帰値 | 意 味 | 対 処 |
---|---|---|
MPACT_PARAMERR | パラメタエラーです。 | パラメタに誤りがないか確認してください。 |
MPACT_NOMEMORY | メモリ不足です。 | ページファイルのサイズを拡張するか、メモリを増設してください。 |
MPACT_NOTADDRESS | 有効なユーザ名またはコンピュータ名がありません。 | 宛先情報構造体(MpAddress)に指定したaddressに誤りがあります。正しい宛先名に変更してください。 |
MPACT_NOTMOVE | アクション管理サーバが起動されていません。 | サービスSystemwalker MpAosfBが起動されていることを確認してください。 |
MPACT_COMFAIL | アクション管理サーバとの通信に失敗しました。 | サービスSystemwalker MpAosfB、およびSystemwalker MpAosfXが起動されていることを確認してください。 |
MPACT_SYSERR | アクション管理サーバでエラーが発生しました。 | イベントログ/SYSLOGに出力されたメッセージを参照しエラーを取り除いた後、Systemwalkerを再起動してください。エラーを取り除き、Systemwalker を再起動しても再現する場合は、保守情報収集ツールを使用し[イベント監視]の資料を採取して、富士通技術員に連絡してください。 |
MPACT_NOTDLL | アクション要求用DLLがロードできません。 | 以下のフォルダにアクション管理に必要なファイルf3crhxac.dllがあるか確認してください。 |
MPACT_EXCEPT | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注意事項
ポップアップメッセージは、Microsoftネットワークでのみ使用できます。
宛先情報構造体(MpAddress)の形式
typedef struct MpAddress_tag { int type ; unsigned char *address ; char *addrid ; } MpAddress ;
type
addressに指定したアドレスの種別を指定します。
ユーザ名またはコンピュータ名です。
宛先名です。
address
ユーザ名/コンピュータ名または宛先名のアドレスを指定します。
addrid
Systemwalker Centric Managerがインストールされていて、typeにTYPE_NAMEを指定した場合に有効となります。詳細は、“Systemwalker Centric Manager リファレンスマニュアル”を参照してください。
プログラム例
ポップアップメッセージ送信(指定ユーザ)APIのプログラム例を以下に示します。
#include "f3crhxac.h" unsigned char *AppName = "ポップアップAPI" ; // 依頼元アプリケーション名 MpAddress addr[2] ; // 送信先アドレス格納域 int naddr ; unsigned char *text = "システムを停止します。" ; // 送信するメッセ //ージテキスト long lrc ; addr[0].type = TYPE_ADDRESS ; // ユーザ operatorとuser01にメッ addr[0].address = "operator" ; // セージを送信する addr[1].type = TYPE_ADDRESS ; addr[1].address = "user01" ; naddr = 2 ; lrc = Mp_PopupUser(AppName,addr,naddr,text) ; if ( lrc < 0 ) { /* エラー処理 */ } /* 正常終了 */
ポップアップメッセージ送信(ドメイン)API(Mp_PopupDomain)について説明します。
記述形式
long Mp_PopupDomain (unsigned char *AppName, |
機能説明
指定されたドメインに接続しているすべてのコンピュータにポップアップメッセージを表示します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
domain
メッセージを表示するドメイン名のアドレスを指定します。ドメイン名は15バイト以内で指定します。
MsgText
ポップアップに表示するメッセージのアドレスを指定します。メッセージは128バイト以内で指定します。
復帰値
正常に要求を受け取った場合は、0以上の整数を返します。0未満の場合はエラーとなります。エラーの場合の詳細を以下に示します。
復帰値 | 意 味 | 対 処 |
---|---|---|
MPACT_PARAMERR | パラメタエラーです。 | パラメタに誤りがないか確認してください。 |
MPACT_NOMEMORY | メモリ不足です。 | ページファイルのサイズを拡張するか、メモリを増設してください。 |
MPACT_NOTMOVE | アクション管理サーバが起動されていません。 | サービスSystemwalker MpAosfBが起動されていることを確認してください。 |
MPACT_COMFAIL | アクション管理サーバとの通信に失敗しました。 | サービスSystemwalker MpAosfB、およびSystemwalker MpAosfXが起動されていることを確認してください。 |
MPACT_SYSERR | アクション管理サーバでエラーが発生しました。 | イベントログ/SYSLOGに出力されたメッセージを参照しエラーを取り除いた後、Systemwalkerを再起動してください。エラーを取り除き、Systemwalker を再起動しても再現する場合は、保守情報収集ツールを使用し[イベント監視]の資料を採取して、富士通技術員に連絡してください。 |
MPACT_NOTDLL | アクション要求用DLLがロードできません。 | 以下のフォルダにアクション管理に必要なファイルf3crhxac.dllがあるか確認してください。 |
MPACT_EXCEPT | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注意事項
ポップアップメッセージは、Microsoftネットワークでのみ使用できます。
プログラム例
ポップアップメッセージ送信(ドメイン)APIのプログラム例を以下に示します。
#include "f3crhxac.h" unsigned char *AppName = "ポップアップAPI" ; // 依頼元アプリケーション名 char *domain = "Domain" ; // 送信先のドメイン名 unsigned char *text = "システムを停止します。" ; // 送信するメッセージテキスト long lrc ; lrc = Mp_PopupDomain(AppName,domain,text) ; if ( lrc < 0 ) { /* エラー処理 */ } /* 正常終了 */
ポップアップメッセージ送信(全ユーザ)API(Mp_PopupSession)について説明します。
記述形式
long Mp_PopupSession (unsigned char *AppName, |
機能説明
サーバに接続しているすべてのセッションにポップアップメッセージを送信します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
MsgText
ポップアップに表示するメッセージのアドレスを指定します。メッセージは128バイト以内で指定します。
復帰値
正常に要求を受け取った場合は、0以上の整数を返します。0未満の場合はエラーとなります。エラーの場合の詳細を以下に示します。
復帰値 | 意 味 | 対 処 |
---|---|---|
MPACT_PARAMERR | パラメタエラーです。 | パラメタに誤りがないか確認してください。 |
MPACT_NOMEMORY | メモリ不足です。 | ページファイルのサイズを拡張するか、メモリを増設してください。 |
MPACT_NOTMOVE | アクション管理サーバが起動されていません。 | サービスSystemwalker MpAosfBが起動されていることを確認してください。 |
MPACT_COMFAIL | アクション管理サーバとの通信に失敗しました。 | サービスSystemwalker MpAosfB、およびSystemwalker MpAosfXが起動されていることを確認してください。 |
MPACT_SYSERR | アクション管理サーバでエラーが発生しました。 | イベントログ/SYSLOGに出力されたメッセージを参照しエラーを取り除いた後、Systemwalkerを再起動してください。エラーを取り除き、Systemwalker を再起動しても再現する場合は、保守情報収集ツールを使用し[イベント監視]の資料を採取して、富士通技術員に連絡してください。 |
MPACT_NOTDLL | アクション要求用DLLがロードできません。 | 以下のフォルダにアクション管理に必要なファイルf3crhxac.dllがあるか確認してください。 |
MPACT_EXCEPT | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注意事項
ポップアップメッセージは、Microsoftネットワークでのみ使用できます。
プログラム例
ポップアップメッセージ送信(全ユーザ)APIのプログラム例を以下に示します。
#include "f3crhxac.h" unsigned char *AppName = "ポップアップAPI" ; // 依頼元アプリケーション名 unsigned char *text = "システムを停止します。" ; // 送信するメッセージテキスト long lrc ; lrc = Mp_PopupSession(AppName,text) ; if ( lrc < 0 ) { /* エラー処理 */ } /* 正常終了 */