Export (0) Print
Expand All

IBackgroundCopyJob::GetProxySettings method

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

Syntax


HRESULT GetProxySettings(
  [out]  BG_JOB_PROXY_USAGE *pProxyUsage,
  [out]  LPWSTR *ppProxyList,
  [out]  LPWSTR *ppProxyBypassList
);

Parameters

pProxyUsage [out]

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

ppProxyList [out]

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.

ppProxyBypassList [out]

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 codeDescription
S_OK

Proxy information was successfully retrieved.

E_INVALIDARG

One or more of the parameters is NULL.

 

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Bits.h

IDL

Bits.idl

Library

Bits.lib

DLL

QmgrPrxy.dll

IID

IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

BG_JOB_PROXY_USAGE
IBackgroundCopyJob::SetProxySettings

 

 

Community Additions

ADD
Show:
© 2014 Microsoft