UtilityReadWithEncoding Method

This is used to read in a file using an appropriate encoding method

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
public static string ReadWithEncoding(
	string filename,
	ref Encoding encoding
)

Parameters

filename  String
The file to load
encoding  Encoding
Pass the default encoding to use. On return, it contains the actual encoding for the file.

Return Value

String
The contents of the file

Remarks

When reading the file, it uses the default encoding specified but detects 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