IBackgroundCopyJob2::RemoveCredentials method (bits1_5.h)

Removes credentials from use. The credentials must match an existing target and scheme pair that you specified using the IBackgroundCopyJob2::SetCredentials method. There is no method to retrieve the credentials you have set.

Syntax

HRESULT RemoveCredentials(
  BG_AUTH_TARGET Target,
  BG_AUTH_SCHEME Scheme
);

Parameters

Target

Identifies whether to use the credentials for proxy or server authentication.

Scheme

Identifies the authentication scheme to use (basic or one of several challenge-response schemes). For details, see the BG_AUTH_SCHEME enumeration.

Return value

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

Return code Description
S_OK
Success
S_FALSE
No credentials have been set using the given Target and Scheme pair.

Requirements

   
Minimum supported client Windows Vista
Minimum supported server Windows Server 2003
Target Platform Windows
Header bits1_5.h (include Bits.h)
Library Bits.lib
DLL BitsPrx2.dll
Redistributable BITS 1.5 on Windows XP

See also

BG_AUTH_SCHEME

BG_AUTH_TARGET

IBackgroundCopyJob2::SetCredentials