Windows Dev Center

StreamWebSocket.SetRequestHeader | setRequestHeader method

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

Syntax


streamWebSocket.setRequestHeader(headerName, 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 (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

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

See also

ConnectAsync
StreamWebSocket

 

 

Show:
© 2015 Microsoft