xref: /aosp_15_r20/external/curl/docs/libcurl/curl_mime_name.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: curl_mime_name
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - curl_mime_addpart (3)
9*6236dae4SAndroid Build Coastguard Worker  - curl_mime_data (3)
10*6236dae4SAndroid Build Coastguard Worker  - curl_mime_type (3)
11*6236dae4SAndroid Build Coastguard WorkerProtocol:
12*6236dae4SAndroid Build Coastguard Worker  - HTTP
13*6236dae4SAndroid Build Coastguard Worker  - IMAP
14*6236dae4SAndroid Build Coastguard Worker  - SMTP
15*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.56.0
16*6236dae4SAndroid Build Coastguard Worker---
17*6236dae4SAndroid Build Coastguard Worker
18*6236dae4SAndroid Build Coastguard Worker# NAME
19*6236dae4SAndroid Build Coastguard Worker
20*6236dae4SAndroid Build Coastguard Workercurl_mime_name - set a mime part's name
21*6236dae4SAndroid Build Coastguard Worker
22*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
23*6236dae4SAndroid Build Coastguard Worker
24*6236dae4SAndroid Build Coastguard Worker~~~c
25*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
26*6236dae4SAndroid Build Coastguard Worker
27*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_mime_name(curl_mimepart *part, const char *name);
28*6236dae4SAndroid Build Coastguard Worker~~~
29*6236dae4SAndroid Build Coastguard Worker
30*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
31*6236dae4SAndroid Build Coastguard Worker
32*6236dae4SAndroid Build Coastguard Workercurl_mime_name(3) sets a mime part's name. This is the way HTTP form
33*6236dae4SAndroid Build Coastguard Workerfields are named.
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard Worker*part* is the part's handle to assign a name to.
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard Worker*name* points to the null-terminated name string.
38*6236dae4SAndroid Build Coastguard Worker
39*6236dae4SAndroid Build Coastguard WorkerThe name string is copied into the part, thus the associated storage may
40*6236dae4SAndroid Build Coastguard Workersafely be released or reused after call. Setting a part's name multiple times
41*6236dae4SAndroid Build Coastguard Workeris valid: only the value set by the last call is retained. It is possible to
42*6236dae4SAndroid Build Coastguard Workerreset the name of a part by setting *name* to NULL.
43*6236dae4SAndroid Build Coastguard Worker
44*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
47*6236dae4SAndroid Build Coastguard Worker
48*6236dae4SAndroid Build Coastguard Worker~~~c
49*6236dae4SAndroid Build Coastguard Workerint main(void)
50*6236dae4SAndroid Build Coastguard Worker{
51*6236dae4SAndroid Build Coastguard Worker  curl_mime *mime;
52*6236dae4SAndroid Build Coastguard Worker  curl_mimepart *part;
53*6236dae4SAndroid Build Coastguard Worker
54*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
55*6236dae4SAndroid Build Coastguard Worker  if(curl) {
56*6236dae4SAndroid Build Coastguard Worker    /* create a mime handle */
57*6236dae4SAndroid Build Coastguard Worker    mime = curl_mime_init(curl);
58*6236dae4SAndroid Build Coastguard Worker
59*6236dae4SAndroid Build Coastguard Worker    /* add a part */
60*6236dae4SAndroid Build Coastguard Worker    part = curl_mime_addpart(mime);
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker    /* give the part a name */
63*6236dae4SAndroid Build Coastguard Worker    curl_mime_name(part, "shoe_size");
64*6236dae4SAndroid Build Coastguard Worker  }
65*6236dae4SAndroid Build Coastguard Worker}
66*6236dae4SAndroid Build Coastguard Worker~~~
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
69*6236dae4SAndroid Build Coastguard Worker
70*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
71*6236dae4SAndroid Build Coastguard Worker
72*6236dae4SAndroid Build Coastguard WorkerCURLE_OK or a CURL error code upon failure.
73