Skip to main content
MessageWebSocket.SetRequestHeader | setRequestHeader method

Applies to Windows and Windows Phone

Adds an HTTP request header to the HTTP request message used in the WebSocket protocol handshake by the MessageWebSocket object.

Syntax


messageWebSocket.setRequestHeader(headerName, headerValue);

public void SetRequestHeader(
  string headerName, 
  string headerValue
)

Public Sub SetRequestHeader(
  headerName As String,  
  headerValue As String 
)

public:
void SetRequestHeader(
  String^ headerName, 
  String^ headerValue
)

Parameters

headerName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The name of the request header.

headerValue

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The value of the request header.

Remarks

The SetRequestHeader method must be called prior to calling the ConnectAsync method. Calling the SetRequestHeader method after calling the ConnectAsync method will result in an error.

Using the SetRequestHeader method to add a Sec-WebSocket-Extensions header is not supported.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.Sockets
Windows::Networking::Sockets [C++]

Metadata

Windows.winmd

DLL

Windows.Networking.dll

See also

MessageWebSocket
ConnectAsync