IWMReaderNetworkConfig::GetProxyHostName method (wmsdkidl.h)

Article
4/26/2023

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The GetProxyHostName method retrieves the name of the host to use as the proxy.

Syntax

HRESULT GetProxyHostName(
  [in]      LPCWSTR pwszProtocol,
  [out]     WCHAR   *pwszHostName,
  [in, out] DWORD   *pcchHostName
);

Parameters

[in] pwszProtocol

Pointer to a string that contains a protocol name, such as "http" or "mms". The string is not case-sensitive.

[out] pwszHostName

Pointer to a buffer that receives the name of the proxy server host. The returned value applies only to the protocol specified in pwszProtocol; the reader object supports separate settings for each protocol.

[in, out] pcchHostName

On input, pointer to a variable specifying the size of pwszHostName, in characters. On output, the variable contains the length of the string, including the terminating null character.

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	The method succeeded.
ASF_E_BUFFERTOOSMALL	The size of the buffer passed in is not large enough to hold the return string.
E_INVALIDARG	NULL or invalid argument passed in.

Remarks

Call this method twice. The first time, pass NULL as the value for pwszHostName. The method returns the size of the string in the pcchHostName parameter. Allocate the required amount of memory for the string and call the method again. This time, pass a pointer to the allocated buffer in the pwszHostName parameter.

The host name is ignored if the proxy setting is WMT_PROXY_SETTING_AUTO or WMT_PROXY_SETTING_BROWSER.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	wmsdkidl.h (include Wmsdk.h)
Library	Wmvcore.lib; WMStubDRM.lib (if you use DRM)

Share via