【コマンド】リターン(コマンドの終了)-Forguncy(フォーガンシー)
また、本記事の内容についてはサンプルアプリのご提供も行っております。
サンプルアプリをご希望の場合はこちらよりご連絡ください。
リターンコードはサーバーサイドコマンドの実行結果が成功したかどうかを示す値です。
成功した場合は「0」が返され、エラーの場合は「0」以外の値となります。
リターン(コマンドの終了)コマンドを使用することで、コマンドの実行をその時点で終了させて、任意のリターンコードとリターンメッセージを返すことができます。
サーバーサイドの処理でエラーが発生する場合を想定してユーザーに分りやすいメッセージを返したりすることができます。

例として、サーバー側で顧客情報をCSV出力する処理での使用例をみてみます。
画面
ランクを選択すると対象の顧客の一覧がリストビューに表示される画面です。
顧客情報出力ボタンを押下するとサーバー側に対象の顧客のCSVを出力します。

テーブル
顧客

ランク

顧客の一覧画面に「リターンコード」と「リターンメッセージ」を表示する項目を作成します。(① ②)

CSVを出力するサーバーサイドコマンドを作成します。

パラメータに「ランク」を入力します。
ランクは画面で選択されたランクを呼び出し元から受け取ります。

コマンドを図のように設定していきます。
変数の設定で変数 [file_path]に出力するcsvファイルのパスとファイル名を指定します。

変数の設定で、変数 [list_cnt] に出力対象となる顧客の件数を取得します。

リターン(コマンドの終了)を設定します。
上記で設定した変数 [list_cnt] が0件の場合、出力対象となるデータがないのでコマンドを終了します。
この時理由がわかりやすいようにリターンコードとリターンメッセージに内容を設定します。

変数 [list_cnt] が0件でない場合、CSVを出力する処理を作成します。

処理の最後には正常終了として
リターンコードに「0」をリターンメッセージに「顧客情報を出力しました。」と設定します。

顧客情報出力ボタンのコマンドを作成します。

「サーバーサイドコマンドの呼び出し」コマンドを使用して先ほど作成したサーバーサイドコマンドを呼び出す設定をします。
パラメーターは画面のランクの値を設定します。

上記のサーバーサイドコマンドの呼び出しで受けとったリターンコードを画面に表示する為セルプロパティの設定をします。

リターンコマンドと同様にリターンメッセージも設定します。

リターンコードを利用して条件分岐を作成します。
ここではリターンコードが「-1」の場合ランクのコンボボックスをリセットします。


リターンメッセージの変数を利用して画面にメッセージを表示します。

画面を表示してみます。

データが存在しないランクを選択して「顧客情報出力」をしてみます。

対象データが0件だったので、リターンメッセージに0件の場合に設定したメッセージが表示されました。

画面のエラーコードとエラーメッセージにも設定されています。
またエラーだったのでランクのコンボボックスは何も選択されていません。

データが存在する場合を確認します。

対象データが存在したので、リターンメッセージにCSV出力した場合に設定したメッセージが表示されました。

画面のエラーコードとエラーメッセージにも値が設定されています。
また対象のデータが存在したのでランクのコンボボックスは選択された値のままです。

このように「リターン(コマンドの終了)」を利用することで、エラーコードとエラーメッセージにユーザが分かりやすいメッセージを表示させたり処理を分岐させたりすることができます。