mirror of https://github.com/curl/curl.git synced 2026-01-18 17:21:26 +01:00

Files

Patrick Monnerat 92e6782d1f doc: some returned in-memory data may not be altered

Some public prototypes do not declare return values or out parameters as
const where they should be. Avoid changing the public interface, but
document those values as read-only.

Closes #19692

2025-11-25 11:05:27 +01:00

1.6 KiB

Raw Permalink Blame History

c, SPDX-License-Identifier, Title, Section, Source, See-also, Protocol, Added-in

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

curl_pushheader_bynum

libcurl

CURLMOPT_PUSHFUNCTION (3)

curl_pushheader_byname (3)

HTTP

7.44.0

NAME

curl_pushheader_bynum - get a push header by index

SYNOPSIS

#include <curl/curl.h>

char *curl_pushheader_bynum(struct curl_pushheaders *h, size_t num);

DESCRIPTION

This is a function that is only functional within a CURLMOPT_PUSHFUNCTION(3) callback. It makes no sense to try to use it elsewhere and it has no function then.

It returns the value for the header field at the given index num, for the incoming server push request or NULL. The data pointed to is freed by libcurl when this callback returns. The returned pointer points to a "name:value" string that gets freed when this callback returns; although not constrained by its type, this string may not be altered.

%PROTOCOLS%

EXAMPLE

/* output all the incoming push request headers */
static int push_cb(CURL *parent,
                   CURL *easy,
                   size_t num_headers,
                   struct curl_pushheaders *headers,
                   void *clientp)
{
  int i = 0;
  char *field;
  do {
     field = curl_pushheader_bynum(headers, i);
     if(field)
       fprintf(stderr, "Push header: %s\n", field);
     i++;
  } while(field);
  return CURL_PUSH_OK; /* permission granted */
}

int main(void)
{
  CURLM *multi = curl_multi_init();
  curl_multi_setopt(multi, CURLMOPT_PUSHFUNCTION, push_cb);
}

%AVAILABILITY%

RETURN VALUE

Returns a pointer to the header field content or NULL.

1.6 KiB Raw Permalink Blame History