Sign in Join
FPDoc Onlineexperiment

ShortDisplayFilename function

In unit LazFileUtils

Gets a shortened version of the specified file name up to a maximum length.

Declaration

pascal
function ShortDisplayFilename(const aFileName: string; 
 aLimit: Integer=80): string

Arguments

aFileName

File name examined in the routine.

aLimit

Maximum number of characters for the shortened file name.

Function result

Shortened version of the specified file name.

Description

ShortDisplayFilename is a String function used to get a shortened version of the specified file name up to the specified maximum length. The characters '...' are appended to a shortened file name.

These are three (3) Period characters and not an Ellipsis character.

The return value is the same as the aFileName argument if the file name did not need to be shortened.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.