IBackgroundCopyJob::GetProxySettings method (bits.h)

Retrieves the proxy information that the job uses to transfer the files.

Syntax

HRESULT GetProxySettings(
  [out] BG_JOB_PROXY_USAGE *pProxyUsage,
  [out] LPWSTR             *pProxyList,
  [out] LPWSTR             *pProxyBypassList
);

Parameters

[out] pProxyUsage

Specifies the proxy settings the job uses to transfer the files. For a list of proxy options, see the BG_JOB_PROXY_USAGE enumeration.

[out] pProxyList

Null-terminated string that contains one or more proxies to use to transfer files. The list is space-delimited. For details on the format of the string, see the Listing Proxy Servers section of Enabling Internet Functionality. Call the CoTaskMemFree function to free ppProxyList when done.

[out] pProxyBypassList

Null-terminated string that contains an optional list of host names or IP addresses, or both, that were not routed through the proxy. The list is space-delimited. For details on the format of the string, see the Listing the Proxy Bypass section of Enabling Internet Functionality. Call the CoTaskMemFree function to free ppProxyBypassList when done.

Return value

This method returns the following HRESULT values, as well as others.

Return code	Description
S_OK	Proxy information was successfully retrieved.
E_INVALIDARG	One or more of the parameters is NULL.

Requirements

Requirement	Value
Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
Target Platform	Windows
Header	bits.h
Library	Bits.lib
DLL	QmgrPrxy.dll

See also

BG_JOB_PROXY_USAGE

IBackgroundCopyJob::SetProxySettings