Linux Certif

Toute la documentation sur la certification Linux LPI

envz_add

名前

envz_add, envz_entry, envz_get, envz_merge, envz_remove, envz_strip - 環境変数文字列の操作

書式

 
 #include <envz.h>
 
 error_t
 envz_add(char **envz, size_t *envz_len,
 

                 const char *name, const char *value);
 
 char *
 envz_entry(const char *envz, size_t *envz_len, const char *name);
 
 char *
 envz_get(const char *envz, size_t *envz_len, const char *name);
 
 error_t
 envz_merge(char **envz, size_t *envz_len,
 

                 const char *envz2, size_t envz2_len, int override);
 
 void
 envz_remove(char **envz, size_t *envz_len, const char *name);
 
 void
 envz_strip(char **envz, size_t *envz_len);
 

 

説明

これらの関数 glibc 固有である。

argz vector は長さ情報付きの文字バッファへのポインタである。 argz_add(3) を参照のこと。 envz vector は、文字列が "name=value (名前=値)" の形式になっている特別な argz vector である。最初の '=' 以降はすべて値とみなされる。'=' がなければ、 値は NULL と解釈される。(文字列の一番最後の文字が '=' の場合、値は空文字列 "" と解釈される。)

これらの関数は envz vector を操作するためのものである。

envz_add() は、文字列 name = value (value が NULL でない場合) または name (value が NULL の場合) を envz vector (*envz,*envz_len) に追加し、 *envz と *envz_len を更新する。 name と同じ名前を持つエントリがあった場合、元のエントリは削除される。

envz_entry() は、envz vector (envz,envz_len) から名前が name のエントリを検索する。 見つかった場合はそのエントリを返し、見つからなかった場合は NULL を返す。

envz_get() は、envz vector (envz,envz_len) から名前が name のエントリを検索する。 見つかった場合はエントリの値を返し、見つからなかった場合は NULL を返す。 (値は NULL の場合もあることに注意すること。名前が name のエントリに '=' 符号がない場合が該当する。)

envz_merge() は、 envz_add() と同じように envz2 の各エントリを *envz に追加する。 override が真の場合、 envz2 の値で *envz 内の同じ名前をもつ値は上書きされる。 偽の場合は上書きされない。

envz_remove() は、名前が name のエントリがあれば (*envz,*envz_len) から削除する。

envz_strip() は、値が NULL のエントリをすべて削除する。

返り値

メモリ割り当てを行う envz 関数群はすべて error_t 型の返り値を持つ。 成功した場合は 0 を返し、割り当てエラーが発生した場合は ENOMEM を返す。

準拠

これらの関数は GNU による拡張である。注意して使用すること。

例

 #include <stdio.h>
 #include <envz.h>
 
 int
 main(int argc, char *argv[], char *envp[])
 {
     int i, e_len = 0;
     char *str;
 
     for (i=0; envp[i] != NULL; i++)
         e_len += strlen(envp[i]) + 1;
 
     str = envz_entry(*envp, e_len, "HOME");
     printf("%s\n", str);
     str = envz_get(*envp, e_len, "HOME");
     printf("%s\n", str);
     exit(EXIT_SUCCESS);
 }
 

関連項目

argz(3)