Skip to content

Latest commit

 

History

History
134 lines (107 loc) · 5.4 KB

nf-mfidl-imfhttpdownloadsession-createrequest.md

File metadata and controls

134 lines (107 loc) · 5.4 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mfidl.IMFHttpDownloadSession.CreateRequest
IMFHttpDownloadSession::CreateRequest (mfidl.h)
Invoked by Microsoft Media Foundation to create an object that implements the IMFHttpDownloadRequest interface, which is used to send a single HTTP, or HTTPS request.
CreateRequest
CreateRequest method [Media Foundation]
CreateRequest method [Media Foundation]
IMFHttpDownloadSession interface
IMFHttpDownloadSession interface [Media Foundation]
CreateRequest method
IMFHttpDownloadSession.CreateRequest
IMFHttpDownloadSession::CreateRequest
mf.imfhttpdownloadsession_createrequest
mfidl/IMFHttpDownloadSession::CreateRequest
mf\imfhttpdownloadsession_createrequest.htm
mf
111A075A-82A7-4607-9359-37B2DA97AFC5
12/05/2018
CreateRequest, CreateRequest method [Media Foundation], CreateRequest method [Media Foundation],IMFHttpDownloadSession interface, IMFHttpDownloadSession interface [Media Foundation],CreateRequest method, IMFHttpDownloadSession.CreateRequest, IMFHttpDownloadSession::CreateRequest, mf.imfhttpdownloadsession_createrequest, mfidl/IMFHttpDownloadSession::CreateRequest
mfidl.h
Windows
Windows 10, version 1703 [desktop apps only]
None supported
Mfplat.lib; Mfplat.dll
Windows
19H1
IMFHttpDownloadSession::CreateRequest
mfidl/IMFHttpDownloadSession::CreateRequest
c++
APIRef
kbSyntax
COM
mfplat.lib
mfplat.dll
mfplat.dll
mfplat.dll.dll
IMFHttpDownloadSession.CreateRequest

IMFHttpDownloadSession::CreateRequest

-description

Invoked by Microsoft Media Foundation to create an object that implements the IMFHttpDownloadRequest interface, which is used to send a single HTTP, or HTTPS request. Since multiple requests may be needed to fully download a resource, Media Foundation may invoke CreateRequest multiple times on the same IMFHttpDownloadSession instance. Media Foundation will use each IMFHttpDownloadRequest instance for only a single request.

-parameters

-param szObjectName [in]

Pointer to a string that contains the name of the target resource of the specified HTTP verb. This is generally a file name, an executable module, or a search specifier. The target resource always begins with a forward slash character and includes any query string that was included on the URL.

-param fBypassProxyCache [in]

If set to TRUE, indicates that the request should be forwarded to the originating server rather than sending a cached version of a resource from a proxy server. When this flag is set to TRUE, a "Pragma: no-cache" header should be added to the request. When creating an HTTP/1.1 request, a "Cache-Control: no-cache" should also be added.

-param fSecure [in]

If set to TRUE, causes the secure variant of the protocol to be used, if applicable. For example, if the IMFHttpDownloadSession is for HTTP/HTTPS, setting fSecure to TRUE will cause the request to use HTTPS. Otherwise, the unsecure variant of the protocol (in this example, HTTP) is used.

-param szVerb [in, optional]

Pointer to a string that contains the HTTP verb to use in the request. If this parameter is NULL, the function uses GET as the HTTP verb.

Note  This string should be all uppercase. Many servers treat HTTP verbs as case-sensitive, and the Internet Engineering Task Force (IETF) Requests for Comments (RFCs) spell these verbs using uppercase characters only.
 

-param szReferrer [in, optional]

Pointer to a string that specifies the URL of the document from which the URL in the request szObjectName was obtained. If this parameter is set to NULL, no referring document is specified.

-param ppRequest

Upon successful return of the method, this parameter is set to an IMFHttpDownloadRequest interface.

-returns

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

Return code Description
S_OK
Successfully stored the supplied information.
E_OUTOFMEMORY
There is insufficient memory to complete the operation.
MF_E_INVALIDREQUEST
The method was invoked after Close or before SetServer was invoked.

-see-also

IMFHttpDownloadSession