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