58 lines
2.1 KiB
Groff
58 lines
2.1 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.TH curl_getenv 3 "30 April 2004" "libcurl" "libcurl"
|
|
.SH NAME
|
|
curl_getenv - return value for environment name
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
char *curl_getenv(const char *name);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
curl_getenv() is a portable wrapper for the getenv() function, meant to
|
|
emulate its behavior and provide an identical interface for all operating
|
|
systems libcurl builds on (including win32).
|
|
|
|
You must \fIcurl_free(3)\fP the returned string when you are done with it.
|
|
.SH EXAMPLE
|
|
.nf
|
|
char *width = curl_getenv("COLUMNS");
|
|
if(width) {
|
|
/* it was set! */
|
|
curl_free(width);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Always
|
|
.SH RETURN VALUE
|
|
A pointer to a null-terminated string or NULL if it failed to find the
|
|
specified name.
|
|
.SH NOTE
|
|
Under unix operating systems, there is no point in returning an allocated
|
|
memory, although other systems does not work properly if this is not done. The
|
|
unix implementation thus suffers slightly from the drawbacks of other systems.
|
|
.SH "SEE ALSO"
|
|
.BR getenv (3C)
|