Export (0) Print
Expand All

BitsClientJob class

The BitsClientJob class provides methods to manage Background Intelligent Transfer Service (BITS) transfer jobs.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetical order, not MOF order.

Syntax

[Provider("BitsClientProv"), Dynamic]class BitsClientJob
{
  string         JobId;
  string         DisplayName;
  string         Description;
  uint32         Priority;
  uint32         MinimumRetryDelay;
  uint32         NoProgressTimeout;
  BitsClientFile Files[];
  uint64         JobCreationTime;
  uint64         JobLastModificationTime;
  uint64         JobCompletionTime;
  uint64         BytesTotal;
  uint64         BytesTransferred;
  uint32         FilesTotal;
  uint32         FilesTransferred;
  uint32         TransientErrorCount;
  uint16         State;
  string         Owner;
};

Members

The BitsClientJob class has these types of members:

Methods

The BitsClientJob class has these methods.

MethodDescription
AddFile

Adds a file to an existing BITS transfer job.

CreateJob

Creates a BITS transfer job.

GetError

Gets the error codes and error context for a BITS transfer job error.

RemoveClientCertificate

Removes the client certificate from the job.

RemoveCredentials

Removes the credentials from the useTarget parameter.

SetClientCertificateById

Sets the client certificate to use for client authentication in an HTTPS (SSL) request.

SetClientCertificateByName

Sets the client certificate to use for client authentication in an HTTPS (SSL) request.

SetCredentials

Identifies the Target parameter, the authentication scheme, and the user credentials to use for user authentication requests.

SetJobState

Changes the state of a BITS transfer job.

SetProxySettings

Modifies the proxy settings for a BITS transfer job.

 

Properties

The BitsClientJob class has these properties.

BytesTotal
Data type: uint64
Access type: Read-only

This property specifies the total number of bytes to transfer for all the files in the BITS transfer job.

BytesTransferred
Data type: uint64
Access type: Read-only

This property specifies the number of bytes that were transferred.

Description
Data type: string
Access type: Read/write

This property specifies the description of the BITS transfer job.

DisplayName
Data type: string
Access type: Read/write

This property specifies the name of the BITS transfer job.

Files
Data type: BitsClientFile array
Access type: Read-only

This property gets the list of files that were added to the BITS transfer job.

FilesTotal
Data type: uint32
Access type: Read-only

This property specifies the total number of files to transfer for this BITS transfer job.

FilesTransferred
Data type: uint32
Access type: Read-only

This property specifies the number of files transferred.

JobCompletionTime
Data type: uint64
Access type: Read-only

This property specifies the time when the BITS transfer job entered the completed state. The HighDateTime parameter is in most significant bits (MSB), and the LowDateTime parameter is in least significant bits (LSB).

JobCreationTime
Data type: uint64
Access type: Read-only

This property specifies the creation time of the BITS transfer job. The HighDateTime parameter is in MSB, and the LowDateTime parameter is in LSB.

JobId
Data type: string
Access type: Read-only

This property specifies the GUID that is associated with the BITS transfer job.

JobLastModificationTime
Data type: uint64
Access type: Read-only

This property specifies the last modification time of the BITS transfer job. The HighDateTime parameter is in MSB, and the LowDateTime parameter is in LSB.

MinimumRetryDelay
Data type: uint32
Access type: Read/write

This property specifies the minimum time that BITS waits before it tries to transfer the file after a transient error condition occurs.

NoProgressTimeout
Data type: uint32
Access type: Read/write

This property specifies the length of time that the service tries to transfer the file after a transient error condition occurs. If there is progress, the timer is reset.

Owner
Data type: string
Access type: Read-only

This property specifies the owner of the BITS transfer job.

Priority
Data type: uint32
Access type: Read/write

This property specifies the priority of the BITS transfer job.

State
Data type: uint16
Access type: Read-only

This property specifies the state of the BITS transfer job.

TransientErrorCount
Data type: uint32
Access type: Read-only

This property specifies the number of times that a transit error occurred for the BITS transfer job.

Remarks

If a BITS transfer job exists that was created by a user who no longer exists on the computer, job enumerations fail with WBEM_E_FAILED error code.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Redistributable

Windows Management Framework on Windows Server 2008 with SP2

Namespace

\root\microsoft\bits

MOF

BitsProvider.mof

 

 

Community Additions

ADD
Show:
© 2014 Microsoft