Edit

IMFHttpDownloadSessionProvider::CreateHttpDownloadSession method (mfidl.h)

  • Article

Called by the Microsoft Media Foundation to open HTTP or HTTPS URLs instead of using the default implementation.

Syntax

HRESULT CreateHttpDownloadSession(
  [in]  LPCWSTR                wszScheme,
  [out] IMFHttpDownloadSession **ppDownloadSession
);

Parameters

[in] wszScheme

The name of the protocol to for which an IMFHttpDownloadSession is being requested. Microsoft Media Foundation specifies the protocol scheme of the URL that the application provided the Media Foundation Source Resolver. Valid values include “http” for HTTP, and “https” for HTTPS. URL scheme names are generally not case-sensitive.

[out] ppDownloadSession

On successful execution, the parameter is set to a pointer to an IMFHttpDownloadSession interface. The returned interface is used by Microsoft Media Foundation to open a single HTTP or HTTPS URL.

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 created the IMFHttpDownloadSession object.
E_INVALIDARG
 The value specified for the wszScheme parameter is incorrect.
E_POINTER
 The ppDownloadSession parameter is an invalid pointer.
E_OUTOFMEMORY
 There is insufficient memory to complete the operation.

Remarks

Specifying “https” as the value of wszScheme does not imply that HTTPS will be used for a particular request, as that is specified on a per-request basis in IMFhttpDownloadSession::CreateRequest.

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

IMFHttpDownloadSessionProvider