WebHeaderCollection.Set Método

Referencia

Definición

Espacio de nombres:: System.Net

Ensamblado:: System.Net.WebHeaderCollection.dll

Ensamblado:: System.dll

Ensamblado:: netstandard.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Establece el encabezado especificado en el valor indicado.

Sobrecargas

Set(HttpRequestHeader, String)	Establece el encabezado especificado en el valor indicado.
Set(HttpResponseHeader, String)	Establece el encabezado especificado en el valor indicado.
Set(String, String)	Establece el encabezado especificado en el valor indicado.

Set(HttpRequestHeader, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Establece el encabezado especificado en el valor indicado.

public:
 void Set(System::Net::HttpRequestHeader header, System::String ^ value);

public void Set (System.Net.HttpRequestHeader header, string? value);

public void Set (System.Net.HttpRequestHeader header, string value);

override this.Set : System.Net.HttpRequestHeader * string -> unit

Public Sub Set (header As HttpRequestHeader, value As String)

Parámetros

header: HttpRequestHeader

Valor de HttpRequestHeader que se va a establecer.

value: String

Contenido del encabezado que se va a establecer.

Excepciones

ArgumentOutOfRangeException

.NET Framework y versiones 2.0-3.1 de .NET Core únicamente: la longitud de value es mayor de 65 535.

InvalidOperationException

Esta instancia de WebHeaderCollection no permite instancias de HttpRequestHeader.

Comentarios

Si el encabezado especificado en el encabezado no existe, el Set método inserta un nuevo encabezado en la lista de pares nombre-valor de encabezado.

Si el encabezado especificado en header ya está presente, value reemplaza el valor existente.

Nota

La longitud de value solo se valida en .NET Framework y .NET Core versiones 2.0 - 3.1.

En todas las versiones de .NET Framework aplicables: una WebHeaderCollection instancia devuelta por la Headers propiedad producirá una ArgumentOutOfRangeException excepción si la longitud de value es mayor que 65535. Todas las demás WebHeaderCollection instancias aceptan una value longitud de cualquier longitud.
En las versiones de .NET Core a través de la versión 3.1: una WebHeaderCollection instancia usada con cualquier encabezado de tipo HttpResponseHeader producirá una ArgumentOutOfRangeException excepción si la longitud de value es mayor que 65535. Todas las demás WebHeaderCollection instancias aceptan una value longitud de cualquier longitud.
En .NET 5 y versiones posteriores: WebHeaderCollection acepta una value longitud de cualquier longitud.

Se aplica a

Set(HttpResponseHeader, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Establece el encabezado especificado en el valor indicado.

public:
 void Set(System::Net::HttpResponseHeader header, System::String ^ value);

public void Set (System.Net.HttpResponseHeader header, string? value);

public void Set (System.Net.HttpResponseHeader header, string value);

override this.Set : System.Net.HttpResponseHeader * string -> unit

Public Sub Set (header As HttpResponseHeader, value As String)

Parámetros

header: HttpResponseHeader

Valor de HttpResponseHeader que se va a establecer.

value: String

Contenido del encabezado que se va a establecer.

Excepciones

ArgumentOutOfRangeException

.NET Framework y versiones 2.0-3.1 de .NET Core únicamente: la longitud de value es mayor de 65 535.

InvalidOperationException

Esta instancia de WebHeaderCollection no permite instancias de HttpResponseHeader.

Comentarios

Si el encabezado especificado en el encabezado no existe, el Set método inserta un nuevo encabezado en la lista de pares nombre-valor de encabezado.

Si el encabezado especificado en header ya está presente, value reemplaza el valor existente.

Nota

La longitud de value solo se valida en .NET Framework y .NET Core versiones 2.0 - 3.1.

En todas las versiones de .NET Framework aplicables: una WebHeaderCollection instancia devuelta por la Headers propiedad producirá una ArgumentOutOfRangeException excepción si la longitud de value es mayor que 65535. Todas las demás WebHeaderCollection instancias aceptan una value longitud de cualquier longitud.
En las versiones de .NET Core a través de la versión 3.1: una WebHeaderCollection instancia usada con cualquier encabezado de tipo HttpResponseHeader producirá una ArgumentOutOfRangeException excepción si la longitud de value es mayor que 65535. Todas las demás WebHeaderCollection instancias aceptan una value longitud de cualquier longitud.
En .NET 5 y versiones posteriores: WebHeaderCollection acepta una value longitud de cualquier longitud.

Se aplica a

Set(String, String)

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Source:: WebHeaderCollection.cs

Establece el encabezado especificado en el valor indicado.

public:
 override void Set(System::String ^ name, System::String ^ value);

public override void Set (string name, string? value);

public override void Set (string name, string value);

override this.Set : string * string -> unit

Public Overrides Sub Set (name As String, value As String)

Parámetros

name: String

Encabezado que se va a establecer.

value: String

Contenido del encabezado que se va a establecer.

Excepciones

ArgumentNullException

name es null o Empty.

ArgumentOutOfRangeException

.NET Framework y versiones 2.0-3.1 de .NET Core únicamente: la longitud de value es mayor de 65 535.

ArgumentException

name es un encabezado restringido.

o bien

name o value contienen caracteres no válidos.

Ejemplos

En el ejemplo siguiente se usa el Set método para establecer el valor de un encabezado existente.

try
{
   // Create a web request for S"www.msn.com".
   HttpWebRequest^ myHttpWebRequest = dynamic_cast<HttpWebRequest^>(WebRequest::Create( "http://www.msn.com" ));

   // Get the headers associated with the request.
   WebHeaderCollection^ myWebHeaderCollection = myHttpWebRequest->Headers;

   // Set the Cache-Control header in the request.
   myWebHeaderCollection->Set( "Cache-Control", "no-cache" );

   // Get the associated response for the above request.
   HttpWebResponse^ myHttpWebResponse = dynamic_cast<HttpWebResponse^>(myHttpWebRequest->GetResponse());
   Console::WriteLine( "Headers after 'Set' method is used on Cache-Control :" );

   // Print the headers for the request.
   PrintHeaders( myWebHeaderCollection );
   myHttpWebResponse->Close();
}
// Catch exception if trying to set a restricted header.
catch ( ArgumentException^ e ) 
{
   Console::WriteLine( "ArgumentException is thrown. Message is : {0}", e->Message );
}
catch ( WebException^ e ) 
{
   Console::WriteLine( "WebException is thrown. Message is : {0}", e->Message );
   if ( e->Status == WebExceptionStatus::ProtocolError )
   {
      Console::WriteLine( "Status Code : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->StatusCode );
      Console::WriteLine( "Status Description : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->StatusDescription );
      Console::WriteLine( "Server : {0}", (dynamic_cast<HttpWebResponse^>(e->Response))->Server );
   }
}
catch ( Exception^ e ) 
{
   Console::WriteLine( "Exception is thrown. Message is : {0}", e->Message );
}

try {
    // Create a web request for "www.msn.com".
    HttpWebRequest myHttpWebRequest = (HttpWebRequest) WebRequest.Create("http://www.msn.com");

    // Get the headers associated with the request.
    WebHeaderCollection myWebHeaderCollection = myHttpWebRequest.Headers;

    // Set the Cache-Control header in the request.
    myWebHeaderCollection.Set("Cache-Control", "no-cache");

    // Get the associated response for the above request.
    HttpWebResponse myHttpWebResponse = (HttpWebResponse) myHttpWebRequest.GetResponse();

    Console.WriteLine ("Headers after 'Set' method is used on Cache-Control :");
    // Print the headers for the request.
    PrintHeaders(myWebHeaderCollection);
    myHttpWebResponse.Close();
}
// Catch exception if trying to set a restricted header.
catch(ArgumentException e) {
    Console.WriteLine("ArgumentException is thrown. Message is :" + e.Message);
}
catch(WebException e) {
    Console.WriteLine("WebException is thrown. Message is :" + e.Message);
    if(e.Status == WebExceptionStatus.ProtocolError) {
        Console.WriteLine("Status Code : {0}", ((HttpWebResponse)e.Response).StatusCode);
        Console.WriteLine("Status Description : {0}", ((HttpWebResponse)e.Response).StatusDescription);
        Console.WriteLine("Server : {0}", ((HttpWebResponse)e.Response).Server);
    }
}
catch(Exception e) {
    Console.WriteLine("Exception is thrown. Message is :" + e.Message);
}

Public Shared Sub Main()

Try
        'Create a web request for "www.msn.com".
        Dim myHttpWebRequest As HttpWebRequest = CType(WebRequest.Create("http://www.msn.com"), HttpWebRequest)
        
        'Get the headers associated with the request.
        Dim myWebHeaderCollection As WebHeaderCollection = myHttpWebRequest.Headers
        
        'Set the Cache-Control header in the request.
        myWebHeaderCollection.Set("Cache-Control", "no-cache")

        'Get the associated response for the above request.
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        
    Console.WriteLine ("Headers after 'Set' method is used on Cache-Control :")
        'Print the headers for the request.
        PrintHeaders(myWebHeaderCollection)
        myHttpWebResponse.Close()
   'Catch exception if trying to set a restricted header.
    Catch e As ArgumentException
        Console.WriteLine(e.Message)
    Catch e As WebException
        Console.WriteLine(e.Message)
        If e.Status = WebExceptionStatus.ProtocolError Then
            Console.WriteLine("Status Code : {0}", CType(e.Response, HttpWebResponse).StatusCode)
            Console.WriteLine("Status Description : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
            Console.WriteLine("Server : {0}", CType(e.Response, HttpWebResponse).Server)
        End If
    Catch e As Exception
        Console.WriteLine(e.Message)
    End Try
End Sub

Nota

La longitud de value solo se valida en .NET Framework y .NET Core versiones 2.0 - 3.1.

En todas las versiones de .NET Framework aplicables: una WebHeaderCollection instancia devuelta por la Headers propiedad producirá una ArgumentOutOfRangeException excepción si la longitud de value es mayor que 65535. Todas las demás WebHeaderCollection instancias aceptan una value longitud de cualquier longitud.
En las versiones de .NET Core a través de la versión 3.1: una WebHeaderCollection instancia usada con cualquier encabezado de tipo HttpResponseHeader producirá una ArgumentOutOfRangeException excepción si la longitud de value es mayor que 65535. Todas las demás WebHeaderCollection instancias aceptan una value longitud de cualquier longitud.
En .NET 5 y versiones posteriores: WebHeaderCollection acepta una value longitud de cualquier longitud.

Comentarios

Si el encabezado especificado en el encabezado no existe, el Set método inserta un nuevo encabezado en la lista de pares nombre-valor de encabezado.

Si el encabezado especificado en header ya está presente, value reemplaza el valor existente.

Se aplica a

WebHeaderCollection.Set Método

Definición

Sobrecargas

Set(HttpRequestHeader, String)

Parámetros

Excepciones

Comentarios

Se aplica a

Set(HttpResponseHeader, String)

Parámetros

Excepciones

Comentarios

Se aplica a

Set(String, String)

Parámetros

Excepciones

Ejemplos

Comentarios

Se aplica a

Comentarios

Recursos adicionales