関数CKgetenv_Bool マニュアル

(The documentation of function CKgetenv_Bool)
Last Update: 2024/1/5


◆機能・用途(Purpose)

環境変数を取得し、真偽値に変換する。
Get an environmental variable and convert to a logical value.

◆形式(Format)

#include <functions_with_errcheck.h>
inline _Bool CKgetenv_Bool(const char ∗envname)


◆引数(Arguments)

envname 環境変数の名前を表す文字列。
A string that represents the name of an environmental variable.


◆戻り値とエラーチェック (Return value and error checks)

下表で桃色のセルがエラー処理を表す。
The pick colored cells in the table below represent error checks.
条件
Condition 		戻り値/動作
Return value or behaviour of the function
envname=NULLの場合
In case of envname=NULL 		プログラムをエラー終了する。
The program finishes as an error.
envnameの文字列長が0の場合
In case where the string length of envname is zero 		プログラムをエラー終了する。
The program finishes as an error.
文字列envnameが表す環境変数が定義されていない (関数getenvの戻り値がNULL)場合
In case where the environmental variable represented by the string envname is not defined (judged by NULL return value of function getenv) 		プログラムをエラー終了する。
The program finishes as an error.
環境変数の値がtrueまたはyesの場合
In case where the value of the environmental variable is true or yes 		戻り値としてtrueを返す。
The function returns true.
環境変数の値がfalseまたはnoの場合
In case where the value of the environmental variable is false or no 		戻り値としてfalseを返す。
The function returns false.
その他の場合
The other cases 		プログラムをエラー終了する。
The program finishes as an error.


◆使用例(Example)

if(CKgetenv_Bool("YMAEDA_OPENTOOLS_JAPANESE")){
     printf("インストール言語は日本語です。\n");
}else{
     printf("The installation language is English.\n");
}