xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_HSTSWRITEDATA.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_HSTSWRITEDATA
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerProtocol:
8*6236dae4SAndroid Build Coastguard Worker  - HTTP
9*6236dae4SAndroid Build Coastguard WorkerSee-also:
10*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HSTS (3)
11*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HSTSREADDATA (3)
12*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HSTSREADFUNCTION (3)
13*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_HSTSWRITEFUNCTION (3)
14*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.74.0
15*6236dae4SAndroid Build Coastguard Worker---
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard Worker# NAME
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard WorkerCURLOPT_HSTSWRITEDATA - pointer passed to the HSTS write callback
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker~~~c
24*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEDATA, void *pointer);
27*6236dae4SAndroid Build Coastguard Worker~~~
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard WorkerData *pointer* to pass to the HSTS write function. If you use the
32*6236dae4SAndroid Build Coastguard WorkerCURLOPT_HSTSWRITEFUNCTION(3) option, this is the pointer you get as
33*6236dae4SAndroid Build Coastguard Workerinput in the fourth argument to the callback.
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard WorkerThis option does not enable HSTS, you need to use CURLOPT_HSTS_CTRL(3) to
36*6236dae4SAndroid Build Coastguard Workerdo that.
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard Worker# DEFAULT
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard WorkerNULL
41*6236dae4SAndroid Build Coastguard Worker
42*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Worker~~~c
47*6236dae4SAndroid Build Coastguard Workerstruct MyData {
48*6236dae4SAndroid Build Coastguard Worker  void *custom;
49*6236dae4SAndroid Build Coastguard Worker};
50*6236dae4SAndroid Build Coastguard Worker
51*6236dae4SAndroid Build Coastguard Workerint main(void)
52*6236dae4SAndroid Build Coastguard Worker{
53*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
54*6236dae4SAndroid Build Coastguard Worker  struct MyData this;
55*6236dae4SAndroid Build Coastguard Worker  if(curl) {
56*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
57*6236dae4SAndroid Build Coastguard Worker
58*6236dae4SAndroid Build Coastguard Worker    /* pass pointer that gets passed in to the
59*6236dae4SAndroid Build Coastguard Worker       CURLOPT_HSTSWRITEFUNCTION callback */
60*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_HSTSWRITEDATA, &this);
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker    curl_easy_perform(curl);
63*6236dae4SAndroid Build Coastguard Worker  }
64*6236dae4SAndroid Build Coastguard Worker}
65*6236dae4SAndroid Build Coastguard Worker~~~
66*6236dae4SAndroid Build Coastguard Worker
67*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
68*6236dae4SAndroid Build Coastguard Worker
69*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard WorkerThis returns CURLE_OK.
72