PathIO.ReadTextAsync(String) | readTextAsync(String) method

Applies to Windows and Windows Phone

Reads the contents of the file at the specified path or URI and returns text.

Syntax

Public Shared Function ReadTextAsync(
  absolutePath As String 
) As IAsyncOperation(Of String)

Parameters

absolutePath

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

The path of the file to read.

Return value

Type: IAsyncOperation<String>

When this method completes successfully, it returns the contents of the file as a text string.

Remarks

Note  To read or write to a file using a path or URIs, you must have permission to access the file's location.

You can specify an app URIs to read or write files in app-specific locations like your app data folder ("ms-appdata://"). To learn more about app URIs, see How to reference content.

Examples

This example shows you how to use readTextAsync(absolutePath) to read text from the file at the path in absoluteFilePath like this:


Windows.Storage.PathIO.readTextAsync(absoluteFilePath).then(function (contents) {
    // Add code to process the text read from the file
});

You can use then or done to declare a function to capture and process the text that was read from the file. After the readTextAsync method completes, the text will be passed to this function as a string object (contents in the example).

Requirements

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

PathIO
ReadTextAsync(String, UnicodeEncoding)

 

 

Show:
© 2014 Microsoft