IBackgroundCopyJob2::RemoveCredentials method

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(
  [in] BG_AUTH_TARGET Target,
  [in] BG_AUTH_SCHEME Scheme
);

Parameters

  • Target [in]
    Identifies whether to use the credentials for proxy or server authentication.

  • Scheme [in]
    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 10, version 1709 [desktop apps only]

Minimum supported server

Windows Server 2016 [desktop apps only]

Header

Deliveryoptimization.h

IDL

DeliveryOptimization.idl

Library

Dosvc.lib

DLL

Dosvc.dll

IID

IID_IBackgroundCopyJob2 is defined as 54B50739-686F-45EB-9DFF-D6A9A0FAA9AF

See also

IBackgroundCopyJob2

BG_AUTH_SCHEME

BG_AUTH_TARGET

IBackgroundCopyJob2::SetCredentials