HttpWebRequest.Referer Property

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Source:

HttpWebRequest.cs

Gets or sets the value of the Referer HTTP header.

public:
 property System::String ^ Referer { System::String ^ get(); void set(System::String ^ value); };

public string? Referer { get; set; }

member this.Referer : string with get, set

Public Property Referer As String

Property Value

String

The value of the Referer HTTP header. The default value is null.

Examples

The following code example sets the Referer property.

// Create a 'HttpWebRequest' object.
HttpWebRequest^ myHttpWebRequest = (HttpWebRequest^)( WebRequest::Create( myUri ) );
// Set referer property  to http://www.microsoft.com .
myHttpWebRequest->Referer = "http://www.microsoft.com";
// Assign the response object of 'HttpWebRequest' to a 'HttpWebResponse' variable.
HttpWebResponse^ myHttpWebResponse = (HttpWebResponse^)( myHttpWebRequest->GetResponse() );
// Display the contents of the page to the console.
Stream^ streamResponse = myHttpWebResponse->GetResponseStream();
StreamReader^ streamRead = gcnew StreamReader( streamResponse );
array<Char>^ readBuffer = gcnew array<Char>(256);
int count = streamRead->Read( readBuffer, 0, 256 );
Console::WriteLine( "\nThe contents of HTML page are......." );
while ( count > 0 )
{
   String^ outputData = gcnew String( readBuffer,0,count );
   Console::Write( outputData );
   count = streamRead->Read( readBuffer, 0, 256 );
}
Console::WriteLine( "\nHTTP Request  Headers :\n\n {0}", myHttpWebRequest->Headers );
Console::WriteLine( "\nHTTP Response Headers :\n\n {0}", myHttpWebResponse->Headers );
streamRead->Close();
streamResponse->Close();
// Release the response object resources.
myHttpWebResponse->Close();
Console::WriteLine( "Referer to the site is: {0}", myHttpWebRequest->Referer );

// Create a 'HttpWebRequest' object.
HttpWebRequest	myHttpWebRequest=(HttpWebRequest)WebRequest.Create(myUri);
// Set referer property  to http://www.microsoft.com .
myHttpWebRequest.Referer="http://www.microsoft.com";
// Assign the response object of 'HttpWebRequest' to a 'HttpWebResponse' variable.
HttpWebResponse myHttpWebResponse=(HttpWebResponse)myHttpWebRequest.GetResponse();
// Display the contents of the page to the console.
Stream streamResponse=myHttpWebResponse.GetResponseStream();
StreamReader streamRead = new StreamReader( streamResponse );
Char[] readBuffer = new Char[256];
int count = streamRead.Read( readBuffer, 0, 256 );
Console.WriteLine("\nThe contents of HTML page are.......");	
while (count > 0)
{
    String outputData = new String(readBuffer, 0, count);
    Console.Write(outputData);
    count = streamRead.Read(readBuffer, 0, 256);
}
Console.WriteLine("\nHTTP Request  Headers :\n\n{0}",myHttpWebRequest.Headers);
Console.WriteLine("\nHTTP Response Headers :\n\n{0}",myHttpWebResponse.Headers);	
streamRead.Close();
streamResponse.Close();
// Release the response object resources.
myHttpWebResponse.Close();
Console.WriteLine("Referer to the site is:{0}",myHttpWebRequest.Referer);

' Create a 'HttpWebRequest' object.
Dim myHttpWebRequest As HttpWebRequest = CType(WebRequest.Create(myUri), HttpWebRequest)
' Referer property is set to http://www.microsoft.com
myHttpWebRequest.Referer = "http://www.microsoft.com"
' The response object of 'HttpWebRequest' is assigned to a 'HttpWebResponse' variable.
Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
' Displaying the contents of the page to the console
Dim streamResponse As Stream = myHttpWebResponse.GetResponseStream()
Dim streamRead As New StreamReader(streamResponse)
Dim readBuffer(256) As [Char]
Dim count As Integer = streamRead.Read(readBuffer, 0, 256)
Console.WriteLine(ControlChars.Cr + "The contents of HTML page are.......")
While count > 0
    Dim outputData As New [String](readBuffer, 0, count)
    Console.Write(outputData)
    count = streamRead.Read(readBuffer, 0, 256)
End While
Console.WriteLine(ControlChars.Cr + "HTTP Request  Headers :" + ControlChars.Cr + ControlChars.Cr + "{0}", myHttpWebRequest.Headers)
Console.WriteLine(ControlChars.Cr + "HTTP Response Headers :" + ControlChars.Cr + ControlChars.Cr + "{0}", myHttpWebResponse.Headers)
' Release the response object resources.
streamRead.Close()
 streamResponse.Close()
myHttpWebResponse.Close()
Console.WriteLine("Referer to the site is:{0}", myHttpWebRequest.Referer)

Remarks

If the AllowAutoRedirect property is true, the Referer property is set automatically when the request is redirected to another site.

To clear the Referer HTTP header, set the Referer property to null.

Note

The value for this property is stored in WebHeaderCollection. If WebHeaderCollection is set, the property value is lost.