mirror of
https://github.com/moparisthebest/curl
synced 2024-11-17 23:15:08 -05:00
45 lines
1.8 KiB
Groff
45 lines
1.8 KiB
Groff
|
.\" **************************************************************************
|
||
|
.\" * _ _ ____ _
|
||
|
.\" * Project ___| | | | _ \| |
|
||
|
.\" * / __| | | | |_) | |
|
||
|
.\" * | (__| |_| | _ <| |___
|
||
|
.\" * \___|\___/|_| \_\_____|
|
||
|
.\" *
|
||
|
.\" * Copyright (C) 1998 - 2014, 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 http://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 CURLOPT_SOCKOPTDATA 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
||
|
.SH NAME
|
||
|
CURLOPT_SOCKOPTDATA \- custom pointer to pass to sockopt callback
|
||
|
.SH SYNOPSIS
|
||
|
#include <curl/curl.h>
|
||
|
|
||
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKOPTDATA, void *pointer);
|
||
|
.SH DESCRIPTION
|
||
|
Pass a \fIpointer\fP that will be untouched by libcurl and passed as the first
|
||
|
argument in the sockopt callback set with \fICURLOPT_SOCKOPTFUNCTION(3)\fP.
|
||
|
.SH DEFAULT
|
||
|
The default value of this parameter is NULL.
|
||
|
.SH PROTOCOLS
|
||
|
All
|
||
|
.SH EXAMPLE
|
||
|
TODO
|
||
|
.SH AVAILABILITY
|
||
|
Added in 7.16.0
|
||
|
.SH RETURN VALUE
|
||
|
Returns \fICURLE_OK\fP if the option is supported, and \fICURLE_UNKNOWN_OPTION\fP if not.
|
||
|
.SH "SEE ALSO"
|
||
|
.BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_OPENSOCKETFUNCTION "(3), "
|