readme.md
March 31, 2026 ยท View on GitHub
Assembly report for Vanara.BITS.dll
Complete .NET coverage of Windows BITS (Background Intelligent Transfer Service) functionality. Provides access to all library functions through Windows 11 and gracefully fails when new features are not available on older OS versions.
Dependencies
- Vanara.PInvoke.BITS
Enumerations
| Enum | Description | Values |
|---|---|---|
| Vanara.IO.BackgroundCopyACLFlags | Flags for ACL information to maintain when using SMB to download or upload a file. | None, Owner, Group, Dacl, Sacl, All |
| Vanara.IO.BackgroundCopyCost | Defines the constant values that specify the BITS cost state. | Unrestricted, CappedUsageUnknown, BelowCap, NearCap, OvercapCharged, OvercapThrottled, UsageBased, Roaming, Reserved, IgnoreCongestion, TransferUnrestricted, TransferStandard, TransferNoSurcharge, TransferNotRoaming, TransferAlways |
| Vanara.IO.BackgroundCopyErrorContext | Defines the constant values that specify the context in which the error occurred. | None, Unknown, GeneralQueueManager, QueueManagerNotification, LocalFile, RemoteFile, GeneralTransport, RemoteApplication |
| Vanara.IO.BackgroundCopyJobCredentialScheme | Defines the constant values that specify the authentication scheme to use when a proxy or server requests user authentication. | Basic, Digest, NTLM, Negotiate, Passport |
| Vanara.IO.BackgroundCopyJobCredentialTarget | Defines the constant values that specify whether the credentials are used for proxy or server user authentication requests. | Undefined, Server, Proxy |
| Vanara.IO.BackgroundCopyJobEnablePeerCaching | Flags that determine if the files of the job can be cached and served to peers and if BITS can download content for the job from peers. | EnableClient, EnableServer, DisableBranchCache |
| Vanara.IO.BackgroundCopyJobNotify | Identifies the events that your application receives. | Transferred, Error |
| Vanara.IO.BackgroundCopyJobPriority | Defines the constant values that specify the priority level of a job. | Foreground, High, Normal, Low |
| Vanara.IO.BackgroundCopyJobSecurity | HTTP security flags that indicate which errors to ignore when connecting to the server. | AllowSilentRedirect, CheckCRL, IgnoreInvalidCerts, IgnoreExpiredCerts, IgnoreUnknownCA, IgnoreWrongCertUsage, AllowReportedRedirect, DisallowRedirect, AllowHttpsToHttpRedirect |
| Vanara.IO.BackgroundCopyJobState | Defines constant values for the different states of a job. | Queued, Connecting, Transferring, Suspended, Error, TransientError, Transferred, Acknowledged, Cancelled |
| Vanara.IO.BackgroundCopyJobType | Defines constant values that specify the type of transfer job, such as download. | Download, Upload, UploadReply |
| Vanara.IO.PeerCaching | Flags that determine if the computer serves content to peers and can download content from peers. | EnableClient, EnableServer |
Structures
| Struct | Description |
|---|---|
| Vanara.IO.BackgroundCopyFileRange | Identifies a range of bytes to download from a file. |
| Vanara.IO.BackgroundCopyJobProgress | Provides job-related progress information, such as the number of bytes and files transferred. For upload jobs, the progress applies to the upload file, not the reply file. |
| Vanara.IO.BackgroundCopyJobReplyProgress | Provides progress information related to the reply portion of an upload-reply job. |
Classes
| Class | Description |
|---|---|
| Vanara.IO.BackgroundCopyException | Exceptions specific to BITS |
| Vanara.IO.BackgroundCopyFileCollection | Manages the set of files for a background copy job. |
| Vanara.IO.BackgroundCopyFileInfo | Information about a file in a background copy job. |
| Vanara.IO.BackgroundCopyFileRange | Identifies a range of bytes to download from a file. |
| Vanara.IO.BackgroundCopyFileRangesTransferredEventArgs | Used by Vanara.IO.BackgroundCopyJob.FileRangesTransferred events. |
| Vanara.IO.BackgroundCopyFileTransferredEventArgs | Used by Vanara.IO.BackgroundCopyJob.FileTransferred events. |
| Vanara.IO.BackgroundCopyJob | A job in the Background Copy Service (BITS) |
| Vanara.IO.BackgroundCopyJobCollection | Manages the set of jobs for the background copy service (BITS). |
| Vanara.IO.BackgroundCopyJobCredential | Represents a single BITS job credential. |
| Vanara.IO.BackgroundCopyJobCredentials | The list of credentials for a job. |
| Vanara.IO.BackgroundCopyJobEventArgs | Event argument for background copy job. |
| Vanara.IO.BackgroundCopyManager | Use the BackgroundCopyManager to create transfer jobs, retrieve an enumerator object that contains the jobs in the queue, and to retrieve individual jobs from the queue. |
| Vanara.IO.CachePeer | Provides information about a peer in the neighborhood. |
| Vanara.IO.CachePeers | Provides the ability to enumerate the list of peers that BITS has discovered. |
| Vanara.IO.PeerCacheAdministration | Use |
| Vanara.IO.PeerCacheRecord | Provides information about a file in the BITS peer cache. |
| Vanara.IO.PeerCacheRecords | Provides the ability to enumerate the records of the cache. |