本項では、“アクション実行API”について説明します。
“アクション実行API”の一覧を以下に示します。
音声通知API(Mp_PlaySound2)
音声停止API(Mp_StopSound)
ポップアップメッセージ送信(指定ユーザ)API(Mp_PopupUser2)
ポップアップメッセージ送信(ドメイン)API(Mp_PopupDomain2)
ポップアップメッセージ送信(全ユーザ)API(Mp_PopupSession2)
MS-Mail送信API(Mp_SendMSMail2)
E-Mail送信API(Mp_SendEMail)
ショートメールへのメッセージ送信API(Mp_CallPager2)
音声通知API(Mp_PlaySound2)について説明します。
記述形式
long Mp_PlaySound2 (unsigned char *AppName, |
機能説明
以下の音声を通知します。
メッセージテキストの読上げ
WAVファイルの再生
BEEP音
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
kind
通知する音声の種類を指定します。このパラメタには、次の値のいずれかを指定します。
メッセージテキストを読み上げます。
WAVファイルを再生します。
BEEP音です。
text_or_filename
kindの指定値により、次の値のいずれかを指定します。
読み上げるメッセージテキストのアドレスを指定します。
再生するファイルのフルパス名のアドレスを260バイト以内で指定します。なお、ファイルはExeHostで指定したホストに存在するものを指定してください。
無効です。
repeat
音声を通知する回数を指定します。0を指定した場合は、停止処理がされるまで繰り返します。
SoundParam
音声オプション情報構造体(MpSoundParam)のアドレスを指定します。SOUND_VOICEを指定した場合に、システムの設定値を変更する場合に指定します。SOUND_VOICE以外の場合は、無効になります。設定の必要がない場合は、NULLを指定します。また、各項目で0を指定した場合、システムの設定値が使われます。
ExeHost
アクションを実行するホスト名(アクション実行を選択したクライアント)のアドレスを指定します。NULLを指定した場合は、アクション環境設定画面で指定したホストでアクションが実行されます。
復帰値
正常に要求を受け取った場合は、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 | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
音声オプション情報構造体(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_PlaySound2(AppName,kind,text,repeat,NULL,NULL) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */音声停止API(Mp_StopSound)について説明します。
記述形式
long Mp_StopSound (unsigned char *AppName, |
機能説明
音声通知を停止します。
パラメタの説明
AppName
音声停止API(Mp_PlaySound)で指定した呼び出し元のアプリケーション名のアドレスを指定します。
handle
Mp_PlaySound関数で返された値を指定します。0を指定した場合は、再生中の音声を停止します。
復帰値
正常に要求を受け取った場合は、0を返します。0未満の場合はエラーとなります。エラーの場合の詳細を以下に示します。
復帰値 | 意 味 | 対 処 |
|---|---|---|
MPACT_PARAMERR | パラメタエラーです。 | パラメタに誤りがないか確認してください。 |
MPACT_NOMEMORY | メモリ不足です。 | ページファイルのサイズを拡張するか、メモリを増設してください。 |
MPACT_NOTACTION | 指定されたアクションは存在(既に終了している)しません。 | - |
MPACT_NOTSTOP | 指定されたアクションは、停止できません。 | - |
MPACT_NOTMOVE | アクション管理サーバが起動されていません。 | サービスSystemwalker MpAosfBが起動されていることを確認してください。 |
MPACT_COMFAIL | アクション管理サーバとの通信でエラーが発生しました。 | サービスSystemwalker MpAosfB、およびSystemwalker MpAosfXが起動されていることを確認してください。 |
MPACT_SYSERR | アクション管理サーバでエラーが発生しました。 | イベントログ/SYSLOGに出力されたメッセージを参照しエラーを取り除いた後、Systemwalkerを再起動してください。エラーを取り除き、Systemwalker を再起動しても再現する場合は、保守情報収集ツールを使用し[イベント監視]の資料を採取して、富士通技術員に連絡してください。 |
MPACT_NOTDLL | アクション要求用DLLがロードできません。 | 以下のフォルダにアクション管理に必要なファイルf3crhxac.dll(注)があるか確認してください。 |
MPACT_EXCEPT | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
プログラム例
音声停止APIのプログラム例を以下に示します。
#include "f3crhxac.h"
unsigned char *AppName = "音声通知API" ; // Mp_PlaySound()に指定したアプリ名
long handle = 1 ; // Mp_PlaySound()の戻り値
long lrc ;
lrc = Mp_StopSound(AppName,handle) ;
if ( lrc != 0 ) {
/* エラー処理 */
}
/* 正常終了 */ポップアップメッセージ送信(指定ユーザ)API(Mp_PopupUser2)について説明します。
記述形式
long Mp_PopupUser2 (unsigned char *AppName, |
機能説明
指定されたユーザがログインしているコンピュータまたは、指定されたコンピュータにポップアップメッセージを表示します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
AddressList
宛先情報構造体(MpAddress)のアドレスを指定します。ポップアップメッセージを送信するユーザ名またはコンピュータ名を指定します。複数指定する場合は、配列で指定します。なお、NULLを指定した場合は、ドメインにログインしているすべてのユーザに送信します。
nAddressList
AddressListに指定した配列の数を指定します。
MsgText
ポップアップに表示するメッセージのアドレスを指定します。メッセージは128バイト以内で指定します。
ExeHost
アクションを実行するホスト名(アクション実行を選択したクライアント)のアドレスを指定します。NULLを指定した場合は、アクション環境設定画面で指定したホストでアクションが実行されます。
復帰値
正常に要求を受け取った場合は、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 | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
注意事項
ポップアップメッセージは、Microsoftネットワークでのみ使用できます。また、アクション実行ホストには、Windows(R) 98、Windows(R) Meがインストールされているコンピュータは指定できません。
宛先情報構造体(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 ; // ユーザ operaterとuser01にメッ
addr[0].address = "operater" ; // セージを送信する
addr[1].type = TYPE_ADDRESS ;
addr[1].address = "user01" ;
naddr = 2 ;
lrc = Mp_PopupUser2(AppName,addr,naddr,text,NULL) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */ポップアップメッセージ送信(ドメイン)API(Mp_PopupDomain2)について説明します。
記述形式
long Mp_PopupDomain2 (unsigned char *AppName, |
機能説明
指定されたドメインに接続しているすべてのコンピュータにポップアップメッセージを表示します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
domain
メッセージを表示するドメイン名のアドレスを指定します。ドメイン名は15バイト以内で指定します。
MsgText
ポップアップに表示するメッセージのアドレスを指定します。メッセージは128バイト以内で指定します。
ExeHost
アクションを実行するホスト名(アクション実行を選択したクライアント)のアドレスを指定します。NULLを指定した場合は、アクション環境設定画面で指定したホストでアクションが実行されます。
復帰値
正常に要求を受け取った場合は、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 | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
注意事項
ポップアップメッセージは、Microsoftネットワークでのみ使用できます。また、アクション実行ホストには、Windows(R) 98、Windows(R) Meがインストールされているコンピュータは指定できません。
プログラム例
ポップアップメッセージ送信(ドメイン)APIのプログラム例を以下に示します。
#include "f3crhxac.h"
unsigned char *AppName = "ポップアップAPI" ; // 依頼元アプリケーション名
char *domain = "Domain" ; // 送信先のドメイン名
unsigned char *text = "システムを停止します。" ; // 送信するメッセージテキスト
long lrc ;
lrc = Mp_PopupDomain2(AppName,domain,text,NULL) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */ポップアップメッセージ送信(全ユーザ)API(Mp_PopupSession2)について説明します。
記述形式
long Mp_PopupSession2 (unsigned char *AppName, |
機能説明
サーバに接続しているすべてのセッションにポップアップメッセージを送信します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
MsgText
ポップアップに表示するメッセージのアドレスを指定します。メッセージは128バイト以内で指定します。
ExeHost
アクションを実行するホスト名(アクション実行を選択したクライアント)のアドレスを指定します。NULLを指定した場合は、アクション環境設定画面で指定したホストでアクションが実行されます。
復帰値
正常に要求を受け取った場合は、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 | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
注意事項
ポップアップメッセージは、Microsoftネットワークでのみ使用できます。また、アクション実行ホストには、Windows(R) 98、Windows(R) Meがインストールされているコンピュータは指定できません。
プログラム例
ポップアップメッセージ送信(全ユーザ)APIのプログラム例を以下に示します。
#include "f3crhxac.h"
unsigned char *AppName = "ポップアップAPI" ; // 依頼元アプリケーション名
unsigned char *text = "システムを停止します。" ; // 送信するメッセージテキスト
long lrc ;
lrc = Mp_PopupSession2(AppName,text,NULL) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */MS-Mail送信API(Mp_SendMSMail2)について説明します。
記述形式
long Mp_SendMSMail2 (unsigned char *AppName, |
機能説明
MS-Mailの送信をアクション管理サーバに要求します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
AddressList
宛先情報構造体(MpAddress)のアドレスを指定します。メールを送信するユーザ名を指定します。複数指定する場合は、配列で指定します。
nAddressList
AddressListに指定した配列数を指定します。
MailData
メール送信データ情報構造体(MpDataList)のアドレスを指定します。複数のデータを送信する場合は、配列で指定します。
nMailData
MailDataに指定した配列数を指定します。
MailTitle
メールのタイトルを指定します。
MMailParam
メール送信管理情報構造体(MpMMParam)のアドレスを指定します。メールを送信するための情報を指定します。NULLの場合、各項目の省略値を使用します。
ExeHost
アクションを実行するホスト名(アクション実行を選択したクライアント)のアドレスを指定します。NULLを指定した場合は、アクション環境設定画面で指定したホストでアクションが実行されます。
復帰値
正常に要求を受け取った場合は、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 | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
備考
メールデータにメモリデータは1つのみ指定可能。また、メモリデータは配列の先頭に指定します。メモリデータがない場合は、すべて添付ファイルとして送信します。
メモリデータは、'\0'で終了させます。改行は、CR(0x0d)+LF(0x0a)のコードで行います。
注意事項
Windows(R)2000などOutlook Expressがインストールされている場合は、MS-Mailの受信はできません。E-Mailで実施してください。
宛先情報構造体(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 リファレンスマニュアル”を参照してください。
メール送信データ情報構造体(MpDataList)の形式
typedef struct MpDataList_tag {
int type ;
unsigned char *data ;
} MpDataList ; type
dataに指定するデータの種別を指定します。
メモリデータです。
ファイル名です。
ファイル名(メール送信が正常終了した後、アクション管理がファイルを削除する)です。
data
TYPE_LMEMORYの場合は、1028バイト以内で指定したメモリデータのアドレスを指定します。
TYPE_FILENAMEおよびTYPE_TEMPFILEの場合は、MAX_PATH以内で指定したファイル名のアドレスを指定します。
メール送信管理情報構造体(MpMMParam)の形式
typedef struct MpMMParam_tag {
char *Profile ;
char *Password ;
} MpMMParam ; Profile
ログインするユーザ名のアドレスを指定します。NULLを指定した場合は、省略値を使用します。
Password
ログインするユーザのパスワードのアドレスを指定します。NULLを指定した場合は、省略値を使用します。
プログラム例
MS-Mail送信APIのプログラム例を以下に示します。
#include "f3crhxac.h"
unsigned char *AppName = "MS-Mail送信API" ; // 依頼元アプリケーション名
MpAddress addr[2] ; // 送信先アドレス格納域
int naddr ;
MpDataList data[2] ;
int ndata ;
unsigned char *Title = "システム異常通知" ; // メールタイトル
MpMMParam MailPrm = NULL ; // 省略値を使用
long lrc ;
addr[0].type = TYPE_ADDRESS ; // ユーザ operaterとuser01
addr[0].address = "operater" ; // にメッセージを送信する
addr[1].type = TYPE_ADDRESS ;
addr[1].address = "user01" ;
naddr = 2 ;
data[0].type = TYPE_LMEMORY ; // 送信データの設定
data[0].data = "異常が発生しました。\r\n詳細は添付ファイルを参照してください。\r\n" ;
data[1].type = TYPE_FILENAME ;
data[1].data = "D:\\TEMP\\ERR001.LOG" ;
ndata = 2 ;
lrc = Mp_SendMSMail2(AppName,addr,naddr,data,ndata,Title,MailPrm,NULL) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */E-Mail送信API(Mp_SendEMail)について説明します。
記述形式
long Mp_SendEMail (unsigned char *AppName, |
機能説明
E-Mailの送信をアクション管理サーバに要求します。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
AddressList
宛先情報構造体(MpAddress)のアドレスを指定します。複数指定する場合は、配列で指定します。
宛先情報構造体については、“18.4.1.6 MS-Mail送信API”を参照してください。
nAddressList
AddressListに指定したアドレスの数(配列数)を指定します。
MailData
メール送信データ情報構造体(MpDataList)のアドレスを指定します。複数のデータを送信する場合は、配列で指定します。
メール送信データ情報構造体については、“18.4.1.6 MS-Mail送信API”を参照してください。
nMailData
MailDataに指定した配列数を指定します。
FromAddress
メール送信元のメールアドレスを指定します。NULLを指定した場合は、省略値を使用します。
MailTitle
メールのタイトルを指定します。
SMTPServer
SMTPサーバ名を指定します。NULLを指定した場合は、省略値を使用します。
復帰値
正常に要求を受け取った場合は、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 | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
備考
メールデータの先頭に指定されたデータは、メールの本体(テキスト)として送信します。メールの本体部がない場合は、先頭の配列のメンバdataにNULLを指定します。
メールデータにTYPE_LMEMORYは1つのみ指定できます。また、TYPE_LMEMORYは配列の先頭に指定する必要があります。
メモリデータは、'\0'で終了させます。改行は、CR(0x0d)+LF(0x0a)のコードで行います。
メール本体にSJISコードが指定されている場合は、テキストはISO-2022-JP形式に変換後、送信します。添付ファイルは、Base64の形式に変換して送信します。
プログラム例
E-Mail送信APIのプログラム例を以下に示します。
#include "f3crhxac.h"
unsigned char *AppName = "E-Mail送信API" ; // 依頼元アプリケーション名
MpAddress addr[2] ; // 送信先アドレス格納域
int naddr ;
MpDataList data[2] ;
int ndata ;
char *FromAddr = "MpWalker@fujitsu.co.jp" ; // 送信元アドレス
unsigned char *Title = "System Report" ; // メールタイトル
char *SMTPSrv = NULL ; // 省略値を使用
long lrc ;
addr[0].type = TYPE_ADDRESS ; // ユーザ operaterとuser01にメッ
addr[0].address = "operater@fujitsu.co.jp" ; // セージを送信する
addr[1].type = TYPE_ADDRESS ;
addr[1].address = "user01@fujitsu.co.jp" ;
naddr = 2 ;
data[0].type = TYPE_LMEMORY ; // 送信データの設定
data[0].data = "異常が発生しました。\r\n詳細は添付ファイルを参照してください。\r\n" ;
data[1].type = TYPE_FILENAME ;
data[1].data = "D:\\TEMP\\ERR001.LOG" ;
ndata = 2 ;
lrc = Mp_SendEMail(AppName,addr,naddr,data,ndata,FromAddr,Title,SMTPSrv) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */ショートメールへのメッセージ送信API(Mp_CallPager2)について説明します。
記述形式
long Mp_CallPager2 (unsigned char *AppName, |
機能説明
ショートメールへのメッセージ送信を行います。
パラメタの説明
AppName
呼び出し元のアプリケーション名のアドレスを指定します。アプリケーション名は64バイト以内で指定します。
AddressList
ショートメール送信情報構造体(MpPagerList)のアドレスを指定します。ショートメールの電話番号を指定します。複数ある場合は配列で指定します。
nAddressList
AddressListに指定したアドレスの数(配列数)を指定します。
MsgText
送信するメッセージのアドレスを指定します。メッセージは、送信するコード(定型メッセージのコードも含む)を指定します。
または、ショートメールの会社でサポートしている文字を半角文字で指定します。
MsgType
MsgTextに指定したメッセージの形式を指定します。
番号形式です。
メッセージテキストです。
exehost
アクションを実行するホスト名(アクション実行を選択したクライアント)のアドレスを指定します。NULLを指定した場合は、アクション環境設定画面で指定したホストでアクションが実行されます。
復帰値
正常に要求を受け取った場合は、0以上の整数を返します。0未満の場合はエラーとなります。エラーの場合の詳細を以下に示します。
復帰値 | 意 味 | 対 処 |
|---|---|---|
MPACT_PARAMERR | パラメタエラーです。 | パラメタに誤りがないか確認してください。 |
MPACT_NOMEMORY | メモリ不足です。 | ページファイルのサイズを拡張するか、メモリを増設してください。 |
MPACT_NOTADDRESS | 有効なメールアドレスがありません。 | 宛先情報構造体（MpAddress）に指定したaddressに誤りがあります。正しい宛先名に変更してください。 |
MPACT_NOTMODEM | モデムがインストールされていません。 | モデムのインストール状態、および正しく接続されているかを確認してください。モデムに関する確認は、OSのヘルプに記載されている内容を参考に実施してください。 |
MPACT_NOTMOVE | アクション管理サーバが起動されていません。 | サービスSystemwalker MpAosfBが起動されていることを確認してください。 |
MPACT_COMFAIL | アクション管理サーバとの通信に失敗しました。 | サービスSystemwalker MpAosfB、およびSystemwalker MpAosfXが起動されていることを確認してください。 |
MPACT_SYSERR | アクション管理サーバでエラーが発生しました。 | イベントログ/SYSLOGに出力されたメッセージを参照しエラーを取り除いた後、Systemwalkerを再起動してください。エラーを取り除き、Systemwalker を再起動しても再現する場合は、保守情報収集ツールを使用し[イベント監視]の資料を採取して、富士通技術員に連絡してください。 |
MPACT_NOTDLL | アクション要求用DLLがロードできません。 | 以下のフォルダにアクション管理に必要なファイルf3crhxac.dll(注)があるか確認してください。 |
MPACT_EXCEPT | 不当な領域のアドレスが指定されました。 | 内部論理異常が発生しています。保守情報収集ツールを使用し資料を採取して、富士通技術員に連絡してください。 |
注）64bitプラットフォームの場合、f3crhxac.dllはf3crhxac_64.dllになります。
備考
送信できるメッセージの長さは、ショートメールおよびモデムの種類により異なります。NTTドコモ 携帯電話およびモデムの説明書を参照してください。なお、送信できるメッセージの長さを超えた場合は、正しく送信できないことがあります。
ショートメール送信情報構造体(MpPagerList)の形式
typedef struct MpPagerList_tag {
int type ;
unsigned char *address ;
char *addrid ;
char *vender ;
} MpPagerList ;type
addressに指定したアドレスの種別を指定します。
ショートメールの電話番号です。
宛先名です。
address
電話番号または宛先名のアドレスを指定します。
電話番号の場合、ショートメールの電話番号を以下の形式で指定します。
“ショートメールセンターの電話番号”＋“T”＋“通知先の電話番号” |
NTTドコモ ショートメールセンターの電話番号を設定します。
参考) NTTドコモ ショートメールセンターの電話番号は、2007年9月現在、0903101655です。詳細は、契約会社に確認してください。
区切り文字です。“T”または“t”を設定してください。
通知先の電話番号を設定してください。
例) 通知先 09012345678 にショートメールを送信する場合の設定例
0903101655T09012345678 |
addrid
Systemwalker Centric Managerがインストールされていて、typeにTYPE_NAMEを指定した場合に有効となります。詳細は、“Systemwalker Centric Manager リファレンスマニュアル”を参照してください。
vender
ショートメールの種類を指定します。Systemwalkerがサポートしているショートメールの種類を以下に示します。他の種類を指定する場合は、[アクション環境設定]ダイアログボックスで登録したショートメールの会社名を指定し、メッセージを変換する出口(サポート外のショートメールのメッセージ変換用出口)を作成する必要があります。
なお、サポート外のショートメールのメッセージ変換用出口については、“19.9 サポート外のショートメールのメッセージ変換用出口【Windows版】”を参照してください。
NTT DoCoMo ショートメール
プログラム例
ショートメールへのメッセージ送信APIのプログラム例を以下に示します。
#include "f3crhxac.h"
unsigned char *AppName = "ショートメールAPI" ; // 依頼元アプリケーション名
MpAddress addr[2] ; // 送信先アドレス格納域
int naddr ;
char *text = "イジョウハッセイ" ; // 送信するメッセージ
int type = PAGER_TEXT ;
long lrc ;
addr[0].type = TYPE_ADDRESS ; // 2箇所にショートメール
addr[0].address = "0903101655T1112223333" ; // を送信する
addr[0].vender = MPPAGER_DOCOMO_SHORTMAIL ;
addr[1].type = TYPE_ADDRESS ;
addr[1].address = "0903101655T1114445555" ;
addr[1].vender = MPPAGER_DOCOMO_SHORTMAIL ;
naddr = 2;
lrc = Mp_CallPager2(AppName,addr,naddr,text,type,NULL) ;
if ( lrc < 0 ) {
/* エラー処理 */
}
/* 正常終了 */