Navigation
This is an upcoming (i.e. in progress) version of the manual.

cat()

On this page

Definition

cat(filename, useBinaryMode)

Returns the contents of the specified file. The method returns with output relative to the current shell session and does not impact the server.

Parameter Type Description
filename string The filepath to open. The filepath must be on the local file system.
useBinaryMode boolean

Optional. Flag to determine whether to open file in binary mode or text mode.

Applicable for Windows.

  • Specify true to open the file in binary mode.

    On Windows, opening the file in binary mode leaves the character ‘\n’ as is.

  • Specify false to open the file in text mode.

    On Windows, opening the file in text mode converts the character ‘\n’ to ‘\r\n’.

The default value is false.

New in version 4.0.5.

←   Native Methods cd()  →