WebHeaderCollection.Get Method

Definition

Namespace:

System.Net

Assembly:

System.Net.WebHeaderCollection.dll

Gets the value of a header from the collection.

Overloads

Get(Int32)	Gets the value of a particular header in the collection, specified by an index into the collection.
Get(String)	Gets the value of a particular header in the collection, specified by the name of the header.

Get(Int32)

Source:

WebHeaderCollection.cs

Gets the value of a particular header in the collection, specified by an index into the collection.

public:
 override System::String ^ Get(int index);

public override string? Get (int index);

override this.Get : int -> string

Public Overrides Function Get (index As Integer) As String

Parameters

index

Int32

The zero-based index of the key to get from the collection.

Returns

String

A String containing the value of the specified header.

Exceptions

ArgumentOutOfRangeException

index is negative.

-or-

index exceeds the size of the collection.

Examples

The following code example uses the Get method to retrieve a header value in a WebHeaderCollection.

if (args.Length == 0)
{
    Console.WriteLine("must specify a URL!");
    return;
}
string server = args[0];

// Create the web request 
HttpWebRequest myHttpWebRequest = 
    (HttpWebRequest) WebRequest.Create(server);
myHttpWebRequest.Timeout = 1000;
// Get the associated response for the above request.
HttpWebResponse myHttpWebResponse = 
    (HttpWebResponse) myHttpWebRequest.GetResponse();

// Get the headers associated with the response.
WebHeaderCollection myWebHeaderCollection = 
    myHttpWebResponse.Headers;

for(int i = 0; i < myWebHeaderCollection.Count; i++)
{
    String header = myWebHeaderCollection.GetKey(i);
    String[] values = 
        myWebHeaderCollection.GetValues(header);
    if(values.Length > 0) 
    {
        Console.WriteLine("The values of {0} header are : "
                         , header);
        for(int j = 0; j < values.Length; j++) 
            Console.WriteLine("\t{0}", values[j]);
    }
    else
        Console.WriteLine("There is no value associated" +
            "with the header");
}
Console.WriteLine("");

// Get the headers again, using new properties (Keys, 
// AllKeys, Clear) and methods (Get and GetKey)

string[] headers = myWebHeaderCollection.AllKeys;

// enumerate through the header collection.
foreach (string s in headers)
{
    Console.WriteLine("Header {0}, value {1}",
        s,
        myWebHeaderCollection.Get(s) );
}

Console.WriteLine("");

// show the use of Get(Int32) and GetValue(Int32)
if (myWebHeaderCollection.Count > 0)
{
    // get the name and value of the first header
    int index=0;
    Console.WriteLine("Header {0}: name {1}, value {2}",
        index, 
        myWebHeaderCollection.GetKey(index),
        myWebHeaderCollection.Get(index));
}

myWebHeaderCollection.Clear();

myHttpWebResponse.Close();

Get(String)

Source:

WebHeaderCollection.cs

Gets the value of a particular header in the collection, specified by the name of the header.

public:
 override System::String ^ Get(System::String ^ name);

public override string? Get (string? name);

override this.Get : string -> string

Public Overrides Function Get (name As String) As String

Parameters

name

String

The name of the Web header.

Returns

String

A String holding the value of the specified header.

Examples

The following code example uses the Get property to retrieve header values in a WebHeaderCollection.

if (args.Length == 0)
{
    Console.WriteLine("must specify a URL!");
    return;
}
string server = args[0];

// Create the web request 
HttpWebRequest myHttpWebRequest = 
    (HttpWebRequest) WebRequest.Create(server);
myHttpWebRequest.Timeout = 1000;
// Get the associated response for the above request.
HttpWebResponse myHttpWebResponse = 
    (HttpWebResponse) myHttpWebRequest.GetResponse();

// Get the headers associated with the response.
WebHeaderCollection myWebHeaderCollection = 
    myHttpWebResponse.Headers;

for(int i = 0; i < myWebHeaderCollection.Count; i++)
{
    String header = myWebHeaderCollection.GetKey(i);
    String[] values = 
        myWebHeaderCollection.GetValues(header);
    if(values.Length > 0) 
    {
        Console.WriteLine("The values of {0} header are : "
                         , header);
        for(int j = 0; j < values.Length; j++) 
            Console.WriteLine("\t{0}", values[j]);
    }
    else
        Console.WriteLine("There is no value associated" +
            "with the header");
}
Console.WriteLine("");

// Get the headers again, using new properties (Keys, 
// AllKeys, Clear) and methods (Get and GetKey)

string[] headers = myWebHeaderCollection.AllKeys;

// enumerate through the header collection.
foreach (string s in headers)
{
    Console.WriteLine("Header {0}, value {1}",
        s,
        myWebHeaderCollection.Get(s) );
}

Console.WriteLine("");

// show the use of Get(Int32) and GetValue(Int32)
if (myWebHeaderCollection.Count > 0)
{
    // get the name and value of the first header
    int index=0;
    Console.WriteLine("Header {0}: name {1}, value {2}",
        index, 
        myWebHeaderCollection.GetKey(index),
        myWebHeaderCollection.Get(index));
}

myWebHeaderCollection.Clear();

myHttpWebResponse.Close();

Remarks

This method returns null if there is no name header in the collection.