ReadAllText(IFileInfo,Encoding) Method

Returns the contents of a text file in an abstract file provider as a System.String.

Syntax

[Extension()]
[NotNull()]
public static string ReadAllText( 
   IFileInfo fileInfo,
   Encoding encoding
)

[Extension()]
[NotNull()]
public:
static String^ ReadAllText( 
   IFileInfo^ fileInfo,
   Encoding^ encoding
)

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ReadAllText( _
   ByVal fileInfo As IFileInfo, _
   ByVal encoding As Encoding _
) As String

'Usage
 
Dim fileInfo As IFileInfo
Dim encoding As Encoding
Dim value As String
 
value = IFileInfoExtension.ReadAllText(fileInfo, encoding)

Parameters

fileInfo: A file info that represents a file in the file provider.
encoding: The character encoding to use.

Return Value

System.String containing the contents of the file.

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.FileNotFoundException	An attempt to access a file that does not exist on disk has failed. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This method is similar to FileSystem.ReadAllText Method for normal (operating system) files.

Note: This method allows you to read from a text file. The contents of the file are returned as a string.

The file encoding can be specified if the contents of the file are in an encoding such as ASCII or UTF-8. If you are reading from a file with extended characters, you need to specify the file encoding using the appropriate overload of this method.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IFileInfoExtension Class
IFileInfoExtension Members
Overload List

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.