C# Class SharpBits.Base.BitsManager

Use the IBackgroundCopyManager interface to create transfer jobs, retrieve an enumerator object that contains the jobs in the queue, and to retrieve individual jobs from the queue.

Inheritance: IDisposable

Show file Open project: robertbaker/SevenUpdate Class Usage Examples

Private Properties

Property	Type	Description
Dispose	void
GetErrorDescription	string
NotificationHandlerOnJobErrorEvent	void
NotificationHandlerOnJobModifiedEvent	void
NotificationHandlerOnJobTransferredEvent	void
NotifyOnJobRemoval	void
PublishException	void

Public Methods

Method	Description
BitsManager ( ) : System	Initializes a new instance of the BitsManager class.
CreateJob ( string displayName, JobType jobType ) : BitsJob	Creates a new transfer job.
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
EnumJobs ( JobOwner jobOwner = JobOwner.CurrentUser ) : void	Enumerates the collection of `BitsJob`, it also completes any job that has finished.

Private Methods

Method	Description
Dispose ( bool disposing ) : void	Releases unmanaged and - optionally - managed resources.
GetErrorDescription ( int result ) : string	Gets the error description.
NotificationHandlerOnJobErrorEvent ( object sender, ErrorNotificationEventArgs e ) : void	Notifications the handler on job error event.
NotificationHandlerOnJobModifiedEvent ( object sender, NotificationEventArgs e ) : void	Notifications the handler on job modified event.
NotificationHandlerOnJobTransferredEvent ( object sender, NotificationEventArgs e ) : void	Notifications the handler on job transferred event.
NotifyOnJobRemoval ( BitsJob job ) : void	Notifies the on job removal.
PublishException ( BitsJob job, COMException exception ) : void	Publishes the exception.

Method Details

BitsManager() public method

Initializes a new instance of the BitsManager class.

public BitsManager ( ) : System
return	System

CreateJob() public method

Creates a new transfer job.

public CreateJob ( string displayName, JobType jobType ) : BitsJob
displayName	string	Null-terminated string that contains a display name for the job. Typically, the display name is used to identify the job in a user interface. Note that more than one job may have the same display name. Must not be null.The name is limited to 256 characters, not including the null terminator.
jobType	JobType	Type of transfer job, such as JobType.Download. For a list of transfer types, /// see the enumeration.
return	BitsJob

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public Dispose ( ) : void
return	void

EnumJobs() public method

Enumerates the collection of BitsJob, it also completes any job that has finished.

public EnumJobs ( JobOwner jobOwner = JobOwner.CurrentUser ) : void
jobOwner	JobOwner	The job owner.
return	void