Sign in Join
FPDoc Onlineexperiment

FilenameIsAbsolute function

In unit LazFileUtils

Determines if the specified value is an absolute file path (not a relative one).

Declaration

pascal
function FilenameIsAbsolute(const TheFilename: string): Boolean

Arguments

TheFilename

Path and file name to use in the function.

Function result

True when the file name is not a relative path.

Description

FilenameIsAbsolute is a Boolean function used to determine if the value in TheFilename contains an absolute file path (and not a relative one). The implementation for FilenameIsAbsolute is platform- and/or OS-specific.

In UNIX-like environments, the FilenameIsUnixAbsolute function is used in the implementation. The return value is False if TheFilename is an empty string (''), or does not start with the directory separator for the environment.

On Windows, the FilenameIsWinAbsolute function is called in the implementation. FilenameIsWinAbsolute takes Device identifiers into consideration when examining the value in TheFilename. For example:

D:\db\employee.fdb

The return value is False if TheFilename (without the optional device identifier) is an empty string (''), or does not start with the directory separator for the environment.

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