JCL Help:FileToString@TFileName

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Reads the contents of a file into a string.


Pascal

 function FileToString(const FileName: string): RawByteString;
function FileToString(const FileName: TFileName): AnsiString;


Parameters

Parameters Description
const FileName: string Full qualified name of the file whose contents to read.


Return Value

The contents of the file as a string buffer. Note that if the file contains null terminating characters, the string will contain the entire contents but for example displaying the string will only show the part of the string up to the first null terminator.


Description

The FileToString routine reads the contents of the specified file into a string and returns it as the function result. Note that the function doesn't care about the contents of the file, it simply treats the string as a buffer and copies the entire file contents into it.


See Also

StringToFile


About

Unit

JclAnsiStrings


Donator

Anthony Steele


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page