libcURL.ResponseHeaderEngine.GetHeaders

libcURL.ResponseHeaderEngine.GetHeaders

Method Signature

 Function GetHeaders(Name As String = "", Origin As libcURL.HeaderOriginType = libcURL.HeaderOriginType.Any, RequestIndex As Integer = -1) As libcURL.ResponseHeader()

Parameters

Name	Type	Comment
Name	String	Optional. The name of the headers to get.
Origin	HeaderOriginType	Optional. The origin type of the headers to get.
RequestIndex	Integer	Optional. The request index of the headers to get.

Return value

An array of zero or more ResponseHeader objects, representing the matching response headers.

Remarks

Retrieves the response headers that matches all of the parameters. If a parameter is unspecified then all headers match it.

Response headers may originate from several different stages in an HTTP(S) operation depending on circumstances such as proxying, HTTP version, redirection, etc. The Origin parameter restricts the query to headers originating only during a particular stage.

A single transfer might consist of a series of HTTP requests, for example redirects or multi-stage authentication. The RequestIndex parameter lets you specify which request you want. 0 being the first request, 1 being the next, and so on. -1 refers to the most recent request in the series. -2 refers to all headers across all transfers. Refer to the RequestCount() method to determine the number of transfers.