curl/docs/libcurl/opts/CURLOPT_RANDOM_FILE.md
Daniel Stenberg e694c8284a
docs/libcurl/opts: clarify the return values
Expand a little.

- mention the type name of the return code
- avoid stating which exact return codes that might be returned, as that
  varies over time, builds and conditions
- avoid stating some always return OK
- refer to the manpage documenting all the return codes

Closes #15900
2025-01-02 17:13:33 +01:00

48 lines
756 B
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_RANDOM_FILE
Section: 3
Source: libcurl
See-also:
- CURLOPT_EGDSOCKET (3)
Protocol:
- TLS
TLS-backend:
- OpenSSL
Added-in: 7.7
---
# NAME
CURLOPT_RANDOM_FILE - file to read random data from
# SYNOPSIS
~~~c
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANDOM_FILE, char *path);
~~~
# DESCRIPTION
Deprecated option. It serves no purpose anymore.
# DEFAULT
NULL, not used
# DEPRECATED
Deprecated since 7.84.0.
# %AVAILABILITY%
# RETURN VALUE
curl_easy_setopt(3) returns a CURLcode indicating success or error.
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
libcurl-errors(3).