StorageFileHelper.WriteTextToKnownFolderFileAsync Method

Reference

Definition

Namespace:: Microsoft.Toolkit.Uwp.Helpers

Assembly:: Microsoft.Toolkit.Uwp.dll

Package:: Microsoft.Toolkit.Uwp v6.1.1

Package:: Microsoft.Toolkit.Uwp v7.0.2

Package:: Microsoft.Toolkit.Uwp v7.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Saves a string value to a Windows.Storage.StorageFile in well known folder/>.

public static System.Threading.Tasks.Task<Windows.Storage.StorageFile> WriteTextToKnownFolderFileAsync (Windows.Storage.KnownFolderId knownFolderId, string text, string fileName, Windows.Storage.CreationCollisionOption options = Windows.Storage.CreationCollisionOption.ReplaceExisting);

static member WriteTextToKnownFolderFileAsync : Windows.Storage.KnownFolderId * string * string * Windows.Storage.CreationCollisionOption -> System.Threading.Tasks.Task<Windows.Storage.StorageFile>

Public Function WriteTextToKnownFolderFileAsync (knownFolderId As KnownFolderId, text As String, fileName As String, Optional options As CreationCollisionOption = Windows.Storage.CreationCollisionOption.ReplaceExisting) As Task(Of StorageFile)

Parameters

knownFolderId: Windows.Storage.KnownFolderId

The well known folder ID to use.

text: String

The String value to save to the file.

fileName: String

The String name for the file.

options: Windows.Storage.CreationCollisionOption

The creation collision options. Default is ReplaceExisting.

Returns

Task<Windows.Storage.StorageFile>

The saved Windows.Storage.StorageFile containing the text.

Exceptions

ArgumentNullException

Exception thrown if the file location or file name are null or empty.

Applies to

Share via