| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
CURL.SetOptionNetRC
Sets netrc file preference.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| CURL | 2.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "CURL.SetOptionNetRC"; curl; Value ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| curl | The CURL session handle. | $curl |
| Value | The netrc preference. | 0 |
Result
Returns "OK" on success.
Description
Sets netrc file preference.This parameter controls the preference of libcurl between using user names and passwords from your ~/.netrc file, relative to user names and passwords in the URL supplied with CURLOPT_URL.
libcurl uses a user name (and supplied or prompted password) supplied with CURL.SetOptionUserName in preference to any of the options controlled by this parameter.
Pass a long, set to one of the values described below.
| CURL_NETRC_OPTIONAL | 1 | The use of your ~/.netrc file is optional, and information in the URL is to be preferred. The file will be scanned for the host and user name (to find the password only) or for the host only, to find the first user name and password after that machine, which ever information is not specified in the URL. | Undefined values of the option will have this effect. |
| CURL_NETRC_IGNORED | 0 | The library will ignore the file and use only the information in the URL. This is the default. | |
| CURL_NETRC_REQUIRED | 2 | This value tells the library that use of the file is required, to ignore the information in the URL, and to search the file for the host only. |
Only machine name, user name and password are taken into account (init macros and similar things aren't supported).
libcurl does not verify that the file has the correct properties set (as the standard Unix ftp client does). It should only be readable by user.
See also NETRC option in CURL manual.
See also
- CURL.SetOptionNETRCFile
- CURL.SetOptionNoBody
- CURL.SetOptionPort
- CURL.SetOptionPost
- CURL.SetOptionProxy
- CURL.SetOptionPut
- CURL.SetOptionRange
- CURL.SetOptionURL
- CURL.SetOptionUserName
- CURL.SetOptionUseSSL
Release notes
- Version 8.0
- Changed CURL.SetOptionCAINFO, CURL.SetOptionCAPATH, CURL.SetOptionCookieFile, CURL.SetOptionCookieJar, CURL.SetOptionIssuerCert, CURL.SetOptionNETRCFile, CURL.SetOptionRandomFile, CURL.SetOptionSSHPrivateKeyfile, CURL.SetOptionSSHPublicKeyfile, CURL.SetOptionSSLCert, CURL.SetOptionSSLKey to use always UTF-8 on Mac/Linux and on Mac do the unicode transformation for decomposed characters to avoid trouble with special characters in file paths.
Created 18th August 2014, last changed 5th July 2015
