API version 1
- ‐
postExternalEvent¶
外部イベントを送付します。
呼出形式一覧
呼出形式 |
説明 |
---|---|
boolean postExternalEvent(string service, string portId, string eventName, string param) |
指定したserviceとportIdに対してparamのデータを付加したeventNameイベントを発生させる外部イベントを送信します。 |
戻り値一覧
戻り値 |
説明 |
---|---|
boolean |
メソッド正常終了時true、そうでない場合falseが返ります。 |
引数一覧
引数 |
説明 |
---|---|
service |
外部イベントのサービス名を指定します。 サービス名の命名規則にしたがった名前とする必要があります。 |
portId |
外部イベントを受け取るポートIDを指定します。 "*"を指定すると、受け手のポートIDに関わらず、serviceのサービス名で待ち受け状態にある全ての受け手に送付されます。 |
eventName |
送付するイベント名。 CRSのクラス名規則にしたがった名前とする必要があります。 |
param |
イベントに関連するパラメータ。最大で4096文字までの文字列を指定することができます。 |
例外
識別子 |
説明 |
---|---|
CRS::Option::Windows-3:1 |
サービス名が不正です |
CRS::Option::Windows-3:2 |
ポートIDが不正です |
CRS::Option::Windows-3:3 |
イベント名が不正です |
CRS::Option::Windows-3:4 |
パラメータが長すぎます |