HttpStreamContent.TryComputeLength(UInt64) Method

Definition

Namespace:

Windows.Web.Http

Determines whether the HttpStreamContent has a valid length in bytes.

public:
 virtual bool TryComputeLength([Out] unsigned long long & length) = TryComputeLength;

bool TryComputeLength([Out] uint64_t & length);

public bool TryComputeLength(out ulong length);

Public Function TryComputeLength (ByRef length As ULong) As Boolean

Parameters

length

UInt64

unsigned long long

uint64_t

The length in bytes of the HttpStreamContent.

Returns

Boolean

bool

true if length is a valid length; otherwise, false.

Implements

M:Windows.Web.Http.IHttpContent.TryComputeLength(System.UInt64@) M:Windows.Web.Http.IHttpContent.TryComputeLength(unsigned long long@) M:Windows.Web.Http.IHttpContent.TryComputeLength(uint64_t@)

Remarks

The TryComputeLength method calculates the content length for HTTP content in HttpStreamContent. Headers set on the content are not included in the content length. This is useful for content types that are easy to calculate the content length.

If computing the content length is not possible or expensive (would require the system to buffer the whole content where the serialization would be expensive or require the system to allocate a lot of memory), this method can return false. If this method returns false, this implies that either chunked transfer is needed or the content must get buffered before being sent to the server.