IAssetFile.DownloadAsync Method
Asynchronously downloads the represented file to the specified destination path.
Namespace: Microsoft.WindowsAzure.MediaServices.Client
Assembly: Microsoft.WindowsAzure.MediaServices.Client (in Microsoft.WindowsAzure.MediaServices.Client.dll)
Syntax
'Declaration
Function DownloadAsync ( _
destinationPath As String, _
blobTransferClient As BlobTransferClient, _
locator As ILocator, _
cancellationToken As CancellationToken _
) As Task
'Usage
Dim instance As IAssetFile
Dim destinationPath As String
Dim blobTransferClient As BlobTransferClient
Dim locator As ILocator
Dim cancellationToken As CancellationToken
Dim returnValue As Task
returnValue = instance.DownloadAsync(destinationPath, _
blobTransferClient, locator, cancellationToken)
Task DownloadAsync(
string destinationPath,
BlobTransferClient blobTransferClient,
ILocator locator,
CancellationToken cancellationToken
)
Task^ DownloadAsync(
String^ destinationPath,
BlobTransferClient^ blobTransferClient,
ILocator^ locator,
CancellationToken cancellationToken
)
abstract DownloadAsync :
destinationPath:string *
blobTransferClient:BlobTransferClient *
locator:ILocator *
cancellationToken:CancellationToken -> Task
function DownloadAsync(
destinationPath : String,
blobTransferClient : BlobTransferClient,
locator : ILocator,
cancellationToken : CancellationToken
) : Task
Parameters
- destinationPath
Type: System.String
The path to download the file to.
- blobTransferClient
Type: Microsoft.WindowsAzure.MediaServices.Client.BlobTransferClient
The BlobTransferClient which is used to download files.
- locator
Type: Microsoft.WindowsAzure.MediaServices.Client.ILocator
An asset ILocator which defines permissions associated with the Asset.
- cancellationToken
Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type: System.Threading.Tasks.Task
A function delegate that returns the future result to be available through the Task.