HttpResponseMessageProperty.SuppressEntityBody Property

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Http.dll

Package:

System.ServiceModel.Http v8.1.0

Source:

HttpResponseMessageProperty.cs

Gets or sets a value that indicates whether the body of the message is ignored and an empty message is sent.

public:
 property bool SuppressEntityBody { bool get(); void set(bool value); };

public bool SuppressEntityBody { get; set; }

member this.SuppressEntityBody : bool with get, set

Public Property SuppressEntityBody As Boolean

Property Value

Boolean

true if the message body is suppressed; otherwise, false. The default is false.

Examples

This shows how to suppress the message body:

// A value of true suppresses the message body.
responseProperty.SuppressEntityBody =  true;

Remarks

This property is used for empty message responses, for example, a service that accepts a POST request and returns a response that contains no message body with StatusCode = 200 and StatusDescription = OK. The HttpResponseMessageProperty associated with this response has this property set to true.