All Manuals > LispWorks User Guide and Reference Manual > 38 The HCL Package

NextPrevUpTopContentsIndex

file-string

Function
Summary

Returns the contents of a file as a string.

Package

hcl

Signature

file-string file &key length external-format => string

Arguments

file

A pathname, string or file-stream, designating a file.

length

The number of characters to return in string, or nil (the default).

external-format

An external format specification, default value :default.

Values

string

A string containing characters from file.

Description

Returns the entire contents of file (if length is nil), or the first length characters, as a string.

Example
CL-USER 26 > file-string "configure.lisp" :length 18
";; -*- Mode: Lisp;"
See also

guess-external-format


LispWorks User Guide and Reference Manual - 13 Feb 2015

NextPrevUpTopContentsIndex