Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / curl_strequal.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .TH curl_strequal 3 "June 29, 2017" "libcurl 7.59.0" "libcurl Manual"
23
24 .SH NAME
25 curl_strequal, curl_strnequal - case insensitive string comparisons
26 .SH SYNOPSIS
27 .B #include <curl/curl.h>
28 .sp
29 .BI "int curl_strequal(char *" str1 ", char *" str2 ");"
30 .sp
31 .BI "int curl_strnequal(char *" str1 ", char *" str2 ", size_t " len ");"
32 .SH DESCRIPTION
33 The
34 .B curl_strequal()
35 function compares the two strings \fIstr1\fP and \fIstr2\fP, ignoring the case
36 of the characters. It returns a non-zero (TRUE) integer if the strings are
37 identical.
38 .sp
39 The \fBcurl_strnequal()\fP function is similar, except it only compares the
40 first \fIlen\fP characters of \fIstr1\fP.
41 .sp
42 These functions are provided by libcurl to enable applications to compare
43 strings in a truly portable manner. There are no standard portable case
44 insensitive string comparison functions. These two work on all platforms.
45 .SH AVAILABILITY
46 These functions will be removed from the public libcurl API in a near
47 future. They will instead be made "available" by source code access only, and
48 then as curlx_strequal() and curlx_strenqual().
49 .SH RETURN VALUE
50 Non-zero if the strings are identical. Zero if they're not.
51 .SH "SEE ALSO"
52 .BR strcmp "(3), " strcasecmp "(3)"