SetCredentials method of the BitsClientJob class

The SetCredentials method identifies the Target parameter, the authentication scheme, and the user credentials to use for user authentication requests.

Syntax

uint32 SetCredentials(
  [in] Uint16 Target,
  [in] Uint16 Scheme,
  [in] string UserName,
  [in] string Password
);

Parameters

Target [in]

Specifies whether the destination is either a server or a proxy. The Target parameter can be set to the following values:

Value	Meaning
0	Server
1	Proxy

Scheme [in]

Specifies the authentication scheme to use. The Scheme parameter can be set to one of the following values:

Scheme	Meaning
0	Basic is a scheme in which the username and password are sent in clear text to the server or proxy.
1	Digest is a challenge-response scheme that uses a server-specified data string for the challenge.
2	NTLM is a challenge-response scheme that uses the credentials of the user for authentication in a Windows-based network environment.
3	Negotiate is a challenge-response scheme that negotiates with the server or proxy to determine the scheme to use for authentication. For example, this value allows negotiation to determine whether the Kerberos protocol or NTLM is used.
4	Passport is a centralized authentication service provided by Microsoft that offers a single logon for member sites.

UserName [in]

A null-terminated string that contains the user name to authenticate.

Password [in]

A null-terminated string that contains the password in clear text. The password parameter can be empty. This parameter should be set to NULL if the UserName parameter is NULL.

Requirements

See also

BitsClientJob