mirror of
https://github.com/moparisthebest/curl
synced 2024-11-14 05:25:06 -05:00
032e838b73
Updated terminology in docs, comments and phrases to refer to C strings as "null-terminated". Done to unify with how most other C oriented docs refer of them and what users in general seem to prefer (based on a single highly unscientific poll on twitter). Reported-by: coinhubs on github Fixes #5598 Closes #5608
50 lines
2.1 KiB
Groff
50 lines
2.1 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2020, 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.haxx.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.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.TH curl_getenv 3 "30 April 2004" "libcurl 7.12" "libcurl Manual"
|
|
.SH NAME
|
|
curl_getenv - return value for environment name
|
|
.SH SYNOPSIS
|
|
.B #include <curl/curl.h>
|
|
.sp
|
|
.BI "char *curl_getenv(const char *" name ");"
|
|
.ad
|
|
.SH DESCRIPTION
|
|
curl_getenv() is a portable wrapper for the getenv() function, meant to
|
|
emulate its behaviour 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're done with it.
|
|
.SH AVAILABILITY
|
|
This function will be removed from the public libcurl API in a near future. It
|
|
will instead be made "available" by source code access only, and then as
|
|
curlx_getenv().
|
|
.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 isn't any point in returning an allocated
|
|
memory, although other systems won't work properly if this isn't done. The
|
|
unix implementation thus has to suffer slightly from the drawbacks of other
|
|
systems.
|
|
.SH "SEE ALSO"
|
|
.BR getenv "(3C), "
|