summaryrefslogtreecommitdiffstats
path: root/nsprpub/pr/include/prenv.h
diff options
context:
space:
mode:
Diffstat (limited to 'nsprpub/pr/include/prenv.h')
-rw-r--r--nsprpub/pr/include/prenv.h52
1 files changed, 26 insertions, 26 deletions
diff --git a/nsprpub/pr/include/prenv.h b/nsprpub/pr/include/prenv.h
index 468c7d596..550f05c93 100644
--- a/nsprpub/pr/include/prenv.h
+++ b/nsprpub/pr/include/prenv.h
@@ -18,18 +18,18 @@ PR_BEGIN_EXTERN_C
/*
** PR_GetEnv() -- Retrieve value of environment variable
-**
+**
** Description:
** PR_GetEnv() is modeled on Unix getenv().
-**
-**
-** Inputs:
+**
+**
+** Inputs:
** var -- The name of the environment variable
-**
+**
** Returns:
** The value of the environment variable 'var' or NULL if
** the variable is undefined.
-**
+**
** Restrictions:
** You'd think that a POSIX getenv(), putenv() would be
** consistently implemented everywhere. Surprise! It is not. On
@@ -42,33 +42,33 @@ PR_BEGIN_EXTERN_C
** un-set; a subsequent call to getenv() returns NULL. On
** other platforms, a subsequent call to getenv() returns a
** pointer to a null-string (a byte of zero).
-**
-** PR_GetEnv(), PR_SetEnv() provide a consistent behavior
+**
+** PR_GetEnv(), PR_SetEnv() provide a consistent behavior
** across all supported platforms. There are, however, some
** restrictions and some practices you must use to achieve
** consistent results everywhere.
-**
+**
** When manipulating the environment there is no way to un-set
** an environment variable across all platforms. We suggest
** you interpret the return of a pointer to null-string to
** mean the same as a return of NULL from PR_GetEnv().
-**
+**
** A call to PR_SetEnv() where the parameter is of the form
** "name" will return PR_FAILURE; the environment remains
** unchanged. A call to PR_SetEnv() where the parameter is
** of the form "name=" may un-set the envrionment variable on
** some platforms; on others it may set the value of the
** environment variable to the null-string.
-**
+**
** For example, to test for NULL return or return of the
** null-string from PR_GetEnv(), use the following code
** fragment:
-**
+**
** char *val = PR_GetEnv("foo");
-** if ((NULL == val) || ('\0' == *val)) {
-** ... interpret this as un-set ...
+** if ((NULL == val) || ('\0' == *val)) {
+** ... interpret this as un-set ...
** }
-**
+**
** The caller must ensure that the string passed
** to PR_SetEnv() is persistent. That is: The string should
** not be on the stack, where it can be overwritten
@@ -77,16 +77,16 @@ PR_BEGIN_EXTERN_C
** overwritten by other actions of the process. ... Some
** platforms use the string by reference rather than copying
** it into the environment space. ... You have been warned!
-**
+**
** Use of platform-native functions that manipulate the
-** environment (getenv(), putenv(),
+** environment (getenv(), putenv(),
** SetEnvironmentVariable(), etc.) must not be used with
** NSPR's similar functions. The platform-native functions
** may not be thread safe and/or may operate on different
** conceptual environment space than that operated upon by
** NSPR's functions or other environment manipulating
** functions on the same platform. (!)
-**
+**
*/
NSPR_API(char*) PR_GetEnv(const char *var);
@@ -106,24 +106,24 @@ NSPR_API(char*) PR_GetEnvSecure(const char *var);
/*
** PR_SetEnv() -- set, unset or change an environment variable
-**
+**
** Description:
** PR_SetEnv() is modeled on the Unix putenv() function.
-**
-** Inputs:
+**
+** Inputs:
** string -- pointer to a caller supplied
** constant, persistent string of the form name=value. Where
** name is the name of the environment variable to be set or
** changed; value is the value assigned to the variable.
**
-** Returns:
+** Returns:
** PRStatus.
-**
-** Restrictions:
+**
+** Restrictions:
** See the Restrictions documented in the description of
** PR_GetEnv() in this header file.
-**
-**
+**
+**
*/
NSPR_API(PRStatus) PR_SetEnv(const char *string);