関数CKgetenv マニュアル

(The documentation of function CKgetenv)
Last Update: 2023/3/23


◆機能・用途(Purpose)

関数getenv(環境変数の取得)をエラーチェック付きで実行する。
Call function getenv (obtaining an environmental variable) with error checks.

◆形式(Format)

#include <functions_with_errcheck.h>
inline char ∗ CKgetenv(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.
その他の場合
Other cases		 環境変数の値の文字列長\(+1\)の長さのchar型変数配列として 動的メモリを確保し、 関数getenvにより取得した環境変数の値をコピーして返す。
Allocate dynamic memory for a char-type array with a length being the string length of the value of the environmental variable plus 1, copy the value of the environmental variable obtained by function getenv, and return.


◆使用例(Example)

char ∗hostname=CKgetenv("HOSTNAME")