• A5_AddTempFile Function
• a5_create_tempfile Function
• A5_DownLoadFile Function
• a5_file_get_access_control Function
• A5_FILE_REMOVE Function
• A5_FileAttributeHelp Function
• A5_FileAttributeHelper Function
• A5_Get_FilesUpdatedSince Function
• a5_getaddinsinstalledfolder Function
• a5_getcodelibraryfolder Function
• a5_gettransformhistory Function
• a5_getuserdatafolder Function
• a5_is_addin_aex_outdated Function
• a5_libraries_synchronize Function
• a5_load_aex_files Function
• a5_path_relative Function
• A5_PROMPT_FILES_IN_DB Function
• a5_promptforoverwrite Function
• a5_regexfilename Function
• a5_saveas_formats_help Function
• a5_savetransformhistory Function
• A5_SYNCHRONIZE_FOLDERS Function
• a5_zip_files_w_fback Function
• a5Helper_generateFileDownloadJS Function
• BOF Function
• COPY_FILES Function
• FILE_COPY Function
• FILE_GET_DATE_TIME Function
• FILE_GET_SIZE Function
• FILE_IS_OPEN Function
• FILES_IN_TABLE Function
• GET_FROM_FILE Function
• getfromapplicationdatafile Function
• SAVE_TO_FILE Function
• savetoapplicationdatafile Function
• touch Function
• UNZIP_FILES Function
• XPS_to_PDF Function
• ZIP_FILES Function
• zip_folder Function

GET_FROM_FILE Function

Syntax

Arguments

filenameCharacter

The fully qualified file path and name on the local machine, the URL of a remote file, or a JSON string defining the following properties:

connectionStringCharacter

The name of a saved Storage Connection.

objectNameCharacter

The name of the file object to read.

flagBase64EncodeLogical

Default = .f.. If .t., Base64 encodes the data before returning it.

Returns

ResultCharacter

Returns the file contents. If the operation fails, returns an empty string.

Description

Returns the contents of a file as a text string.

Discussion

GET_FROM_FILE() opens a file specified by filename and reads the contents of the file. Returns a character string with the contents of the file.

Example: Reading a file

This script reads the contents of a file.

dim fileLocation as C = A5.GET_PATH() + "simpleExample.txt"
dim fileContents as C = get_from_file(fileLocation)

Example: Reading a file from a URL

This script reads the contents of a file located at a URL.

dim fileLocation as C = "https://www.example.com/simpleExample.txt"

dim fileContents as C = get_from_file(fileLocation)

Example: Reading a file from AmazonS3

This script reads the contents of a file from AmazonS3.

dim fileReadParams as P
fileReadParams.connectionString = "AmazonS3" 'The name of a saved Storage Connection string
fileReadParams.objectName = "logs\myFile.txt" 'The name of the object to read

' Generate a JSON string:
dim containsSpecialFlags as L = .f.
dim compactJSON as L = .t.

dim fileLocation as C = json_generate(fileReadParams,containsSpecialFlags,compactJSON)

dim fileContents as C = get_from_file(fileLocation)

See Also

• File Functions
• Directory Functions
• Save_TO_FILE()
• Storage Connections