Edit

IMFHttpDownloadRequest::GetAtEndOfPayload method (mfidl.h)

  • Article

Invoked by Microsoft Media Foundation to check if it should invoke BeginReadPayload to read data from the message body of the response. During the processing of a typical HTTP response, Media Foundation will invoke BeginReadPayload multiple times, but once GetAtEndOfPayload sets its output parameter to TRUE, Media Foundation will not invoke BeginReadPayload again.

Syntax

HRESULT GetAtEndOfPayload(
  [out] BOOL *pfAtEndOfPayload
);

Parameters

[out] pfAtEndOfPayload

Set to FALSE if a call to BeginReadPayload can return one or more bytes of data to Media Foundation. Set to TRUE when there is no more data to return.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 Successfully completed the operation.
E_POINTER
 The pfAtEndOfPayload parameter is an invalid pointer.

Remarks

Microsoft Media Foundation invokes GetAtEndOfPayload only after having successfully invoked EndReceiveResponse.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1703 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header mfidl.h
Library Mfplat.lib; Mfplat.dll

See also

IMFHttpDownloadRequest