StorageFile.ReplaceWithStreamedFileFromUriAsync Method

Definition

Namespace:

Windows.Storage

Replaces the contents of the file referred to by the specified IStorageFile object with a new data stream of the specified Uniform Resource Identifier (URI). This method lets the app download the data on-demand when the StorageFile that represents the stream is first accessed.

The data stream is accessed through the StorageFile that is returned and the data is downloaded on-demand when the StorageFile is first accessed.

Replaces the IStorageFile object that represents the specified file with a new StorageFile that provides a stream of the specified Uniform Resource Identifier (URI).

public:
 static IAsyncOperation<StorageFile ^> ^ ReplaceWithStreamedFileFromUriAsync(IStorageFile ^ fileToReplace, Uri ^ uri, IRandomAccessStreamReference ^ thumbnail);

/// [Windows.Foundation.Metadata.RemoteAsync]
 static IAsyncOperation<StorageFile> ReplaceWithStreamedFileFromUriAsync(IStorageFile const& fileToReplace, Uri const& uri, IRandomAccessStreamReference const& thumbnail);

[Windows.Foundation.Metadata.RemoteAsync]
public static IAsyncOperation<StorageFile> ReplaceWithStreamedFileFromUriAsync(IStorageFile fileToReplace, System.Uri uri, IRandomAccessStreamReference thumbnail);

function replaceWithStreamedFileFromUriAsync(fileToReplace, uri, thumbnail)

Public Shared Function ReplaceWithStreamedFileFromUriAsync (fileToReplace As IStorageFile, uri As Uri, thumbnail As IRandomAccessStreamReference) As IAsyncOperation(Of StorageFile)

Parameters

fileToReplace

IStorageFile

The file that the created StorageFile will provide a stream of.

uri

Uri Uri

The Uniform Resource Identifier (URI) of the resource used to create the StorageFile.

thumbnail

IRandomAccessStreamReference

The thumbnail image for the StorageFile to create.

For a high-quality thumbnail, one edge of this thumbnail should be at least 1024 pixels.

Returns

IAsyncOperation<StorageFile>

When this method completes, it returns a StorageFile object that represents the streamed file. Subsequently, this StorageFile object should be used to access file content instead of the file (type IStorageFile) that was specified to be replace.

Attributes

RemoteAsyncAttribute