libcURL.ResponseHeaderEngine.GetHeader

libcURL.ResponseHeaderEngine.GetHeader

Method Signature

 Function GetHeader(Name As String, Index As Integer = 0, Origin As libcURL.HeaderOriginType = libcURL.HeaderOriginType.Any, RequestIndex As Integer = -1) As libcURL.ResponseHeader

Parameters

Name	Type	Comment
Name	String	The name of the header to get.
Index	Integer	Optional. There may be more than one header of the same name for a given transfer. This parameter specifies the index of the named header, 0 or higher.
Origin	HeaderOriginType	Optional. The origin type of the header to get.
RequestIndex	Integer	Optional. The request index of the header to get.

Return value

An instance of the ResponseHeader class representing the matching header, or Nil if no headers match.

Remarks

Retrieves the response header that matches all of the parameters. If a parameter is unspecified then all headers match it. If there is more than one header that matches all the parameters, then specify the Index parameter to indicate which of these you want.

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.