| SENDGATEWAYMESSAGE | |
| 説明
ColdFusion MX イベントゲートウェイを使って発信メッセージを送信します。 |
|
| 戻り値
文字列値。返される値は、ゲートウェイタイプによって異なります。 |
|
| カテゴリ
拡張可能関数 |
|
関数のシンタックスSendGatewayMessage(gatewayID, data) |
|
| 関連項目
GetGatewayHelper、「IM ゲートウェイメッセージ送信コマンド」、「SMS ゲートウェイ CFEvent の構造体とコマンド」、「CFML イベントゲートウェイ SendGatewayMessage の data パラメータ」、『ColdFusion MX 開発ガイド』の第42章の「イベントゲートウェイの使用」 の「SendGatewayMessage 関数によるメッセージの送信」 |
|
| ヒストリ
ColdFusion MX 7: この関数が追加されました。 |
|
| パラメータ
|
|
| 使用方法
SendGatewayMessage 関数は、指定されたゲートウェイの outgoingMessage メソッドを呼び出します。この関数が返す値は、ゲートウェイタイプによって異なります。次の表に、標準の ColdFusion MX ゲートウェイタイプの戻り値を示します。
|
|
| 例
次の例では、CFML ゲートウェイのインスタンスを使用して、メッセージをファイルに非同期で記録します。この例を使用するには、ColdFusion MX Administrator で "Asynch Logger" という名前を使用して CFML ゲートウェイのインスタンスを設定する必要があります。このゲートウェイインスタンスでは、メッセージを受け取って記録する CFC を使用する必要があります。CFC コードの例については、『ColdFusion MX 開発ガイド』の第42章の「イベントゲートウェイの使用」 の「非同期 CFC に対する CFML イベントゲートウェイの使用」を参照してください。 イベントを、ColdFusion MX Administrator で Asynch Logger として登録されている
CFML イベントゲートウェイに送信します。<br>
<cfscript>
status = false;
props = structNew();
props.message = "ログ対象のデータを使用する変数で置き換えてください";
status = SendGatewayMessage("Asynch Logger", props);
if (status IS True) WriteOutput('イベントメッセージ "#props.message#" が送信されました。');
</cfscript>
|
|
| GATEWAYID | |
| メッセージを送信するゲートウェイの識別子です。ColdFusion MX Administrator の [イベント ゲートウェイ] セクションの [Gateways] ページで設定された、いずれかの ColdFusion イベント ゲートウェイインスタンスのゲートウェイ ID でなければなりません。 | |
| DATA | |
| ColdFusion 構造体です。構造体の内容はイベントゲートウェイタイプによって異なりますが、通 常は、送信するメッセージを示す MESSAGE フィールドおよび送信先アドレスを示すフィールド が含まれています。 | |