release/man3/envz_add.3

   1 .\" Copyright 2002 walter harms (walter.harms@informatik.uni-oldenburg.de)
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" Distributed under GPL
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\" based on the description in glibc source and infopages
   8 .\"
   9 .\" Corrections and additions, aeb
  10 .\"*******************************************************************
  11 .\"
  12 .\" This file was generated with po4a. Translate the source file.
  13 .\"
  14 .\"*******************************************************************
  15 .TH ENVZ_ADD 3 2007\-05\-18 "" "Linux Programmer's Manual"
  16 .SH 名前
  17 envz_add, envz_entry, envz_get, envz_merge, envz_remove, envz_strip \-
  18 環境変数文字列の操作
  19 .SH 書式
  20 .nf
  21 \fB#include <envz.h>\fP
  22
  23 \fBerror_t envz_add(char **\fP\fIenvz\fP\fB, size_t *\fP\fIenvz_len\fP\fB,\fP
  24 .ti 20n
  25 \fBconst char *\fP\fIname\fP\fB, const char *\fP\fIvalue\fP\fB);\fP
  26
  27 \fBchar *envz_entry(const char *\fP\fIenvz\fP\fB, size_t *\fP\fIenvz_len\fP\fB, const char *\fP\fIname\fP\fB);\fP
  28
  29 \fBchar *envz_get(const char *\fP\fIenvz\fP\fB, size_t *\fP\fIenvz_len\fP\fB, const char *\fP\fIname\fP\fB);\fP
  30
  31 \fBerror_t envz_merge(char **\fP\fIenvz\fP\fB, size_t *\fP\fIenvz_len\fP\fB,\fP
  32 .ti 20n
  33 \fBconst char *\fP\fIenvz2\fP\fB, size_t \fP\fIenvz2_len\fP\fB, int \fP\fIoverride\fP\fB);\fP
  34
  35 \fBvoid envz_remove(char **\fP\fIenvz\fP\fB, size_t *\fP\fIenvz_len\fP\fB, const char *\fP\fIname\fP\fB);\fP
  36
  37 \fBvoid envz_strip(char **\fP\fIenvz\fP\fB, size_t *\fP\fIenvz_len\fP\fB);\fP
  38 .fi
  39 .SH 説明
  40 これらの関数は glibc 固有である。
  41 .LP
  42 argz vector は長さ情報付きの文字バッファへのポインタである。 \fBargz_add\fP(3)  を参照のこと。 envz vector
  43 は、文字列が "name=value (名前=値)" の形式になっている特別な argz vector である。 最初の \(aq=\(aq
  44 以降はすべて値とみなされる。\(aq=\(aq がなければ、 値は NULL と解釈される。(文字列の一番最後の文字が \(aq=\(aq
  45 の場合、値は空文字列 "" と解釈される。)
  46 .LP
  47 これらの関数は envz vector を操作するためのものである。
  48 .LP
  49 \fBenvz_add\fP()  は、文字列 "\fIname\fP=\fIvalue\fP" (\fIvalue\fP が NULL でない場合) または
  50 "\fIname\fP" (\fIvalue\fP が NULL の場合) を envz vector (\fI*envz\fP,\ \fI*envz_len\fP)
  51 に追加し、 \fI*envz\fP と \fI*envz_len\fP を更新する。 \fIname\fP
  52 と同じ名前を持つエントリがあった場合、元のエントリは削除される。
  53 .LP
  54 \fBenvz_entry\fP()  は、envz vector (\fIenvz\fP,\ \fIenvz_len\fP)  から名前が \fIname\fP
  55 のエントリを検索する。 見つかった場合はそのエントリを返し、見つからなかった場合は NULL を返す。
  56 .LP
  57 \fBenvz_get\fP()  は、envz vector (\fIenvz\fP,\ \fIenvz_len\fP)  から名前が \fIname\fP
  58 のエントリを検索する。 見つかった場合はエントリの値を返し、見つからなかった場合は NULL を返す。 (値は NULL
  59 の場合もあることに注意すること。名前が \fIname\fP のエントリに \(aq=\(aq 符号がない場合が該当する。)
  60 .LP
  61 \fBenvz_merge\fP()  は、 \fBenvz_add\fP()  と同じように \fIenvz2\fP の各エントリを \fI*envz\fP に追加する。
  62 \fIoverride\fP が真の場合、 \fIenvz2\fP の値で \fI*envz\fP 内の同じ名前をもつ値は上書きされる。 偽の場合は上書きされない。
  63 .LP
  64 \fBenvz_remove\fP()  は、名前が \fIname\fP のエントリがあれば (\fI*envz\fP,\ \fI*envz_len\fP)  から削除する。
  65 .LP
  66 \fBenvz_strip\fP()  は、値が NULL のエントリをすべて削除する。
  67 .SH 返り値
  68 メモリ割り当てを行う envz 関数群はすべて \fIerror_t\fP 型の返り値を持つ。 成功した場合は 0 を返し、割り当てエラーが発生した場合は
  69 \fBENOMEM\fP を返す。
  70 .SH 準拠
  71 これらの関数は GNU による拡張である。注意して使用すること。
  72 .SH 例
  73 .nf
  74 #include <stdio.h>
  75 #include <stdlib.h>
  76 #include <envz.h>
  77
  78 int
  79 main(int argc, char *argv[], char *envp[])
  80 {
  81     int i, e_len = 0;
  82     char *str;
  83
  84     for (i = 0; envp[i] != NULL; i++)
  85         e_len += strlen(envp[i]) + 1;
  86
  87     str = envz_entry(*envp, e_len, "HOME");
  88     printf("%s\en", str);
  89     str = envz_get(*envp, e_len, "HOME");
  90     printf("%s\en", str);
  91     exit(EXIT_SUCCESS);
  92 }
  93 .fi
  94 .SH 関連項目
  95 \fBargz_add\fP(3)
  96 .SH この文書について
  97 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.50 の一部
  98 である。プロジェクトの説明とバグ報告に関する情報は
  99 http://www.kernel.org/doc/man\-pages/ に書かれている。