FileIO.WriteTextAsync(IStorageFile, String) | writeTextAsync(IStorageFile, String) method

Writes text to the specified file.

Syntax

Windows.Storage.FileIO.writeTextAsync(file, contents).done( /* Your success and error handlers */ );

Parameters

file

Type: IStorageFile

The file that the text is written to.

contents

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The text to write.

Return value

Type: IAsyncAction

No object or value is returned when this method completes.

Examples

The File Access sample shows you how to use writeTextAsync(file, contents) to write text to a file.

if (file !== null) {
    Windows.Storage.FileIO.writeTextAsync(file, "Swift as a shadow").done(function () {
        // Perform additional tasks after file is written
    },
    // Handle errors with an error function
    function (error) {
        // Handle errors encountered during write
    });
}

In the example, file is a local variable that contains a storageFile that represents the file to write.

Although the writeTextAsync methods don't have a return value, you can still perform additional tasks after the text is written to the file, as the example shows.

Requirements

See also

FileIO

WriteTextAsync(IStorageFile, String, UnicodeEncoding)

Build date: 2/25/2013