[Overview][Constants][Types][Procedures and functions][Variables][Index] Reference for unit 'LazFileUtils' (#lazutils)

CompareFileExt

Performs a sort order comparison for the specified file name and extension.

Declaration

Source position: lazfileutils.pas line 35

function CompareFileExt(

  const Filename: string;

  Ext: string;

  CaseSensitive: Boolean

):Integer;

function CompareFileExt(

  const Filename: string;

  const Ext: string

):Integer;

Arguments

Filename

  

File name for the comparison.

Ext

  

File extension for the comparison.

CaseSensitive

  

True if case sensitive comparison is needed.

Function result

Relative sort order for the compared values.

Arguments

Filename

  

File name for the comparison.

Ext

  

File extension for the comparison.

Description

CompareFileExt is an Integer function used to compare the file extension in Filename to the value in Ext. Ext may contain the '.' character, but it is not required and will be removed for the comparison. CaseSensitive indicates whether case is ignored in the comparison. When CaseSensitive contains True, CompareStr is called to perform the comparison. Otherwise, UTF8CompareText is called to compare the values. The return value will contain one of the following:

-1
Filename value has a lower sort order value than Ext
0
Filename and Ext have the same sort order values
1
Filename value has a higher sort order value than Ext

The return is 1 if Filename does not contain a file extension.