IDShowPlugin::get_UserAgent method (qnetwork.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The get_UserAgent method retrieves the User-Agent field from the HTTP header.

Syntax

HRESULT get_UserAgent(
  BSTR *pUserAgent
);

Parameters

pUserAgent

Pointer to a variable that receives the User-Agent string.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

The caller must release the returned BSTR, by calling SysFreeString.

Requirements

See also

IDShowPlugin Interface