Editing version 2 of page APIs_FileToString (this is the most recent revision)
Note: This page is defined as a special page, and as such its final state may be different from what you see here.
Use template:
None
API_Template
DevTrack_Template
Version_Template
==Subroutine Name
**FileToString**
==Explanation and Usage
This subroutine reads a file in to a string variable. It internally calls [[APIs FileToArray|FileToArray]], and returns the array joined by "\n".
==Syntax
**`FileToString(FileName)`**
==Options
**FileName** - The file you are trying to retrieve, including the full path.
==Examples
These are actual examples from the Aneuch source code:
**`my $blocked = FileToString($BlockedList);`**\\In this example, the $BlockedList file is read in and returned to the variable $blocked.
This page is a template
Summary:
User name:
Upload a file
By contributing to this wiki, you acknowledge that you waive your right to claim copyright of your individual contributions. The text of this site is uncopyrighted and released to the public domain.
Show markup help Styling **bold **, //italic //, __underline __, --strikethrough--, `teletype ` Headers = Level 1 =, == Level 2 ==, === Level 3 ===, ==== Level 4 ====, ===== Level 5 ===== (ending ='s optional) Lists * Unordered List, # Ordered List, ** Level 2 unordered, ### Level 3 ordered (up to 5 levels, NO SPACES IN FRONT) Links [[Page]], [[Page|description]], [[http://link]], [[http://link|description]] Images {{image.jpg}}, {{right:image.jpg}} (right aligned), [[link|{{image.jpg}}]] (image linked to link), {{image.jpg|alt text}} Extras ---- (horizonal rule), ~~~~ (signature)