関数stringParameterOutOfChoice マニュアル

(The documentation of function stringParameterOutOfChoice)
Last Update: 2023/4/6


◆機能・用途(Purpose)

文字列パラメータの値が可能な選択肢のいずれとも一致しない旨の エラーメッセージを出力してプログラムを終了する。
Display a message to inform that the value of a string parameter is equal to none of possible choices, and finish the program as an error.

◆形式(Format)

#include <argument.h>
inline void stringParameterOutOfChoice
(const char ∗parameterName,const char ∗parameterValue,  const int Nchoice,...)


◆引数(Arguments)

parameterName パラメータ名。
A parameter name.
parameterValue パラメータ値。
The value of the parameter.
Nchoice パラメータが取りうる値の選択肢の個数。
The number of possible values of the parameter.
... パラメータが取りうる値のリスト。 全てchar ∗型(文字列配列)とする。
The list of all possible parameter values, each of which must be char ∗-type that represents a string.


◆表示するメッセージ (The message displayed)

エラー : パラメータparameterNameの値として "parameterValue"が指定されましたが、 この値は(候補文字列のリスト) のいずれかでなければなりません。
ERROR : "parameterValue" was specified for parameter "parameterName", which must be one of (list of candidate strings).

◆使用例(Example)

if(strcmp(param,"yes")!=0 && strcmp(param,"no")!=0){
     stringParameterOutOfChoice ("param",param,2,"yes","no");
}