Edit

IMFHttpDownloadRequest::GetURL method (mfidl.h)

  • Article

Returns the URL that is used for sending the request.

Syntax

HRESULT GetURL(
  [out] LPWSTR *ppszURL
);

Parameters

[out] ppszURL

The URL that is used for sending the request to the server. Note that this URL may be different if the server has issued a HTTP protocol “redirect”. The memory for pszURL must be allocated with CoTaskMemAlloc, and will be freed by Media Foundation with CoTaskMemFree.

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 returned the URL.
E_OUTOFMEMORY
 There is insufficient memory to complete the operation.
E_POINTER
 The ppszURL parameter is an invalid pointer.

Remarks

By default, GetURL returns an URL which is synthesized from the parameters provided by Media Foundation in the IMFHttpDownloadSession::SetServer and IMFHttpDownloadSession::CreateRequest methods. However, if the HTTP server has redirected the IMFHttpDownloadRequest to a different server (i.e., through a “302 See Other” HTTP response) then the GetURL method returns the URL that the HTTP server specified.

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