| BuildProcessReadWithEncoding Method |
This is used to read in a file using an appropriate encoding method
Namespace: SandcastleBuilder.Utils.BuildEngineAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
Syntax public static string ReadWithEncoding(
string filename,
ref Encoding encoding
)
Public Shared Function ReadWithEncoding (
filename As String,
ByRef encoding As Encoding
) As String
public:
static String^ ReadWithEncoding(
String^ filename,
Encoding^% encoding
)
static member ReadWithEncoding :
filename : string *
encoding : Encoding byref -> string
Parameters
- filename
- Type: SystemString
The file to load - encoding
- Type: System.TextEncoding
Pass the default encoding to use. On
return, it contains the actual encoding for the file.
Return Value
Type:
StringThe contents of the file.
Remarks When reading the file, use the default encoding specified
but detect the encoding if byte order marks are present. In
addition, if the template is an XML file and it contains an
encoding identifier in the XML tag, the file is read using
that encoding.
See Also