Windows Dev Center

Collapse the table of content
Expand the table of content
Expand Minimize
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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 (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.winmd

See also

FileIO
WriteTextAsync(IStorageFile, String, UnicodeEncoding)

 

 

Show:
© 2015 Microsoft