VFile.WriteAllLinesAsync Method

Namespace: Rebex.IO

Assembly: Rebex.FileSystem.dll (version 7.0.9119)

WriteAllLinesAsync(String, IEnumerable<String>, CancellationToken)

Method writes the contents to a file identified by the path.

Declaration

public static Task WriteAllLinesAsync(string path, IEnumerable<string> contents, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
String	path	The path of the file.
IEnumerable<String>	contents	Lines to write to the path.
CancellationToken	cancellationToken	The cancellation token. See remarks for details.

Returns

Type	Description
Task	A Task that represents the operation. See remarks for details.

Remarks

• Method creates the file if it does not exist, opens the file, writes the content and closes the file.
• Rebex virtual file systems are synchronous. This method is provided only for compatibility with the File API on modern platforms. Despite the async suffix this method runs synchronously and returns completed Task. The cancellationToken is not used. If the need to offload the operation to the background thread arise, consider using the .NET Task.Run (or TaskFactory.StartNew on older platforms) API with the synchronous Rebex.IO.FileSystem.IO.VFile.WriteAllLines(System.String,System.Collections.Generic.IEnumerable{System.String}) method.

WriteAllLinesAsync(String, IEnumerable<String>, Encoding, CancellationToken)

Method writes the contents to a file identified by the path and using the encoding.

Declaration

public static Task WriteAllLinesAsync(string path, IEnumerable<string> contents, Encoding encoding, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
String	path	The path of the file.
IEnumerable<String>	contents	Lines to write to the path.
Encoding	encoding	The character encoding.
CancellationToken	cancellationToken	The cancellation token. See remarks for details.

Returns

Type	Description
Task	A Task that represents the operation. See remarks for details.

Remarks

• Method creates the file if it does not exist, opens the file, writes the content and closes the file.
• Rebex virtual file systems are synchronous. This method is provided only for compatibility with the File API on modern platforms. Despite the async suffix this method runs synchronously and returns completed Task. The cancellationToken is not used. If the need to offload the operation to the background thread arise, consider using the .NET Task.Run (or TaskFactory.StartNew on older platforms) API with the synchronous Rebex.IO.FileSystem.IO.VFile.WriteAllLines(System.String,System.Collections.Generic.IEnumerable{System.String},System.Text.Encoding) method.