From 980b9def3a115861d3ebfd9db196717e5749920e Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 19 Dec 2021 11:50:42 +0000 Subject: [PATCH 01/99] Convert all Credits & Comments keys to Extra Also merged Credits_URL and Credits keys to create required REML for Extra key. Fixes following bug: TimeZone bias bug in Desc key - see issue #6 --- csdb/collection/date.ini | 72 ++++++++++++++++------------------ csdb/collection/drive.ini | 2 +- csdb/collection/encoding.ini | 3 +- csdb/collection/file.ini | 19 ++++----- csdb/collection/graphics.ini | 25 ++++++------ csdb/collection/hex.ini | 6 +-- csdb/collection/maths.ini | 29 +++++++------- csdb/collection/multimedia.ini | 2 +- csdb/collection/registry.ini | 4 +- csdb/collection/shell.ini | 23 +++++------ csdb/collection/string.ini | 46 +++++++++++----------- csdb/collection/sys.ini | 38 ++++++++---------- csdb/collection/utils.ini | 15 ++++--- csdb/collection/web.ini | 2 +- csdb/collection/windows.ini | 16 ++++---- csdb/collection/winsys.ini | 6 +-- 16 files changed, 144 insertions(+), 164 deletions(-) diff --git a/csdb/collection/date.ini b/csdb/collection/date.ini index c32890b..7177d27 100644 --- a/csdb/collection/date.ini +++ b/csdb/collection/date.ini @@ -7,7 +7,7 @@ [AddDays] DescEx="

Adds the number of days, Days, to the given date, DateTime and returns the result.

To subtract days, pass a negative value for Days.

" -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=DiffDays Snip=548.dat Delphi2=Y @@ -53,7 +53,7 @@ FPC=Y [DateDay] Desc="Extracts the day of the month from a specified date." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateMonth,DateYear,DayOfYear TestInfo=advanced @@ -78,7 +78,7 @@ FPC=Y [DateMonth] Desc="Extracts the month from a specified date." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateDay,DateYear,DaysInMonth,DateMonthEnd,DateMonthStart Snip=225.dat @@ -102,7 +102,7 @@ FPC=Y [DateMonthEnd] Desc="Returns the last day of the month containing the given date." -Comments="The date returned is midnight at the beginning of the last day of the month." +Extra="

The date returned is midnight at the beginning of the last day of the month.

" Units=SysUtils SeeAlso=DateMonth,DateMonthStart,DaysInMonth Depends=DaysInMonth @@ -128,8 +128,7 @@ FPC=Y [DateMonthStart] Desc="Returns the first day of the month containing the given date." -Credits="Slightly modified from code contributed by Bill Miller." -Comments="The date returned is midnight at the beginning of the first day of the month." +Extra="

The date returned is midnight at the beginning of the first day of the month.

Slightly modified from code contributed by Bill Miller.

" Units="SysUtils" SeeAlso=DateMonth,DateMonthEnd TestInfo=advanced @@ -154,7 +153,7 @@ FPC=Y [DateQuarter] Desc="Returns the number of the quarter containing a given date." -Credits="Based on code contributed by Homolibere." +Extra="

Based on code contributed by Homolibere.

" Units=SysUtils SeeAlso=DateQuarterStart,DateQuarterEnd TestInfo=advanced @@ -179,7 +178,7 @@ FPC=Y [DateQuarterEnd] Desc="Gets the date of the last day of the quarter containing a given date." -Credits="Modified from code contributed by Homolibere." +Extra="

Modified from code contributed by Homolibere.

" Units=SysUtils SeeAlso=DateQuarter,DateQuarterStart TestInfo=advanced @@ -204,7 +203,7 @@ FPC=Y [DateQuarterStart] Desc="Gets the date of the first day of the quarter containing a given date." -Credits="Modified from code contributed by Homolibere." +Extra="

Modified from code contributed by Homolibere.

" Units=SysUtils SeeAlso=DateQuarter,DateQuarterEnd TestInfo=advanced @@ -274,7 +273,7 @@ FPC=Y [DateYear] Desc="Extracts the year from a specified date." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateDay,DateMonth,IsLeapYear,DateYearStart,DateYearEnd Snip=226.dat @@ -298,8 +297,7 @@ FPC=Y [DateYearEnd] Desc="Returns the last day of the year containing the specified date." -Credits="Renamed routine from Bill Miller's snippets collection." -Comments="The date returned is midnight at the beginning of the last day of the year." +Extra="

The date returned is midnight at the beginning of the last day of the year.

Renamed routine from Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=DateYear,DateYearStart TestInfo=advanced @@ -324,8 +322,7 @@ FPC=Y [DateYearStart] Desc="Returns the first day of the year containing the specified date." -Credits="Renamed from routine contributed by Bill Miller." -Comments="The date returned is midnight at the beginning of the first day of the year." +Extra="

The date returned is midnight at the beginning of the first day of the year.

Renamed from routine contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateYear,DateYearEnd TestInfo=advanced @@ -350,7 +347,7 @@ FPC=Y [DayOfYear] Desc="Returns the day of the year for the given date." -Credits="From Bill Miller's snippets collection." +Extra="

From Bill Miller's snippets collection.

" Depends=DateYearStart SeeAlso=DateDay Snip=550.dat @@ -398,7 +395,7 @@ FPC=Y [DiffDays] Desc="Returns the whole number of days separating two given dates." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=AddDays Snip=549.dat Delphi2=Y @@ -421,7 +418,7 @@ FPC=Y [Is24HourTimeFormat] Desc="Checks if the 24 hour time format is being used by the current thread." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" Units=SysUtils,Windows Snip=229.dat Delphi2=Y @@ -444,7 +441,7 @@ FPC=N [IsDaylightSaving] Desc="Checks if current local time is daylight saving time." -Comments="Raises exception if daylight saving information cannot be obtained from operating system." +Extra="

Raises exception if daylight saving information cannot be obtained from operating system.

" Units=SysUtils,Windows Snip=230.dat Delphi2=N @@ -467,7 +464,7 @@ FPC=Y [IsFriday] Desc="Checks if the given date is a Friday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils Snip=539.dat @@ -491,7 +488,7 @@ FPC=Y [IsLeapYear] Desc="Checks if a specified date falls in a leap year." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Depends=DateYear SeeAlso=DateYear,DaysInMonth Snip=227.dat @@ -515,7 +512,7 @@ FPC=Y [IsMonday] Desc="Checks if the given date is a Monday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils Snip=540.dat @@ -539,7 +536,7 @@ FPC=Y [IsSaturday] Desc="Checks if the given date is a Saturday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSunday,IsWeekday,IsWeekend Units=SysUtils Snip=541.dat @@ -563,7 +560,7 @@ FPC=Y [IsSunday] Desc="Checks if the given date is a Sunday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsWeekday,IsWeekend Units=SysUtils Snip=542.dat @@ -587,7 +584,7 @@ FPC=Y [IsThursday] Desc="Checks if the given date is a Thursday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils Snip=543.dat @@ -611,7 +608,7 @@ FPC=Y [IsTuesday] Desc="Checks if the given date is a Tuesday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils Snip=544.dat @@ -635,7 +632,7 @@ FPC=Y [IsValidDate] Desc="Checks if a string represents a valid date in the current locale." -Credits="Inspired by code from Bill Miller's snippets collection." +Extra="

Inspired by code from Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=IsValidTime Snip=355.dat @@ -659,7 +656,7 @@ FPC=Y [IsValidTime] Desc="Checks if a string represents a valid time in the current locale." -Credits="Inspired by code from Bill Miller's snippets collection." +Extra="

Inspired by code from Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=IsValidDate Snip=356.dat @@ -683,7 +680,7 @@ FPC=Y [IsWednesday] Desc="Checks if the given date is a Wednesday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils Snip=545.dat @@ -707,7 +704,7 @@ FPC=Y [IsWeekday] Desc="Checks if the given date is a weekday." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekend Units=SysUtils Snip=546.dat @@ -731,7 +728,7 @@ FPC=Y [IsWeekend] Desc="Checks if the given date is a weekend." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday Units=SysUtils Snip=547.dat @@ -801,7 +798,7 @@ FPC=Y [SQLDateToDateTime] DescEx="Converts a date in SQL format into a TDateTime." -Comments="Handles only the date component. Any time component is ignored." +Extra="

Handles only the date component. Any time component is ignored.

" Units=SysUtils SeeAlso=SQLDate TestInfo=advanced @@ -826,7 +823,7 @@ FPC=Y [TimeHour] Desc="Extracts the hour from a specified time." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=TimeMin,TimeSec Snip=175.dat @@ -850,7 +847,7 @@ FPC=Y [TimeMin] Desc="Extracts the minute from a specified time." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=TimeHour,TimeSec Snip=176.dat @@ -874,7 +871,7 @@ FPC=Y [TimeSec] Desc="Extracts the second from a specified time." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=TimeHour,TimeMin Snip=177.dat @@ -897,9 +894,8 @@ Delphi10S=Y FPC=Y [TimeZoneBias] -Desc="Gets the bias of the local time zone relative to UTC (GMT). Does not adjust for daylight saving time." -Desc="

Gets the bias of the local time zone relative to UTC (GMT).

Does not adjust for daylight saving time.

" -Credits="Adapted from code contributed by Bill Miller." +DescEx="

Gets the bias of the local time zone relative to UTC (GMT).

Does not adjust for daylight saving time.

" +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils,Windows SeeAlso=AdjustedTimeZoneBias,TimeZoneName Snip=270.dat @@ -923,7 +919,7 @@ FPC=Y [TimeZoneName] Desc="Returns a string containing the local time zone name or '' if the name is unknown." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils,Windows SeeAlso=TimeZoneBias Snip=271.dat diff --git a/csdb/collection/drive.ini b/csdb/collection/drive.ini index 90e705d..4df9bce 100644 --- a/csdb/collection/drive.ini +++ b/csdb/collection/drive.ini @@ -7,7 +7,7 @@ [CurentDrive] Desc="Returns the letter that identifies the current drive." -Credits="Modified from Bill Miller's snippets collection." +Extra="

Modified from Bill Miller's snippets collection.

" Snip=352.dat Delphi2=Y Delphi3=Y diff --git a/csdb/collection/encoding.ini b/csdb/collection/encoding.ini index f9e6ba4..c1d7b5b 100644 --- a/csdb/collection/encoding.ini +++ b/csdb/collection/encoding.ini @@ -7,8 +7,7 @@ [BytesToAnsiString] DescEx="Converts the given array of bytes to an ANSI raw byte string, which is returned. The returned string has the code page specified by CodePage." -Credits="Based on code from the Stack Overflow posting [How can I convert TBytes to RawByteString?]." -Credits_URL="http://stackoverflow.com/questions/773297/how-can-i-convert-tbytes-to-rawbytestring" +Extra="

Based on code from the Stack Overflow posting How can I convert TBytes to RawByteString?.

" Units=SysUtils Snip=359.dat Delphi2=N diff --git a/csdb/collection/file.ini b/csdb/collection/file.ini index acda8fe..85b7dc0 100644 --- a/csdb/collection/file.ini +++ b/csdb/collection/file.ini @@ -30,7 +30,7 @@ FPC=Y [CopyFiles] DescEx="

Copies files from directory name SrcDir to directory named DestDir. Files to be copied are filtered using DOS wildcard mask in WildCard.

Sub-directories are not copied. DestDir must exist.

" -Credits="Contributed by Jan Roza." +Extra="

Contributed by Jan Roza.

" Units=Classes,SysUtils,Windows Depends=ListFiles,DirToPath SeeAlso=CopyFile @@ -124,7 +124,7 @@ FPC=Y [DeleteFilesWithUndo] Desc="Deletes a list of files and sends them all to the recycle bin. Returns True if the files were deleted successfully and False if the function fails." -Comments="If any of the listed files don't exist none will be deleted and the function will fail." +Extra="

If any of the listed files don't exist none will be deleted and the function will fail.

" Units=Classes,ShellAPI Depends=StringsToMultiSz SeeAlso=EmptyRecycleBin,DeleteFiles,DeleteFileWithUndo @@ -240,7 +240,7 @@ FPC=Y [FileSizeString] Desc="Returns the size of a file as a formatted string. For files larger than 1Kb the size is approximate. If the file size can't be read then the empty string is returned." -Credits="Modification of code contributed by Michael Rockett." +Extra="

Modification of code contributed by Michael Rockett.

" Units=SysUtils Depends=SizeOfFile64 Snip=407.dat @@ -333,7 +333,7 @@ FPC=Y [GetLastDirectory] Desc="Returns the last directory in a specified path or the empty string if the given path is not a directory." -Credits="Modified from code contributed by Bill Miller." +Extra="

Modified from code contributed by Bill Miller.

" Units=SysUtils Depends=IsDirectory,PathToDir Snip=408.dat @@ -546,8 +546,7 @@ FPC=Y [IsValidFileName] Desc="Tests if a file name is a valid on Windows file systems." -Credits="Based on information contained in the [File Names, Paths and Namespaces] topic on the Microsoft Developer Network." -Credits_URL="http://msdn.microsoft.com/en-us/library/aa365247.aspx" +Extra="

Based on information contained in the File Names, Paths and Namespaces topic on the Microsoft Developer Network.

" Units=SysUtils Depends=SizeOfFile64 Snip=260.dat @@ -618,8 +617,7 @@ FPC=Y [PathIsRoot] Desc="Checks if the given path is a root directory." -Credits="Slightly modified from code created by Steve Moss, CoCo Systems Ltd. Contributed by Bill Miller." -Comments="Works with UNC paths and paths with drive specifiers." +Extra="

Works with UNC paths and paths with drive specifiers.

Slightly modified from code created by Steve Moss, CoCo Systems Ltd. Contributed by Bill Miller.

" Units=SysUtils Depends=DirToPath Snip=354.dat @@ -711,7 +709,7 @@ FPC=Y [SizeOfFile64] Desc="Gets the size of a file. Returns -1 if the file doesn't exist or can't be accessed." -Comments="Works with files larger than 2Gb." +Extra="

Works with files larger than 2Gb.

" Units=SysUtils,Windows SeeAlso=SizeOfFile Snip=257.dat @@ -757,8 +755,7 @@ FPC=Y [URLFromShortcut] Desc="Returns the URL referenced by the given URL shortcut file, or the empty string if the given file is not a shortcut file." -Credits="Derived from a similar function published on [Torry's Delphi Pages]." -Credits_URL="http://www.torry.net/" +Extra="

Derived from a similar function published on Torry's Delphi Pages.

" Units=IniFiles SeeAlso=CreateURLShortcut,IsURLShortcut Snip=045.dat diff --git a/csdb/collection/graphics.ini b/csdb/collection/graphics.ini index 718d828..b581a3f 100644 --- a/csdb/collection/graphics.ini +++ b/csdb/collection/graphics.ini @@ -7,7 +7,7 @@ [AdjustColorBrightness] DescEx="Adjusts the brightness of colour Color by a specified Delta in range -255..255." -Credits="Based on code found on the former EFG's Delphi Reference Library." +Extra="

Based on code found on the former EFG's Delphi Reference Library.

" Units=Windows,Graphics SeeAlso=AdjustBitmapBrightness Snip=290.dat @@ -202,7 +202,7 @@ FPC=N [ColorToRGBTriple] DescEx="Converts the given TColor value into an RGB triple value, which is returned." -Comments="System colours are converted to their actual values before conversion." +Extra="

System colours are converted to their actual values before conversion.

" Units=Windows,Graphics Depends=ExtractRGB SeeAlso=RGBTripleToColor,ExtractRGB @@ -227,8 +227,7 @@ FPC=N [ContrastingColor] Desc="Returns a colour that contrasts well with a given background colour. The returned colour is either black or white." -Comments="System colours are converted into actual colours before the foreground colour is calculated." -Credits="Adapted from code by Andreas Filsinger." +Extra="

System colours are converted into actual colours before the foreground colour is calculated.

Adapted from code by Andreas Filsinger.

" Units=Windows,Graphics Depends=ColorToRGBTriple Snip=453.dat @@ -300,7 +299,7 @@ FPC=N [DrawAngledText] DescEx="

Draws angled text on a canvas at position X,Y.

The value of Angle is specified in degrees and is accurate to one tenth of a degree.

" -Comments="The canvas' current font must be a vector font otherwise the text is not angled." +Extra="

The canvas' current font must be a vector font otherwise the text is not angled.

" Units=Windows,Graphics SeeAlso=DrawDisabledText,DrawTextOutline Snip=150.dat @@ -347,7 +346,7 @@ FPC=N [DrawTextOutline] DescEx="

Draws the given text in outline on a the given canvas. The top left corner of the text is specified by the X and Y parameters.

The canvas' current brush and pen colours are used to fill and outline the text respectively.

" -Comments="The canvas' current font must be a vector font otherwise nothing will be displayed." +Extra="

The canvas' current font must be a vector font otherwise nothing will be displayed.

" Units=Windows,Graphics SeeAlso=DrawAngledText,DrawDisabledText Snip=099.dat @@ -371,7 +370,7 @@ FPC=N [EllipsifyText] DescEx="

Shortens the given text if necessary to fit within MaxWidth pixels on the given canvas.

If AsPath is True the text is shortened path-wise by inserting an ellipsis in the text body, otherwise it is trunctated and an ellipsis is appended.

" -Credits=Provided by Bill Miller. +Extra="Provided by Bill Miller.IShellLink interface or nil if LinkFileName is not a shell link.

" -Comments=COM must be initialized before this function is used. +Extra="

COM must be initialized before this function is used.

" Units=ActiveX,ShlObj SeeAlso=CreateShellLink,IsShellLink,FileFromShellLink Snip=086.dat @@ -431,8 +430,7 @@ FPC=N [ShowFindFilesDlg] DescEx="

Displays the Windows file search window ready for searching the given folder.

Returns True if the search window is shown or False if can't be displayed.

" -Credits="Based on sample code by Allan Carlton." -Comments="The file search window will appear differently on different versions of Windows." +Extra="

The file search window will appear differently on different versions of Windows.

Based on sample code by Allan Carlton.

" Units=ShellAPI,Windows SeeAlso=ShowShellPropertiesDlg Snip=021.dat @@ -456,8 +454,7 @@ FPC=Y [ShowShellPropertiesDlg] DescEx="

Shows the Windows shell properties dialogue box for the given file system object.

The dialogue box is shown non-modally.

" -Comments="The file system object must be a drive, a folder or a file. If the object does not exist Windows will display an error dialogue box." -Credits="Adapted from code contributed by Bill Miller." +Extra="

The file system object must be a drive, a folder or a file. If the object does not exist Windows will display an error dialogue box.

Adapted from code contributed by Bill Miller.

" Units=ShellAPI SeeAlso=ShowFindFilesDlg Snip=179.dat @@ -505,7 +502,7 @@ FPC=N [TaskbarHandle] Desc="Returns the window handle of the Windows task bar." -Credits="Based on sample code by Michael Beck in an article formerly on Borland Code Central." +Extra="

Based on sample code by Michael Beck in an article formerly on Borland Code Central.

" Units=Windows SeeAlso=TaskbarBounds,TrayHandle Snip=046.dat diff --git a/csdb/collection/string.ini b/csdb/collection/string.ini index 188166f..2e961e7 100644 --- a/csdb/collection/string.ini +++ b/csdb/collection/string.ini @@ -7,7 +7,7 @@ [AddThousandSeparator] DescEx="

Adds the "thousands separator" specified by C at the correct location(s) in string S and returns the result.

S is assumed to be the string representation of a positive whole number.

" -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=AddDefThousandSeparator Snip=162.dat Delphi2=Y @@ -76,7 +76,7 @@ FPC=Y [CountUnquotedWords] DescEx="Returns the number of space delimited words in string S. Any words enclosed by the quote character AQuote are counted as one word." -Credits="Contributed by Rubem Rocha." +Extra="

Contributed by Rubem Rocha.

" Units=Classes SeeAlso=ExplodeUnquotedWords,CountWords,WordCount Snip=183.dat @@ -100,7 +100,7 @@ FPC=Y [DelAllStr] DescEx="

Deletes all occurrences of sub-string Needle from string HayStack and returns the resulting string.

HayStack is returned unchanged if it does not contain Needle.

The search is case sensitive.

" -Credits="Renamed from a routine contributed by Bill Miller." +Extra="

Renamed from a routine contributed by Bill Miller.

" SeeAlso=DelAllText,DelStr,DelText Units=SysUtils Snip=477.dat @@ -124,7 +124,7 @@ FPC=Y [DelAllText] DescEx="

Deletes all occurrences of text Needle from text HayStack and returns the resulting string.

HayStack is returned unchanged if it does not contain Needle.

The search is case insensitive.

" -Credits="Renamed from a routine contributed by Bill Miller." +Extra="

Renamed from a routine contributed by Bill Miller.

" SeeAlso=DelAllStr,DelStr,DelText Units=SysUtils Snip=478.dat @@ -148,7 +148,7 @@ FPC=Y [DelStr] DescEx="

Deletes the first occurrence of sub-string Needle from string HayStack and returns the resulting string.

HayStack is returned unchanged if it does not contain Needle.

The search is case sensitive.

" -Credits="Renamed from a routine contributed by Bill Miller." +Extra="

Renamed from a routine contributed by Bill Miller.

" SeeAlso=DelAllStr,DelAllText,DelText Units=SysUtils Snip=479.dat @@ -172,7 +172,7 @@ FPC=Y [DelText] DescEx="

Deletes the first occurrence of text Needle from text HayStack and returns the resulting string.

HayStack is returned unchanged if it does not contain Needle.

The search is case insensitive.

" -Credits="Renamed from a routine contributed by Bill Miller." +Extra="

Renamed from a routine contributed by Bill Miller.

" SeeAlso=DelAllStr,DelAllText,DelStr Units=SysUtils Snip=480.dat @@ -196,7 +196,7 @@ FPC=Y [DOSLineBreaks] Desc="Converts all Unix and Mac line endings in the given string to DOS line endings and returns the result." -Comments="Any existing DOS line breaks are preserved." +Extra="

Any existing DOS line breaks are preserved.

" Units=SysUtils SeeAlso=UnixLineBreaks Snip=190.dat @@ -220,7 +220,7 @@ FPC=Y [ExplodeUnquotedWords] DescEx="

Extracts a list of space delimited words from string S and returns the number of words found. The extracted words are stored in stringlist List, overwriting any existing contents.

Any words enclosed by the quote character AQuote are kept together as one word.

" -Credits="Contributed by Rubem Rocha." +Extra="

Contributed by Rubem Rocha.

" Units=Classes SeeAlso=ExplodeWords,ExplodeStr Snip=181.dat @@ -358,8 +358,7 @@ FPC=Y [LastChar] DescEx="

Returns the last character of the given string.

It is an error if the string is empty.

" -Credits="Contributed by Guru Kathiresan." -Comments="This routine is not suitable for use with multi-byte character sets." +Extra="

This routine is not suitable for use with multi-byte character sets.

Contributed by Guru Kathiresan.

" SeeAlso=StripLastChar Snip=381.dat Delphi2=Y @@ -1000,7 +999,7 @@ FPC=Y [PadCenter] DescEx="Centre aligns string AString within a string of size AWidth and returns the result. The string is padded as necessary with character AChar." -Comments="When an odd number of padding characters is required, the extra character is added on the right." +Extra="

When an odd number of padding characters is required, the extra character is added on the right.

" SeeAlso=PadLeft,PadRight Snip=246.dat Delphi2=Y @@ -1023,7 +1022,7 @@ FPC=Y [PadLeft] DescEx="Left aligns string AString within a string of size AWidth and returns the result. The string is padded on the right as necessary with character AChar." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=PadCenter,PadRight Snip=247.dat Delphi2=Y @@ -1046,7 +1045,7 @@ FPC=Y [PadRight] DescEx="

Right aligns string AString within a string of size AWidth and returns the result. The string is padded on the left as necessary with character AChar.

" -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" SeeAlso=PadCenter,PadLeft Snip=248.dat Delphi2=Y @@ -1091,7 +1090,7 @@ FPC=Y [ReverseStr] Desc="Returns the reverse of the given string." -Credits="Renamed from a routine contributed by Rubem Nascimento da Rocha." +Extra="

Renamed from a routine contributed by Rubem Nascimento da Rocha.

" Units=SysUtils,StrUtils SeeAlso=ReverseStrR TestInfo=advanced @@ -1116,8 +1115,7 @@ FPC=Y [ReverseStrR] Desc="Returns the reverse of the given string." -Credits="Renamed from a routine contributed by Rubem Nascimento da Rocha." -Comments="Uses recursion." +Extra="

Uses recursion.

Renamed from a routine contributed by Rubem Nascimento da Rocha.

" Units=SysUtils,StrUtils SeeAlso=ReverseStr TestInfo=advanced @@ -1165,7 +1163,7 @@ FPC=Y [StripAccelChars] DescEx="Strips all accelerator ('&') characters from the given string and returns the resulting string." -Credits="Renamed from a routine contributed by Rubem Nascimento da Rocha." +Extra="

Renamed from a routine contributed by Rubem Nascimento da Rocha.

" Units=SysUtils TestInfo=advanced Snip=440.dat @@ -1212,7 +1210,7 @@ FPC=Y [StrToken] DescEx="

Finds and returns the first token in string S, delimited by the given separator character. The token and separator are removed from S.

If no separators are found then the whole of S is returned and S is then set to the empty string.

" -Credits="Slightly modified from code contributed by Guru Kathiresan." +Extra="

Slightly modified from code contributed by Guru Kathiresan.

" Units=SysUtils SeeAlso=StrTokenCount Snip=537.dat @@ -1236,7 +1234,7 @@ FPC=Y [StrTokenCount] DescEx="

Counts and returns the number of tokens in string S delimited by the given separator character.

Empty strings before separators are counted as tokens, but an empty string after the last separator is not.

" -Credits="Contributed by Guru Kathiresan." +Extra="

Contributed by Guru Kathiresan.

" SeeAlso=StrToken Depends=StrToken Snip=538.dat @@ -1283,7 +1281,7 @@ FPC=Y [TrimChar] DescEx="Trims occurrences of character C from both ends of string S and returns the result." -Comments="The character to be trimmed must be a single byte character." +Extra="

The character to be trimmed must be a single byte character.

" Depends=TrimLeftChar,TrimRightChar SeeAlso=TrimLeftChar,TrimRightChar Snip=195.dat @@ -1307,7 +1305,7 @@ FPC=Y [TrimLeftChar] DescEx="Trims occurrences of character C from the start of string S and returns the result." -Comments="The character to be trimmed must be a single byte character." +Extra="

The character to be trimmed must be a single byte character.

" SeeAlso=TrimChar,TrimRightChar Snip=196.dat Delphi2=Y @@ -1330,7 +1328,7 @@ FPC=Y [TrimRightChar] DescEx="Trims occurrences of character C from the end of string S and returns the result." -Comments="The character to be trimmed must be a single byte character." +Extra="

The character to be trimmed must be a single byte character.

" SeeAlso=TrimChar,TrimLeftChar Snip=197.dat Delphi2=Y @@ -1353,7 +1351,7 @@ FPC=Y [TrimStringList] DescEx="

Removes lines prefixed by Prefix from string list List, updating it in place.

Set Prefix to the empty string to remove empty lines, including those containing only white space.

" -Credits="Closely based on a routine contributed by Joe Donth." +Extra="

Closely based on a routine contributed by Joe Donth.

" Units=SysUtils,Classes SeeAlso=ExplodeStr,JoinStr Snip=131.dat @@ -1377,7 +1375,7 @@ FPC=Y [UnixLineBreaks] Desc="Converts all DOS and Mac line endings in the given string to Unix line endings and returns the result." -Comments="Any existing Unix line breaks are preserved." +Extra="

Any existing Unix line breaks are preserved.

" Units=SysUtils SeeAlso=DOSLineBreaks Snip=191.dat diff --git a/csdb/collection/sys.ini b/csdb/collection/sys.ini index 937c281..9352341 100644 --- a/csdb/collection/sys.ini +++ b/csdb/collection/sys.ini @@ -7,7 +7,7 @@ [DebuggerPresent] Desc="Indicates whether the calling process is running within a debugger." -Credits="Contributed by DennisLV." +Extra="

Contributed by DennisLV.

" Units=Windows Snip=136.dat Delphi2=Y @@ -30,8 +30,7 @@ FPC=Y [Delay] Desc="Delays processing for the given number of milliseconds without processing any messages." -Credits="Modified in line with Pause routine per suggestions by Montor." -Comments="This routine is aimed at console applications and threads that have no message queue. Normal GUI applications should not use this routine." +Extra="

This routine is aimed at console applications and threads that have no message queue. Normal GUI applications should not use this routine.

Modified in line with Pause routine per suggestions by Montor.

" Units=Windows SeeAlso=Pause Snip=265.dat @@ -55,7 +54,7 @@ FPC=Y [EmptyKeyQueue] Desc="Empties all keyboard messages from the message queue of any window belonging to the current thread." -Credits="Contributed by DennisLV." +Extra="

Contributed by DennisLV.

" Units=Windows,Messages SeeAlso=SendKeysToWindow Snip=120.dat @@ -79,7 +78,7 @@ FPC=Y [GetBiosVendor] Desc="Returns the name of the computer's BIOS vendor." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetProcessorIdentifier,GetProcessorName,GetSystemManufacturer,GetSystemProductName Snip=511.dat @@ -103,7 +102,7 @@ FPC=Y [GetCharFromVirtualKey] DescEx="

Translates virtual key code AKey into one or more characters which are returned as a string.

An empty string is returned if AKey can't be translated.

" -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=Windows Snip=203.dat Delphi2=Y @@ -172,7 +171,7 @@ FPC=N [GetProcessorIdentifier] Desc="Returns the identifier of the computer's processor." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorName,GetSystemManufacturer,GetSystemProductName Snip=512.dat @@ -196,7 +195,7 @@ FPC=Y [GetProcessorName] Desc="Return the name of the computer's processor." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorIdentifier,GetSystemManufacturer,GetSystemProductName Snip=513.dat @@ -220,7 +219,7 @@ FPC=Y [GetSystemManufacturer] Desc="Returns the name of the computer's manufacturer." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorIdentifier,GetProcessorName,GetSystemProductName Snip=514.dat @@ -244,7 +243,7 @@ FPC=Y [GetSystemProductName] Desc="Returns the system product name." -Credits="Contributed by Bill Miller." +Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorIdentifier,GetProcessorName,GetSystemManufacturer Snip=515.dat @@ -338,7 +337,7 @@ FPC=Y [HostIPAddress] Desc="Detects and returns the machine's local IP address, or 0.0.0.0 if the address is not found." -Credits="Contributed by DennisLV." +Extra="

Contributed by DennisLV.

" Units=SysUtils,Windows,WinSock Snip=108.dat Delphi2=Y @@ -361,7 +360,7 @@ FPC=Y [IsAdmin] Desc="Checks if the current user has administrator privileges." -Credits="Contributed by Rubem Nascimento da Rocha." +Extra="

Contributed by Rubem Nascimento da Rocha.

" Units=Windows Snip=404.dat Delphi2=N @@ -430,8 +429,7 @@ FPC=Y [IsRunningOnBattery] Desc="Checks if the computer is running on battery power and returns True if so or False when running on mains or if the power status is unknown." -Credits="Based on code published on the [Delphi FAQ]." -Credits_URL="http://www.delphifaq.com/" +Extra="

Based on code published on the Delphi FAQ.

" Units=Windows SeeAlso=RemainingBatteryPercent Snip=146.dat @@ -455,8 +453,7 @@ FPC=Y [Pause] DescEx="Pauses for ADelay milliseconds before returning." -Comments="Performs a busy wait." -Credits="Modifications to handle potential clock roll over and sleeping suggested by Montor." +Extra="

Performs a busy wait.

Modifications to handle potential clock roll over and sleeping suggested by Montor.

" Units=Windows Depends=ProcessMessages SeeAlso=Delay @@ -505,7 +502,7 @@ FPC=Y [ProgramFileSpec] Desc=Returns the fully specified path and file name of the executing program. -Credits="Based on code suggested by Alan Bailey." +Extra="

Based on code suggested by Alan Bailey.

" SeeAlso=ProgramFileName,ProgramPath,ProgramName Snip=104.dat Delphi2=Y @@ -551,7 +548,7 @@ FPC=Y [ProgramPath] Desc="Returns the directory containing the executing program." -Credits="Based on code suggested by Alan Bailey." +Extra="

Based on code suggested by Alan Bailey.

" Units=SysUtils Depends=ProgramFileSpec SeeAlso=ProgramFileSpec,ProgramFileName,ProgramName @@ -576,8 +573,7 @@ FPC=Y [RemainingBatteryPercent] Desc="Returns remaining battery life as a percentage (0..100), or -1 if the remaining battery life is unknown." -Credits="Based on code published on the [Delphi FAQ]." -Credits_URL="http://www.delphifaq.com/" +Extra="

Based on code published on the Delphi FAQ.

" Units=Windows SeeAlso=IsRunningOnBattery Snip=145.dat @@ -601,7 +597,7 @@ FPC=Y [SendKeysToWindow] DescEx="Sends key strokes to the window with the handle HWnd that correspond to the characters in string Text." -Credits="Based on code suggested by DennisLV." +Extra="

Based on code suggested by DennisLV.

" Units=Windows,Messages SeeAlso=EmptyKeyQueue,PostKeyEx32 Snip=121.dat diff --git a/csdb/collection/utils.ini b/csdb/collection/utils.ini index 72f8b98..bda56c0 100644 --- a/csdb/collection/utils.ini +++ b/csdb/collection/utils.ini @@ -163,7 +163,7 @@ FPC=Y [CompilerVer] DescEx="

Returns the version of the Delphi or Free Pascal compiler used to compile the program.

0.0 is returned on error, or if the compiler is not recognised.

" -Comments="For Delphi 2 to 5 the compiler version is calculated. From Delphi 6 on the compiler version is as reported by Delphi. For Free Pascal, major versions 1 & 2 are detected." +Extra="

For Delphi 2 to 5 the compiler version is calculated. From Delphi 6 on the compiler version is as reported by Delphi. For Free Pascal, major versions 1 & 2 are detected.

" Snip=273.dat Delphi2=Y Delphi3=Y @@ -185,7 +185,7 @@ FPC=Y [EndianSwap] Desc="Swaps the given cardinal value between little endian and big endian format, and vica versa, and returns the result." -Credits="Contributed by Montor" +Extra="

Contributed by Montor.

" Snip=293.dat Delphi2=Y Delphi3=Y @@ -297,7 +297,7 @@ FPC=Y [IntToNumberText] Desc="Returns the English text representation of the given integer." -Credits="Adapted from code contributed by Bill Miller." +Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=FloatToNumberText,IntToRoman Snip=218.dat @@ -343,8 +343,7 @@ FPC=Y [IntToRoman] DescEx="Converts non negative integer AValue into a string containing its roman numeral representation." -Comments="For values greater than 4999 the output string can get very long and difficult to read." -Credits="Modified from code contributed by Michael Rockett." +Extra="

For values greater than 4999 the output string can get very long and difficult to read.

Modified from code contributed by Michael Rockett.

" SeeAlso=IntToNumberText Snip=457.dat Delphi2=N @@ -367,7 +366,7 @@ FPC=Y [IsSubClassOf] DescEx="Checks if object instance AnInstance is a sub-class of, or the same class as, class AClass." -Credits="Contributed by Rubem Nascimento da Rocha." +Extra="

Contributed by Rubem Nascimento da Rocha.

" Snip=372.dat Delphi2=Y Delphi3=Y @@ -389,7 +388,7 @@ FPC=Y [Percentage] DescEx="

Calculates and returns the value of A ÷ B as a percentage, rounded to the nearest whole number.

B must be non-zero.

" -Credits="Modified from code contributed by Guru Kathiresan." +Extra="

Modified from code contributed by Guru Kathiresan.

" SeeAlso=PercentageStr Snip=469.dat Delphi2=Y @@ -412,7 +411,7 @@ FPC=Y [PercentageStr] DescEx="

Calculates and returns the value of A ÷ B as a percentage string, rounded to the nearest whole number.

B must be non-zero.

" -Credits="Contributed by Guru Kathiresan." +Extra="

Contributed by Guru Kathiresan.

" Units=SysUtils Depends=Percentage SeeAlso=Percentage diff --git a/csdb/collection/web.ini b/csdb/collection/web.ini index 8d9d45a..db96d6d 100644 --- a/csdb/collection/web.ini +++ b/csdb/collection/web.ini @@ -53,7 +53,7 @@ FPC=N [DownloadURLToFile] Desc="Downloads the contents of a file at the specified URL and stores in the given local file. Returns True if the download succeeds and False on failure." -Comments="A connection to the internet must be open for the download to succeed." +Extra="

A connection to the internet must be open for the download to succeed.

" Units=UrlMon,Windows,SysUtils SeeAlso=IsValidURLProtocol Snip=027.dat diff --git a/csdb/collection/windows.ini b/csdb/collection/windows.ini index cbc54aa..d2a07cb 100644 --- a/csdb/collection/windows.ini +++ b/csdb/collection/windows.ini @@ -77,7 +77,7 @@ FPC=Y [DisableTreeViewToolTips] Desc="Disables the tool tips that are displayed in the given treeview control when the mouse is hovered over an item that is cropped because it is too large to display." -Comments="This routine is of use with earlier versions of Delphi in which the tree view component does not have a property to switch tool tips on and off." +Extra="

This routine is of use with earlier versions of Delphi in which the tree view component does not have a property to switch tool tips on and off.

" Units=Windows,ComCtrls,CommCtrl Snip=507.dat Delphi2=N @@ -124,7 +124,7 @@ FPC=Y [GetIdleTime] Desc="Returns the time ellapsed since the last user input." -Credits="Modified from code contributed by Topellina." +Extra="

Modified from code contributed by Topellina.

" Units=Windows Snip=371.dat Delphi2=N @@ -171,7 +171,7 @@ FPC=Y [GetWindowTitle] DescEx="

Returns the title of the window with the given handle.

Titles of more than 255 characters are truncated.

" -Credits="Contributed by Guru Kathiresan." +Extra="

Contributed by Guru Kathiresan.

" Units=Windows Snip=500.dat Delphi2=Y @@ -265,7 +265,7 @@ FPC=Y [MemoCursorPos] DescEx="Returns a TPoint value containing the coordinates of the cursor in the given memo control." -Credits="Based on code contributed by Shlomo Abuisak." +Extra="

Based on code contributed by Shlomo Abuisak.

" Units=Messages,Windows,StdCtrls Snip=334.dat Delphi2=Y @@ -288,7 +288,7 @@ FPC=N [ResourceExists] DescEx="Checks if a resource with name ResName and type ResType exists in the module with handle Module." -Comments="This routine is language agnostic: it takes no account of the language of the required resource." +Extra="

This routine is language agnostic: it takes no account of the language of the required resource.

" Units=Windows SeeAlso=ResourceExistsEx Snip=198.dat @@ -359,7 +359,7 @@ FPC=Y [SetTransparencyLevel] DescEx="Sets the transparency level of the window with handle HWnd to the value given by Level." -Comments="This function requires that the window supports layers. The transparency level is in the range [0..255]." +Extra="

This function requires that the window supports layers. The transparency level is in the range [0..255].

" Units=Windows Depends=WindowSupportsLayers SeeAlso=DisableLayersSupport,EnableLayersSupport,WindowSupportsLayers @@ -384,7 +384,7 @@ FPC=Y [TreeNodeChildCount] Desc="Returns the number of child nodes of the given tree node." -Credits="Derived from code contributed by Bill Miller." +Extra="

Derived from code contributed by Bill Miller.

" Units=ComCtrls Snip=508.dat Delphi2=Y @@ -455,7 +455,7 @@ FPC=N [WindowScrollbars] Desc="Returns a value that specifies which, if any, scroll bars are displayed by the window with the given handle." -Credits="Based on code by Peter Below from the now defunct Delphi Pool website." +Extra="

Based on code by Peter Below from the now defunct Delphi Pool website.

" Units=Windows,StdCtrls SeeAlso=HScrollbarHeight,VScrollbarWidth,WinControlScrollbars Snip=213.dat diff --git a/csdb/collection/winsys.ini b/csdb/collection/winsys.ini index fa21a4e..9347ef0 100644 --- a/csdb/collection/winsys.ini +++ b/csdb/collection/winsys.ini @@ -122,8 +122,8 @@ FPC=Y [IsVista] Desc="Checks if the host operating system is Windows Vista or later." -Credits="Contributed by Laurent Pierre." -Comments="Works correctly even if the application has defined a Windows XP (or other) compatibility mode." +Extra="

Contributed by Laurent Pierre.

" +Extra="

Works correctly even if the application has defined a Windows XP (or other) compatibility mode.

" Units=Windows SeeAlso=IsWin9x,IsWinNT,IsWow64,IsTabletOS,IsMediaCenterOS,IsWindows7 Snip=151.dat @@ -170,7 +170,7 @@ FPC=Y [IsWindows7] Desc="Checks if the host operating system is Windows 7 (or Windows Server 2008 R2) or later." -Comments="Works correctly even if the application has defined a Windows Vista (or other) compatibility mode." +Extra="

Works correctly even if the application has defined a Windows Vista (or other) compatibility mode.

" Units=Windows SeeAlso=IsWin9x,IsWinNT,IsWow64,IsTabletOS,IsMediaCenterOS,IsVista Snip=292.dat From ef0825ebf42a5c4d9c70e23ca9ce690f8f5162f2 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 19 Dec 2021 11:54:03 +0000 Subject: [PATCH 02/99] Remove spurious text in registry.ini This bug reported in issue #6 --- csdb/collection/registry.ini | 1 - 1 file changed, 1 deletion(-) diff --git a/csdb/collection/registry.ini b/csdb/collection/registry.ini index bdc30f5..e6bb291 100644 --- a/csdb/collection/registry.ini +++ b/csdb/collection/registry.ini @@ -151,7 +151,6 @@ FPC=Y [RegValueExists] DescEx="

Checks if the value specified by APath exists in the registry under root key ARootKey.

Returns True if the value exists or False if not.

APath is considered to be a combination of a sub-key and value name, separated by a backslash.

" Extra="

APath example: An APath parameter with value '\Software\DelphiDabbler\Demos\TestValue' represents sub-key '\Software\DelphiDabbler\Demos' and value name 'TestValue'.

Modified from code contributed by Guru Kathiresan.

" -Kathiresan.

" Depends=RegParsePath SeeAlso=RegDeleteValue,RegReadString,RegWriteString Units=Windows,Registry From 8d31ab3d3d6bd33afec2a7f87cf4efea51db845d Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 26 Dec 2021 10:40:27 +0000 Subject: [PATCH 03/99] Replace all Desc keys with DescEx, plus some fixes All Desc keys were converted to DescEx keys with correctly formatted REML. Fixes were: * Mispelled "Commants" key renamed as "Extra" and REML formatted. * Duplicated "Extra" keys were merged into one. Also added a link to an RFC to one DescEx value. --- csdb/collection/arrays.ini | 6 +-- csdb/collection/date.ini | 90 +++++++++++++++++----------------- csdb/collection/drive.ini | 28 +++++------ csdb/collection/encoding.ini | 18 +++---- csdb/collection/file.ini | 74 ++++++++++++++-------------- csdb/collection/graphics.ini | 54 ++++++++++---------- csdb/collection/hex.ini | 30 ++++++------ csdb/collection/maths.ini | 50 +++++++++---------- csdb/collection/multimedia.ini | 2 +- csdb/collection/shell.ini | 18 +++---- csdb/collection/string.ini | 32 ++++++------ csdb/collection/structs.ini | 8 +-- csdb/collection/sys.ini | 52 ++++++++++---------- csdb/collection/utils.ini | 36 +++++++------- csdb/collection/wb.ini | 16 +++--- csdb/collection/web.ini | 20 ++++---- csdb/collection/windows.ini | 30 ++++++------ csdb/collection/winsys.ini | 35 +++++++------ 18 files changed, 299 insertions(+), 300 deletions(-) diff --git a/csdb/collection/arrays.ini b/csdb/collection/arrays.ini index 120acb0..2f7cc09 100644 --- a/csdb/collection/arrays.ini +++ b/csdb/collection/arrays.ini @@ -117,7 +117,7 @@ Delphi10S=Y FPC=Y [StringListToArray] -Desc="Creates and returns a dynamic string array containing all the strings from the given string list." +DescEx="

Creates and returns a dynamic string array containing all the strings from the given string list.

" SeeAlso=ArrayToStringList Units=Classes,Types Snip=347.dat @@ -186,7 +186,7 @@ Delphi10S=Y FPC=Y [CloneByteArray] -Desc="Makes a copy of an array of bytes." +DescEx="

Makes a copy of an array of bytes.

" Extra="

Useful for creating a TBytes array from a constant array or for cloning an existing byte array.

" Depends=TBytes SeeAlso=AppendByteArray @@ -349,7 +349,7 @@ FPC=Y [TArrayUtils] Kind=class -Desc="A method-only advanced record that provides utility methods for working with generic dynamic arrays." +DescEx="

A method-only advanced record that provides utility methods for working with generic dynamic arrays.

" Units=Generics.Defaults SeeAlso=IndexOfByte,ByteArraysEqual,ByteArraysSameStart TestInfo=advanced diff --git a/csdb/collection/date.ini b/csdb/collection/date.ini index 7177d27..31db4c2 100644 --- a/csdb/collection/date.ini +++ b/csdb/collection/date.ini @@ -29,7 +29,7 @@ Delphi10S=Y FPC=Y [AdjustedTimeZoneBias] -Desc="Gets the bias of the local time zone relative to UTC (GMT), adjusted for daylight saving or standard time as appropriate." +DescEx="

Gets the bias of the local time zone relative to UTC (GMT), adjusted for daylight saving or standard time as appropriate.

" Units=SysUtils,Windows SeeAlso=TimeZoneBias Snip=269.dat @@ -52,7 +52,7 @@ Delphi10S=Y FPC=Y [DateDay] -Desc="Extracts the day of the month from a specified date." +DescEx="

Extracts the day of the month from a specified date.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateMonth,DateYear,DayOfYear @@ -77,7 +77,7 @@ Delphi10S=Y FPC=Y [DateMonth] -Desc="Extracts the month from a specified date." +DescEx="

Extracts the month from a specified date.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateDay,DateYear,DaysInMonth,DateMonthEnd,DateMonthStart @@ -101,7 +101,7 @@ Delphi10S=Y FPC=Y [DateMonthEnd] -Desc="Returns the last day of the month containing the given date." +DescEx="

Returns the last day of the month containing the given date.

" Extra="

The date returned is midnight at the beginning of the last day of the month.

" Units=SysUtils SeeAlso=DateMonth,DateMonthStart,DaysInMonth @@ -127,7 +127,7 @@ Delphi10S=Y FPC=Y [DateMonthStart] -Desc="Returns the first day of the month containing the given date." +DescEx="

Returns the first day of the month containing the given date.

" Extra="

The date returned is midnight at the beginning of the first day of the month.

Slightly modified from code contributed by Bill Miller.

" Units="SysUtils" SeeAlso=DateMonth,DateMonthEnd @@ -152,7 +152,7 @@ Delphi10S=Y FPC=Y [DateQuarter] -Desc="Returns the number of the quarter containing a given date." +DescEx="

Returns the number of the quarter containing a given date.

" Extra="

Based on code contributed by Homolibere.

" Units=SysUtils SeeAlso=DateQuarterStart,DateQuarterEnd @@ -177,7 +177,7 @@ Delphi10S=Y FPC=Y [DateQuarterEnd] -Desc="Gets the date of the last day of the quarter containing a given date." +DescEx="

Gets the date of the last day of the quarter containing a given date.

" Extra="

Modified from code contributed by Homolibere.

" Units=SysUtils SeeAlso=DateQuarter,DateQuarterStart @@ -202,7 +202,7 @@ Delphi10S=Y FPC=Y [DateQuarterStart] -Desc="Gets the date of the first day of the quarter containing a given date." +DescEx="

Gets the date of the first day of the quarter containing a given date.

" Extra="

Modified from code contributed by Homolibere.

" Units=SysUtils SeeAlso=DateQuarter,DateQuarterEnd @@ -272,7 +272,7 @@ Delphi10S=Y FPC=Y [DateYear] -Desc="Extracts the year from a specified date." +DescEx="

Extracts the year from a specified date.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateDay,DateMonth,IsLeapYear,DateYearStart,DateYearEnd @@ -296,7 +296,7 @@ Delphi10S=Y FPC=Y [DateYearEnd] -Desc="Returns the last day of the year containing the specified date." +DescEx="

Returns the last day of the year containing the specified date.

" Extra="

The date returned is midnight at the beginning of the last day of the year.

Renamed routine from Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=DateYear,DateYearStart @@ -321,7 +321,7 @@ Delphi10S=Y FPC=Y [DateYearStart] -Desc="Returns the first day of the year containing the specified date." +DescEx="

Returns the first day of the year containing the specified date.

" Extra="

The date returned is midnight at the beginning of the first day of the year.

Renamed from routine contributed by Bill Miller.

" Units=SysUtils SeeAlso=DateYear,DateYearEnd @@ -346,7 +346,7 @@ Delphi10S=Y FPC=Y [DayOfYear] -Desc="Returns the day of the year for the given date." +DescEx="

Returns the day of the year for the given date.

" Extra="

From Bill Miller's snippets collection.

" Depends=DateYearStart SeeAlso=DateDay @@ -370,7 +370,7 @@ Delphi10S=Y FPC=Y [DaysInMonth] -Desc="Gets number of days in month specified by a given date. Allows for leap days." +DescEx="

Gets number of days in month specified by a given date. Allows for leap days.

" Units=SysUtils Depends=DateMonth,IsLeapYear SeeAlso=DateDay,IsLeapYear @@ -394,7 +394,7 @@ Delphi10S=Y FPC=Y [DiffDays] -Desc="Returns the whole number of days separating two given dates." +DescEx="

Returns the whole number of days separating two given dates.

" Extra="

Contributed by Bill Miller.

" SeeAlso=AddDays Snip=549.dat @@ -417,7 +417,7 @@ Delphi10S=Y FPC=Y [Is24HourTimeFormat] -Desc="Checks if the 24 hour time format is being used by the current thread." +DescEx="

Checks if the 24 hour time format is being used by the current thread.

" Extra="

Contributed by Bill Miller.

" Units=SysUtils,Windows Snip=229.dat @@ -440,7 +440,7 @@ Delphi10S=Y FPC=N [IsDaylightSaving] -Desc="Checks if current local time is daylight saving time." +DescEx="

Checks if current local time is daylight saving time.

" Extra="

Raises exception if daylight saving information cannot be obtained from operating system.

" Units=SysUtils,Windows Snip=230.dat @@ -463,7 +463,7 @@ Delphi10S=Y FPC=Y [IsFriday] -Desc="Checks if the given date is a Friday." +DescEx="

Checks if the given date is a Friday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils @@ -487,7 +487,7 @@ Delphi10S=Y FPC=Y [IsLeapYear] -Desc="Checks if a specified date falls in a leap year." +DescEx="

Checks if a specified date falls in a leap year.

" Extra="

Adapted from code contributed by Bill Miller.

" Depends=DateYear SeeAlso=DateYear,DaysInMonth @@ -511,7 +511,7 @@ Delphi10S=Y FPC=Y [IsMonday] -Desc="Checks if the given date is a Monday." +DescEx="

Checks if the given date is a Monday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils @@ -535,7 +535,7 @@ Delphi10S=Y FPC=Y [IsSaturday] -Desc="Checks if the given date is a Saturday." +DescEx="

Checks if the given date is a Saturday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSunday,IsWeekday,IsWeekend Units=SysUtils @@ -559,7 +559,7 @@ Delphi10S=Y FPC=Y [IsSunday] -Desc="Checks if the given date is a Sunday." +DescEx="

Checks if the given date is a Sunday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsWeekday,IsWeekend Units=SysUtils @@ -583,7 +583,7 @@ Delphi10S=Y FPC=Y [IsThursday] -Desc="Checks if the given date is a Thursday." +DescEx="

Checks if the given date is a Thursday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils @@ -607,7 +607,7 @@ Delphi10S=Y FPC=Y [IsTuesday] -Desc="Checks if the given date is a Tuesday." +DescEx="

Checks if the given date is a Tuesday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils @@ -631,7 +631,7 @@ Delphi10S=Y FPC=Y [IsValidDate] -Desc="Checks if a string represents a valid date in the current locale." +DescEx="

Checks if a string represents a valid date in the current locale.

" Extra="

Inspired by code from Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=IsValidTime @@ -655,7 +655,7 @@ Delphi10S=Y FPC=Y [IsValidTime] -Desc="Checks if a string represents a valid time in the current locale." +DescEx="

Checks if a string represents a valid time in the current locale.

" Extra="

Inspired by code from Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=IsValidDate @@ -679,7 +679,7 @@ Delphi10S=Y FPC=Y [IsWednesday] -Desc="Checks if the given date is a Wednesday." +DescEx="

Checks if the given date is a Wednesday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday,IsWeekend Units=SysUtils @@ -703,7 +703,7 @@ Delphi10S=Y FPC=Y [IsWeekday] -Desc="Checks if the given date is a weekday." +DescEx="

Checks if the given date is a weekday.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekend Units=SysUtils @@ -727,7 +727,7 @@ Delphi10S=Y FPC=Y [IsWeekend] -Desc="Checks if the given date is a weekend." +DescEx="

Checks if the given date is a weekend.

" Extra="

Contributed by Bill Miller.

" SeeAlso=IsMonday,IsTuesday,IsWednesday,IsThursday,IsFriday,IsSaturday,IsSunday,IsWeekday Units=SysUtils @@ -773,7 +773,7 @@ Delphi10S=Y FPC=Y [SQLDate] -Desc="Formats a date in SQL format." +DescEx="

Formats a date in SQL format.

" Units=SysUtils SeeAlso=SQLDateToDateTime TestInfo=advanced @@ -822,7 +822,7 @@ Delphi10S=Y FPC=Y [TimeHour] -Desc="Extracts the hour from a specified time." +DescEx="

Extracts the hour from a specified time.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=TimeMin,TimeSec @@ -846,7 +846,7 @@ Delphi10S=Y FPC=Y [TimeMin] -Desc="Extracts the minute from a specified time." +DescEx="

Extracts the minute from a specified time.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=TimeHour,TimeSec @@ -870,7 +870,7 @@ Delphi10S=Y FPC=Y [TimeSec] -Desc="Extracts the second from a specified time." +DescEx="

Extracts the second from a specified time.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=TimeHour,TimeMin @@ -918,7 +918,7 @@ Delphi10S=Y FPC=Y [TimeZoneName] -Desc="Returns a string containing the local time zone name or '' if the name is unknown." +DescEx="

Returns a string containing the local time zone name or '' if the name is unknown.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils,Windows SeeAlso=TimeZoneBias @@ -1058,7 +1058,7 @@ Delphi10S=Y FPC=Y [LongDayName] -Desc="Gets the long name of the day specified by a date." +DescEx="

Gets the long name of the day specified by a date.

" Extra="

Users of Delphi XE & later or Free Pascal 2.6.0 & later should use LongDayNameXE instead of this routine.

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=ShortDayName,LongMonthName,LongDayNameXE @@ -1086,7 +1086,7 @@ Delphi10S=N FPC=Y [LongDayNameXE] -Desc="Gets the long name of the day specified by a date." +DescEx="

Gets the long name of the day specified by a date.

" Extra="

This is a version of LongDayName suitable for use with Delphi XE & later or Free Pascal 2.6.0 & later. For Delphi 2010 and earlier, use LongDayName instead.

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=ShortDayNameXE,LongMonthNameXE,LongDayName @@ -1110,7 +1110,7 @@ Delphi10S=Y FPC=Y [LongMonthName] -Desc="Gets the long name of the month specified by a date." +DescEx="

Gets the long name of the month specified by a date.

" Extra="

Users of Delphi XE & later or Free Pascal 2.6.0 & later should use LongMonthNameXE instead of this routine.

Amalgam of code contributed by both Bill Miller and Peter Johnson.

" Units=SysUtils Depends=DateMonth @@ -1139,7 +1139,7 @@ Delphi10S=N FPC=Y [LongMonthNameXE] -Desc="Gets the long name of the month specified by a date." +DescEx="

Gets the long name of the month specified by a date.

" Extra="

This is a version of LongMonthName suitable for use with Delphi XE & later or Free Pascal 2.6.0 & later. For Delphi 2010 and earlier, use LongMonthName instead.

Amalgam of code contributed by both Bill Miller and Peter Johnson.

" Units=SysUtils Depends=DateMonth @@ -1164,7 +1164,7 @@ Delphi10S=Y FPC=Y [MinsToStr] -Desc="Converts the given number of minutes to a formatted days / hours / minutes string." +DescEx="

Converts the given number of minutes to a formatted days / hours / minutes string.

" Extra="

Modified from code contributed by "michael".

" Units=SysUtils Snip=632.dat @@ -1183,7 +1183,7 @@ Delphi10S=Y FPC=Y [NowGMT] -Desc="Returns the current date and time converted to UTC/GMT." +DescEx="

Returns the current date and time converted to UTC/GMT.

" Units=SysUtils,Windows SeeAlso=GMTToLocalTime Snip=628.dat @@ -1201,7 +1201,7 @@ Delphi10S=Y FPC=Y [RFC1123DateGMT] -Desc="Returns the given date time value, which must be in GMT/UTC, as a RFC1123 formatted string." +DescEx="

Returns the given date time value, which must be in GMT/UTC, as a RFC1123 formatted string.

" Units=SysUtils SeeAlso=NowGMT TestInfo=advanced @@ -1271,7 +1271,7 @@ Delphi10S=Y FPC=Y [ShortDayName] -Desc="Gets the short name of the day specified by a date." +DescEx="

Gets the short name of the day specified by a date.

" Extra="

Users of Delphi XE & later or Free Pascal 2.6.0 & later should use ShortDayNameXE instead of this routine.

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=LongDayName,ShortMonthName,ShortDayNameXE @@ -1299,7 +1299,7 @@ Delphi10S=N FPC=Y [ShortDayNameXE] -Desc="Gets the short name of the day specified by a date." +DescEx="

Gets the short name of the day specified by a date.

" Extra="

This is a version of ShortDayName suitable for use with Delphi XE & later or Free Pascal 2.6.0 & later. For Delphi 2010 and earlier, use ShortDayName instead.

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=LongDayNameXE,ShortMonthNameXE,ShortDayName @@ -1323,7 +1323,7 @@ Delphi10S=Y FPC=Y [ShortMonthName] -Desc="Gets the short name of the month specified by a date." +DescEx="

Gets the short name of the month specified by a date.

" Extra="

Users of Delphi XE & later or Free Pascal 2.6.0 & later should use ShortMonthNameXE instead of this routine.

Amalgam of code contributed by both Bill Miller and Peter Johnson.

" Units=SysUtils Depends=DateMonth @@ -1352,7 +1352,7 @@ Delphi10S=N FPC=Y [ShortMonthNameXE] -Desc="Gets the short name of the month specified by a date." +DescEx="

Gets the short name of the month specified by a date.

" Extra="

This is a version of ShortMonthName suitable for use with Delphi XE & later or Free Pascal 2.6.0 & later. For Delphi 2010 and earlier, use ShortMonthName instead.

Amalgam of code contributed by both Bill Miller and Peter Johnson.

" Units=SysUtils Depends=DateMonth @@ -1377,7 +1377,7 @@ Delphi10S=Y FPC=Y [WesternEaster] -Desc="Returns the date of Easter Sunday for the given year in the Gregorian calendar as used by Western Christian Churches." +DescEx="

Returns the date of Easter Sunday for the given year in the Gregorian calendar as used by Western Christian Churches.

" Extra="

This routine is derived from a snippet taken from the SWAG Archive. That snippet was converted to Pascal by Kerry Sokalsky from Modula-2 code written by Greg Vigneault in 1993.

The algorithm was taken from chapter 4 of "Astronomical Formulae for Calculators" 2nd edition; by Jean Meeus; publisher: Willmann-Bell Inc., ISBN 0-943396-01-8.

The algorithm is valid for all years in the Gregorian calendar, i.e. from 1583 onwards. The extreme dates of Easter are March 22 (as in 1818 and 2285) and April 25 (as in 1886, 1943, 2038).

For more details of the algorithm see this article on Wikipedia.

" Units=SysUtils TestInfo=advanced diff --git a/csdb/collection/drive.ini b/csdb/collection/drive.ini index 4df9bce..f991a09 100644 --- a/csdb/collection/drive.ini +++ b/csdb/collection/drive.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [CurentDrive] -Desc="Returns the letter that identifies the current drive." +DescEx="

Returns the letter that identifies the current drive.

" Extra="

Modified from Bill Miller's snippets collection.

" Snip=352.dat Delphi2=Y @@ -28,7 +28,7 @@ Delphi10S=Y FPC=Y [DriveDisplayNames] -Desc="Gets list of display names for all the system's drives and stores in a given string list." +DescEx="

Gets list of display names for all the system's drives and stores in a given string list.

" Units=Classes,ShellAPI,SysUtils Depends=ListDrives,DriveDisplayName SeeAlso=DriveDisplayName,ListDrives @@ -52,7 +52,7 @@ Delphi10S=Y FPC=Y [DriveRootPath] -Desc="Returns root drive path for drive with given number." +DescEx="

Returns root drive path for drive with given number.

" SeeAlso=DriveTypeFromPath,IsValidDriveNum Snip=064.dat Delphi2=Y @@ -74,7 +74,7 @@ Delphi10S=Y FPC=Y [DriveTypeFromPath] -Desc="Returns type of drive that contains the given (full) path." +DescEx="

Returns type of drive that contains the given (full) path.

" Units=Windows,SysUtils SeeAlso=DriveRootPath,DriveDisplayName,IsValidDrive Snip=028.dat @@ -97,7 +97,7 @@ Delphi10S=Y FPC=Y [FileSystemName] -Desc="Returns name of a drive's file system or empty string if file system can't be determined or drive is not valid." +DescEx="

Returns name of a drive's file system or empty string if file system can't be determined or drive is not valid.

" Units=Windows SeeAlso=VolumeName Snip=138.dat @@ -120,7 +120,7 @@ Delphi10S=Y FPC=Y [VolumeName] -Desc="Returns the volume name of the given drive or empty string if the volume has no name or the drive is not valid." +DescEx="

Returns the volume name of the given drive or empty string if the volume has no name or the drive is not valid.

" Units=Windows SeeAlso=FileSystemName,DeleteVolumeName,SetVolumeName Snip=137.dat @@ -143,7 +143,7 @@ Delphi10S=Y FPC=Y [DeleteVolumeName] -Desc="Deletes an existing volume label on a given drive. Returns True on success and False on failure." +DescEx="

Deletes an existing volume label on a given drive. Returns True on success and False on failure.

" Extra="

Note: Fails and returns False if the process has insufficient privileges to set the volume name.

" Units=Windows SeeAlso=VolumeName,SetVolumeName @@ -190,7 +190,7 @@ Delphi10S=Y FPC=N [DriveDisplayName] -Desc="Returns the display name for the drive with the given root path." +DescEx="

Returns the display name for the drive with the given root path.

" Extra="

Note: On versions of Delphi that do not support the SysUtils.RaiseLastOSError routine, this call can be replaced by RaiseLastWin32Error.

" Units=ShellAPI,SysUtils SeeAlso=DriveDisplayNames,DriveTypeFromPath,ListDrives @@ -214,7 +214,7 @@ Delphi10S=Y FPC=Y [GetDriveNumber] -Desc="Returns the zero based drive number for given drive. -1 is returned if drive name does not start with a valid drive letter in the range A..Z." +DescEx="

Returns the zero based drive number for given drive. -1 is returned if drive name does not start with a valid drive letter in the range A..Z.

" Extra="Drive can be specified as a disk letter (e.g. C), a drive name (e.g C: or C:\) or an absolute file path on the drive (e.g. C:\Foo\Bar.txt)." Units=SysUtils Depends=IsCharInSet @@ -262,7 +262,7 @@ Delphi10S=Y FPC=Y [IsDriveReady] -Desc="Checks if a the given local drive is ready. True is returned if the drive is ready or False if not ready or if the drive is not recognised." +DescEx="

Checks if a the given local drive is ready. True is returned if the drive is ready or False if not ready or if the drive is not recognised.

" Extra="

Drive can be specified as a disk letter (e.g. C), a drive name (e.g C: or C:\) or an absolute file path on the drive (e.g. C:\Foo\Bar.txt).

Based on code contributed by Bill Miller.

" Units=Windows,SysUtils Depends=GetDriveNumber @@ -287,7 +287,7 @@ Delphi10S=Y FPC=Y [IsValidDrive] -Desc="Checks if the given drive path represents a valid drive." +DescEx="

Checks if the given drive path represents a valid drive.

" Extra="

A valid drive can be a disk letter (e.g. C), a drive name (e.g C: or C:\) or an absolute file path on the drive (e.g. C:\Foo\Bar.txt).

" Depends=DriveTypeFromPath,IsDriveReady SeeAlso=IsValidDriveNum,DriveTypeFromPath @@ -311,7 +311,7 @@ Delphi10S=Y FPC=Y [IsValidDriveNum] -Desc="Returns True if the drive specified by the given number is valid and False otherwise." +DescEx="

Returns True if the drive specified by the given number is valid and False otherwise.

" Extra="

Drive numbers must be in the range 0..25, with 0 mapping onto A:\ and 25 mapping onto Z:\.

" Units=Windows SeeAlso=IsValidDrive,GetDriveNumber @@ -335,7 +335,7 @@ Delphi10S=Y FPC=Y [ListDrives] -Desc="Gets a list of all the system's drives and appends their root paths to the given string list." +DescEx="

Gets a list of all the system's drives and appends their root paths to the given string list.

" Extra="

Note: On versions of Delphi that do not support the SysUtils.RaiseLastOSError routine, this call can be replaced by RaiseLastWin32Error.

" Units=Classes,Windows,SysUtils Depends=MultiSzToStrings @@ -360,7 +360,7 @@ Delphi10S=Y FPC=Y [SetVolumeName] -Desc="Sets the name of the volume on a given drive. Returns True on success and False on failure." +DescEx="

Sets the name of the volume on a given drive. Returns True on success and False on failure.

" Extra="

Note: Fails and returns False if the process has insufficient privileges to set the volume name.

" Units=Windows SeeAlso=DeleteVolumeName,VolumeName diff --git a/csdb/collection/encoding.ini b/csdb/collection/encoding.ini index c1d7b5b..2722e5a 100644 --- a/csdb/collection/encoding.ini +++ b/csdb/collection/encoding.ini @@ -76,7 +76,7 @@ Delphi10S=Y FPC=Y [IsASCIIChar] -Desc="Checks if the given character is a valid ASCII character." +DescEx="

Checks if the given character is a valid ASCII character.

" SeeAlso=IsASCIIDigit,IsASCIIFile,IsASCIIStream,IsASCIIText Snip=531.dat Delphi2=Y @@ -98,7 +98,7 @@ Delphi10S=Y FPC=Y [IsASCIIDigit] -Desc="Checks if the given character is a digit in the ASCII character set." +DescEx="

Checks if the given character is a digit in the ASCII character set.

" SeeAlso=IsASCIIChar,IsASCIIFile,IsASCIIStream,IsASCIIText Snip=532.dat Delphi2=Y @@ -120,7 +120,7 @@ Delphi10S=Y FPC=Y [IsASCIIText] -Desc="Checks if the given string contains only valid ASCII characters. Returns True if so or False otherwise." +DescEx="

Checks if the given string contains only valid ASCII characters. Returns True if so or False otherwise.

" Units=SysUtils Depends=EncodingSupportsString SeeAlso=EncodingSupportsString,IsASCIIChar,IsASCIIDigit,IsASCIIFile,IsASCIIStream @@ -144,7 +144,7 @@ Delphi10S=Y FPC=Y [IsUTF16BEFile] -Desc="Checks if the given file is a UTF-16 big-endian encoded text file by examining the byte order mark at the start of the file." +DescEx="

Checks if the given file is a UTF-16 big-endian encoded text file by examining the byte order mark at the start of the file.

" Units=SysUtils,Classes Depends=IsUTF16BEStream SeeAlso=IsASCIIFile,IsUTF16File,IsUTF16LEFile,IsUTF7File,IsUTF8File,IsUTF16BEStream @@ -215,7 +215,7 @@ Delphi10S=Y FPC=Y [IsUTF16LEFile] -Desc="Checks if the given file is a UTF-16 little-endian encoded text file by examining the byte order mark at the start of the file." +DescEx="

Checks if the given file is a UTF-16 little-endian encoded text file by examining the byte order mark at the start of the file.

" Units=SysUtils,Classes Depends=IsUTF16LEStream SeeAlso=IsASCIIFile,IsUTF16BEFile,IsUTF16File,IsUTF7File,IsUTF8File,IsUTF16LEStream @@ -285,7 +285,7 @@ Delphi10S=Y FPC=Y [IsUTF8File] -Desc="Checks if the given file is a UTF-8 encoded text file by examining the byte order mark at the start of the file." +DescEx="

Checks if the given file is a UTF-8 encoded text file by examining the byte order mark at the start of the file.

" Units=SysUtils,Classes Depends=IsUTF8Stream SeeAlso=IsASCIIFile,IsUTF16BEFile,IsUTF16File,IsUTF16LEFile,IsUTF7File,IsUTF8Stream @@ -382,7 +382,7 @@ Delphi10S=Y FPC=Y [IsUnicodeFile] -Desc="Checks if a file contains Unicode UTF16 little endian encoded text." +DescEx="

Checks if a file contains Unicode UTF16 little endian encoded text.

" Extra="

It is assumed that Unicode files begin with the correct byte order mark for UTF16 little endian encoding.

Note: This function only works with files up to 2Gb. IsUTF16LEFile, which supports files larger than 2Gb, should be used in preference.

" Units=Classes,SysUtils Depends=IsUnicodeStream @@ -407,7 +407,7 @@ Delphi10S=Y FPC=Y [IsUnicodeStream] -Desc="Checks if a stream contains Unicode UTF16 little endian encoded text at the current position." +DescEx="

Checks if a stream contains Unicode UTF16 little endian encoded text at the current position.

" Extra="

It is assumed Unicode streams have the correct byte order mark for UTF16 little endian located at the current stream position.

Note: This function only works with streams up to 2Gb. IsUTF16LEStream, which supports streams larger than 2Gb, should be used in preference.

" Units=Classes SeeAlso=IsUnicodeFile,IsASCIIStream,IsUTF16BEStream,IsUTF16LEStream,IsUTF16Stream,IsUTF7Stream,IsUTF8Stream @@ -431,7 +431,7 @@ Delphi10S=Y FPC=Y [IsUTF7File] -Desc="Checks if the given file is a UTF-7 encoded text file by examining the byte order mark at the start of the file." +DescEx="

Checks if the given file is a UTF-7 encoded text file by examining the byte order mark at the start of the file.

" Extra="

Since UTF-7 uses only ASCII characters you may also want to confirm that the file is valid ASCII as well a having the correct byte order mark. You can use the IsASCIIFile snippet to check for valid ASCII.

" Units=SysUtils,Classes Depends=IsUTF7Stream diff --git a/csdb/collection/file.ini b/csdb/collection/file.ini index 85b7dc0..7f339b5 100644 --- a/csdb/collection/file.ini +++ b/csdb/collection/file.ini @@ -54,7 +54,7 @@ Delphi10S=Y FPC=Y [CreateURLShortcut] -Desc="Creates a URL shortcut file with the given name for the given URL, overwriting any existing file. An exception is raised if file can't be created." +DescEx="

Creates a URL shortcut file with the given name for the given URL, overwriting any existing file. An exception is raised if file can't be created.

" SeeAlso=IsURLShortcut,URLFromShortcut Snip=005.dat Delphi2=Y @@ -76,7 +76,7 @@ Delphi10S=Y FPC=Y [DefaultFileExt] -Desc="Adds a default extension to a file name if it has no extension but leaves the file name unchanged if it has an extension." +DescEx="

Adds a default extension to a file name if it has no extension but leaves the file name unchanged if it has an extension.

" Depends=ForceFileExt,HasFileExt SeeAlso=ForceFileExt,HasFileExt,RemoveFileExt Snip=398.dat @@ -123,7 +123,7 @@ Delphi10S=Y FPC=Y [DeleteFilesWithUndo] -Desc="Deletes a list of files and sends them all to the recycle bin. Returns True if the files were deleted successfully and False if the function fails." +DescEx="

Deletes a list of files and sends them all to the recycle bin. Returns True if the files were deleted successfully and False if the function fails.

" Extra="

If any of the listed files don't exist none will be deleted and the function will fail.

" Units=Classes,ShellAPI Depends=StringsToMultiSz @@ -148,7 +148,7 @@ Delphi10S=Y FPC=Y [DeleteFileWithUndo] -Desc="Deletes given file and sends it to recycle bin. Returns true if file deleted successfully." +DescEx="

Deletes given file and sends it to recycle bin. Returns true if file deleted successfully.

" Units=ShellAPI SeeAlso=EmptyRecycleBin,DeleteFiles,DeleteFilesWithUndo Snip=006.dat @@ -171,7 +171,7 @@ Delphi10S=Y FPC=Y [DirToPath] -Desc="Returns the given directory with a trailing backslash. If the directory already ends in backslash it is returned unchanged." +DescEx="

Returns the given directory with a trailing backslash. If the directory already ends in backslash it is returned unchanged.

" SeeAlso=PathToDir Snip=030.dat Delphi2=Y @@ -193,7 +193,7 @@ Delphi10S=Y FPC=Y [DOSToUnixPath] -Desc=Converts a DOS path to a Unix path and returns it. +DescEx="

Converts a DOS path to a Unix path and returns it.

" Units=SysUtils Snip=008.dat Delphi2=N @@ -215,7 +215,7 @@ Delphi10S=Y FPC=Y [EnsureFolders] -Desc=Ensures that the given folder and all folders on its path exist, and creates them if they do not. +DescEx="

Ensures that the given folder and all folders on its path exist, and creates them if they do not.

" Units=SysUtils Depends=PathToDir,IsDirectory SeeAlso=ListFiles @@ -239,7 +239,7 @@ Delphi10S=Y FPC=Y [FileSizeString] -Desc="Returns the size of a file as a formatted string. For files larger than 1Kb the size is approximate. If the file size can't be read then the empty string is returned." +DescEx="

Returns the size of a file as a formatted string. For files larger than 1Kb the size is approximate.

If the file size can't be read then the empty string is returned.

" Extra="

Modification of code contributed by Michael Rockett.

" Units=SysUtils Depends=SizeOfFile64 @@ -263,7 +263,7 @@ Delphi10S=Y FPC=Y [ForceFileExt] -Desc="Forces a file name to have a specified extension. If the given extension is the empty string then any existing extension is removed." +DescEx="

Forces a file name to have a specified extension.

If the given extension is the empty string then any existing extension is removed.

" Depends=RemoveFileExt SeeAlso=DefaultFileExt,HasFileExt,RemoveFileExt Snip=399.dat @@ -286,7 +286,7 @@ Delphi10S=Y FPC=Y [GetFileDate] -Desc=Returns modification date of given file encoded as integer. +DescEx="

Returns modification date of given file encoded as integer.

" Units=SysUtils SeeAlso=SetFileDate Snip=009.dat @@ -332,7 +332,7 @@ Delphi10S=Y FPC=Y [GetLastDirectory] -Desc="Returns the last directory in a specified path or the empty string if the given path is not a directory." +DescEx="

Returns the last directory in a specified path or the empty string if the given path is not a directory.

" Extra="

Modified from code contributed by Bill Miller.

" Units=SysUtils Depends=IsDirectory,PathToDir @@ -356,7 +356,7 @@ Delphi10S=Y FPC=Y [HasFileExt] -Desc="Determines if a file name has an extension. A file name ending in '.' is deemed to have an empty extension." +DescEx="

Determines if a file name has an extension. A file name ending in '.' is deemed to have an empty extension.

" Units=SysUtils SeeAlso=DefaultFileExt,ForceFileExt,RemoveFileExt Snip=400.dat @@ -379,7 +379,7 @@ Delphi10S=Y FPC=Y [HasVerInfo] -Desc=Returns true if the given file contains version information and false if not. +DescEx="

Returns true if the given file contains version information and false if not.

" Units=Windows SeeAlso=GetFixedFileVerInfo Snip=036.dat @@ -402,7 +402,7 @@ Delphi10S=Y FPC=Y [IsArchiveFile] -Desc="Checks if a file's archive attribute is set." +DescEx="

Checks if a file's archive attribute is set.

" Units=SysUtils Depends=IsFlagSet SeeAlso=IsDirectory,IsFile,IsHiddenFile,IsReadOnlyFile,IsSystemFile @@ -426,7 +426,7 @@ Delphi10S=Y FPC=Y [IsFile] -Desc="Determines if the provided path specifies a file." +DescEx="

Determines if the provided path specifies a file.

" Units=SysUtils Depends=IsFlagSet SeeAlso=IsArchiveFile,IsDirectory,IsHiddenFile,IsReadOnlyFile,IsSystemFile @@ -450,7 +450,7 @@ Delphi10S=Y FPC=Y [IsHiddenFile] -Desc="Checks if a file's hidden attribute is set." +DescEx="

Checks if a file's hidden attribute is set.

" Units=SysUtils Depends=IsFlagSet SeeAlso=IsArchiveFile,IsDirectory,IsFile,IsReadOnlyFile,IsSystemFile @@ -474,7 +474,7 @@ Delphi10S=Y FPC=Y [IsReadOnlyFile] -Desc="Checks if a file's read-only attribute is set." +DescEx="

Checks if a file's read-only attribute is set.

" Units=SysUtils Depends=IsFlagSet SeeAlso=IsArchiveFile,IsDirectory,IsFile,IsHiddenFile,IsSystemFile @@ -498,7 +498,7 @@ Delphi10S=Y FPC=Y [IsSystemFile] -Desc="Checks if a file's system attribute is set." +DescEx="

Checks if a file's system attribute is set.

" Units=SysUtils Depends=IsFlagSet SeeAlso=IsArchiveFile,IsDirectory,IsFile,IsHiddenFile,IsReadOnlyFile @@ -522,7 +522,7 @@ Delphi10S=Y FPC=Y [IsURLShortcut] -Desc=Returns true if the given file is a URL shortcut file and false if not. +DescEx="

Returns true if the given file is a URL shortcut file and false if not.

" Units=SysUtils,IniFiles SeeAlso=CreateURLShortcut,URLFromShortcut Snip=048.dat @@ -545,7 +545,7 @@ Delphi10S=Y FPC=Y [IsValidFileName] -Desc="Tests if a file name is a valid on Windows file systems." +DescEx="

Tests if a file name is a valid on Windows file systems.

" Extra="

Based on information contained in the File Names, Paths and Namespaces topic on the Microsoft Developer Network.

" Units=SysUtils Depends=SizeOfFile64 @@ -593,7 +593,7 @@ Delphi10S=Y FPC=Y [LongToShortFilePath] -Desc="Converts the given long file name to the equivalent shortened DOS style 8.3 path." +DescEx="

Converts the given long file name to the equivalent shortened DOS style 8.3 path.

" Units=Windows SeeAlso=ShortToLongFilePath Snip=074.dat @@ -616,7 +616,7 @@ Delphi10S=Y FPC=Y [PathIsRoot] -Desc="Checks if the given path is a root directory." +DescEx="

Checks if the given path is a root directory.

" Extra="

Works with UNC paths and paths with drive specifiers.

Slightly modified from code created by Steve Moss, CoCo Systems Ltd. Contributed by Bill Miller.

" Units=SysUtils Depends=DirToPath @@ -640,7 +640,7 @@ Delphi10S=Y FPC=Y [PathToDir] -Desc=Returns the given directory with any single trailing backslash removed. If the directory does not end in a backslash it is returned unchanged. +DescEx="

Returns the given directory with any single trailing backslash removed.

If the directory does not end in a backslash it is returned unchanged.

" SeeAlso=DirToPath Snip=056.dat Delphi2=Y @@ -662,7 +662,7 @@ Delphi10S=Y FPC=Y [RemoveFileExt] -Desc="Removes the extension from a file name. File name is unchanged if it has no extension." +DescEx="

Removes the extension from a file name. File name is unchanged if it has no extension.

" SeeAlso=DefaultFileExt,ForceFileExt,HasFileExt Units=SysUtils Snip=122.dat @@ -685,7 +685,7 @@ Delphi10S=Y FPC=Y [SetFileDate] -Desc=Sets modification date of given file to given integer coded value. Returns True on success and False on failure. +DescEx="

Sets modification date of given file to given integer coded value. Returns True on success and False on failure.

" Units=SysUtils SeeAlso=GetFileDate Snip=011.dat @@ -708,7 +708,7 @@ Delphi10S=Y FPC=Y [SizeOfFile64] -Desc="Gets the size of a file. Returns -1 if the file doesn't exist or can't be accessed." +DescEx="

Gets the size of a file.

Returns -1 if the file doesn't exist or can't be accessed.

" Extra="

Works with files larger than 2Gb.

" Units=SysUtils,Windows SeeAlso=SizeOfFile @@ -732,7 +732,7 @@ Delphi10S=Y FPC=Y [Touch] -Desc=Sets modification date of given file to current date and time. Returns True if date set successfully or false on error. +DescEx="

Sets modification date of given file to current date and time. Returns True if date set successfully or false on error.

" Units=SysUtils Snip=037.dat Delphi2=Y @@ -754,7 +754,7 @@ Delphi10S=Y FPC=Y [URLFromShortcut] -Desc="Returns the URL referenced by the given URL shortcut file, or the empty string if the given file is not a shortcut file." +DescEx="

Returns the URL referenced by the given URL shortcut file, or the empty string if the given file is not a shortcut file.

" Extra="

Derived from a similar function published on Torry's Delphi Pages.

" Units=IniFiles SeeAlso=CreateURLShortcut,IsURLShortcut @@ -802,7 +802,7 @@ Delphi10S=Y FPC=Y [DirPurge] -Desc="Deletes the given directory and all its files and sub-directories. If the directory does not exist then the routine returns immediately." +DescEx="

Deletes the given directory and all its files and sub-directories. If the directory does not exist then the routine returns immediately.

" Units=SysUtils Snip=563.dat Delphi2=N @@ -872,7 +872,7 @@ Delphi10S=Y FPC=Y [GetParentDirectory] -Desc="Returns the parent directory of the provided path." +DescEx="

Returns the parent directory of the provided path.

" Extra="

Modification of code from Bill Miller's snippets collection.

If APath is relative then the returned directory is relative to the current directory.

" Units=SysUtils Depends=DirToPath @@ -921,7 +921,7 @@ Delphi10S=Y FPC=Y [IsFolderEmpty] -Desc="Determines if a folder is empty. Returns True if so, False otherwise." +DescEx="

Determines if a folder is empty. Returns True if so, False otherwise.

" Extra="

Contributed by Bill Miller, with added error handling.

AFolder must be a valid directory. It can optionally have a trailing path delimiter.

" Units=SysUtils,Windows Depends=DirToPath,IsDirectory,PathToDir @@ -946,7 +946,7 @@ Delphi10S=Y FPC=N [IsHugeFile] -Desc="Checks if a file is huge, i.e. it is larger than 2Gb." +DescEx="

Checks if a file is huge, i.e. it is larger than 2Gb.

" Extra="

Use this function to determine if you can rely upon the SizeOfFile function to test the size of a file or if SizeOfFile64 must be used. SizeOfFile can only be used if IsHugeFile returns false.

" Depends=SizeOfFile64 SeeAlso=SizeOfFile,SizeOfFile64 @@ -970,7 +970,7 @@ Delphi10S=Y FPC=Y [IsReservedDeviceName] -Desc="Checks if a name is a Windows reserved device name." +DescEx="

Checks if a name is a Windows reserved device name.

" Extra="

List of reserved names taken from the File Names, Paths and Namespaces topic on the Microsoft Developer Network.

Note: Microsoft state that you should not use any of these reserved names as the name of a file. They also observe that reserved device names followed by an extension should be avoided, for example NUL.txt. To check for this use IsReservedDeviceName(RemoveFileExt(ExtractFileName(FileName)));.

" Units=SysUtils Snip=261.dat @@ -993,7 +993,7 @@ Delphi10S=Y FPC=Y [ShortToLongFilePath] -Desc="Converts whole of given DOS style 8.3 path to long file path and returns it. If path can't be converted then '' is returned." +DescEx="

Converts whole of given DOS style 8.3 path to long file path and returns it.

If path can't be converted then '' is returned.

" Extra="

Function can handle UNC paths (\\server\share\path format) or local paths (X:\path format).

" Units=SysUtils SeeAlso=LongToShortFilePath @@ -1017,7 +1017,7 @@ Delphi10S=Y FPC=Y [SizeOfFile] -Desc="Gets the size of a file. Returns $FFFFFFFF if the file doesn't exist or can't be accessed or 2^31 if file is larger than 2Gb." +DescEx="

Gets the size of a file.

Returns $FFFFFFFF if the file doesn't exist or can't be accessed or 2^31 if file is larger than 2Gb.

" Extra="

For files larger than 2Gb use SizeOfFile64.

" Units=SysUtils,Windows SeeAlso=SizeOfFile64,SizeOfFile2 @@ -1041,7 +1041,7 @@ Delphi10S=Y FPC=Y [SizeOfFile2] -Desc="Gets the size of a file. Returns 0 if the file doesn't exist or can't be accessed." +DescEx="

Gets the size of a file.

Returns 0 if the file doesn't exist or can't be accessed.

" Extra="

The file must be less that 2Gb in size. For files larger than 2Gb use SizeOfFile64.

Contributed by Montor.

" Units=SysUtils SeeAlso=SizeOfFile,SizeOfFile64 @@ -1137,7 +1137,7 @@ FPC=Y [TExeType] Kind=type -Desc="Enumeration that describes various types of executable file." +DescEx="

Enumeration that describes various types of executable file.

" Extra="

TExeType is the return type of the ExeType function.

" SeeAlso=ExeType Snip=244.dat diff --git a/csdb/collection/graphics.ini b/csdb/collection/graphics.ini index b581a3f..343bf05 100644 --- a/csdb/collection/graphics.ini +++ b/csdb/collection/graphics.ini @@ -78,7 +78,7 @@ Delphi10S=Y FPC=N [CloneCursorAsIcon] -Desc="Creates and returns an icon object that contains a copy of the given cursor." +DescEx="

Creates and returns an icon object that contains a copy of the given cursor.

" Extra="Note: The caller is responsible for freeing the icon created by this function." Units=Controls,Graphics,Forms Depends=CloneCursorHandleAsIcon @@ -128,7 +128,7 @@ Delphi10S=Y FPC=N [CloneCursorHandleAsIcon] -Desc="Creates and returns an icon object that contains a copy of the cursor with the given handle." +DescEx="

Creates and returns an icon object that contains a copy of the cursor with the given handle.

" Extra="Note: The caller is responsible for freeing the icon created by this function." Units=Windows,Graphics SeeAlso=CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsBitmap,CursorHandleToBitmap,CursorToBitmap @@ -177,7 +177,7 @@ Delphi10S=Y FPC=N [CloneJPEGAsBitmap] -Desc="Creates and returns a bitmap object that contains a copy of the given JPEG image." +DescEx="

Creates and returns a bitmap object that contains a copy of the given JPEG image.

" Extra="Note: The caller is responsible for freeing the bitmap created by this function." Units=Graphics,JPEG SeeAlso=JPEGFileToBitmapFile,CloneGraphicAsBitmap @@ -226,7 +226,7 @@ Delphi10S=Y FPC=N [ContrastingColor] -Desc="Returns a colour that contrasts well with a given background colour. The returned colour is either black or white." +DescEx="

Returns a colour that contrasts well with a given background colour. The returned colour is either black or white.

" Extra="

System colours are converted into actual colours before the foreground colour is calculated.

Adapted from code by Andreas Filsinger.

" Units=Windows,Graphics Depends=ColorToRGBTriple @@ -416,7 +416,7 @@ Delphi10S=Y FPC=N [FontExists] -Desc="Checks if a named font exists on the sytem." +DescEx="

Checks if a named font exists on the sytem.

" Units=Forms Snip=340.dat Delphi2=Y @@ -507,7 +507,7 @@ Delphi10S=Y FPC=N [IndexOfWidestString] -Desc="Returns index of longest string in a string list when rendered in a given font. Returns -1 if string list is empty." +DescEx="

Returns index of longest string in a string list when rendered in a given font. Returns -1 if string list is empty.

" Units=Classes,Graphics,Windows Depends=CreateDisplayDC SeeAlso=MaxWidthOfStrings,StringExtent @@ -531,7 +531,7 @@ Delphi10S=Y FPC=N [IsColorIcon] -Desc="Checks if given icon is colour or monochrome. Returns True if icon is in colour, False if monochrome." +DescEx="

Checks if given icon is colour or monochrome. Returns True if icon is in colour, False if monochrome.

" Units=Graphics,Windows,SysUtils SeeAlso=IsCursorIcon,GetIconHotspot,GetIconANDBitmask,GetIconXORBitmask Snip=115.dat @@ -554,7 +554,7 @@ Delphi10S=Y FPC=N [IsEqualRGBTriple] -Desc="Checks if two RGB triple values are the same." +DescEx="

Checks if two RGB triple values are the same.

" Units=Windows SeeAlso=ColorToRGBTriple,RGBTripleToColor Snip=111.dat @@ -577,7 +577,7 @@ Delphi10S=Y FPC=Y [IsGDIPlusInstalled] -Desc="Checks if the GDI+ library is installed." +DescEx="

Checks if the GDI+ library is installed.

" Depends=IsLibraryInstalled Snip=119.dat Delphi2=N @@ -646,7 +646,7 @@ Delphi10S=Y FPC=N [MaxWidthOfStrings] -Desc="Returns width of longest string in a string list when rendered in a given font." +DescEx="

Returns width of longest string in a string list when rendered in a given font.

" Extra="

Closely based code by Peter Below published by the Delphi Pool.

" Units=Classes,Graphics,Windows Depends=CreateDisplayDC @@ -791,7 +791,7 @@ Delphi10S=Y FPC=N [StringExtent] -Desc="Returns the width and height of the given string when rendered in the specified font." +DescEx="

Returns the width and height of the given string when rendered in the specified font.

" Extra="

Inspired by code by Peter Below published by the Delphi Pool.

" Units=Windows,Graphics Depends=CreateDisplayDC @@ -966,7 +966,7 @@ Delphi10S=Y FPC=N [CreateDisplayDC] -Desc="Creates and returns a display device context." +DescEx="

Creates and returns a display device context.

" Extra="

The device context must be deleted using Windows' DeleteDC function.

" Units=Windows Snip=147.dat @@ -989,7 +989,7 @@ Delphi10S=Y FPC=Y [DarkenColor] -Desc="Darkens the given colour by the given percentage and returns the resulting colour." +DescEx="

Darkens the given colour by the given percentage and returns the resulting colour.

" Extra="

Darkening a colour by 0% does not change it. Darkening by 100% or more makes the colour black.

System colours are converted to the actual colour they represent before darkening.

Inspired by code contributed by Topellina.

" Units=Windows,Graphics Depends=Clamp,ExtractRGB @@ -1014,7 +1014,7 @@ Delphi10S=Y FPC=N [GetBMPSize] -Desc="Gets the dimensions of a bitmap image stored in a file." +DescEx="

Gets the dimensions of a bitmap image stored in a file.

" Extra="

Note: for versions of Delphi that do not support the Types unit, try substituting Windows.TSize for Types.TSize.

" Units=Types,SysUtils,Classes,Windows SeeAlso=GetGIFSize,GetJPGSize,GetPNGSize @@ -1038,7 +1038,7 @@ Delphi10S=Y FPC=Y [GetGIFSize] -Desc="Gets the dimensions of a GIF image stored in a file." +DescEx="

Gets the dimensions of a GIF image stored in a file.

" Extra="

Note: for versions of Delphi that do not support the Types unit, try substituting Windows.TSize for Types.TSize.

Adapted from code submitted by Bill Miller.

" Units=Types,SysUtils,Classes SeeAlso=GetBMPSize,GetJPGSize,GetPNGSize @@ -1062,7 +1062,7 @@ Delphi10S=Y FPC=Y [GetIconHotspot] -Desc="Gets position of the given icon's hotspot." +DescEx="

Gets position of the given icon's hotspot.

" Extra="

This routine is particularly useful if the icon represents a cursor. This is done by assigning a cursor's handle the icon's Handle property.

" Units=Graphics,Windows,SysUtils SeeAlso=IsCursorIcon,IsColorIcon,GetIconANDBitmask,GetIconXORBitmask @@ -1086,7 +1086,7 @@ Delphi10S=Y FPC=N [GetJPGSize] -Desc="Gets the dimensions of a JPEG image stored in a file." +DescEx="

Gets the dimensions of a JPEG image stored in a file.

" Extra="

Note: for versions of Delphi that do not support the Types unit, try substituting Windows.TSize for Types.TSize.

Adapted from code submitted by Bill Miller.

" Units=Types,SysUtils,Classes Depends=ReadBigEndianWord @@ -1111,7 +1111,7 @@ Delphi10S=Y FPC=Y [GetPNGSize] -Desc="Gets the dimensions of a PNG image stored in a file." +DescEx="

Gets the dimensions of a PNG image stored in a file.

" Extra="

Note: for versions of Delphi that do not support the Types unit, try substituting Windows.TSize for Types.TSize.

Adapted from code submitted by Bill Miller.

" Units=Types,SysUtils,Classes Depends=ReadBigEndianWord @@ -1288,7 +1288,7 @@ Delphi10S=Y FPC=N [IsCursorIcon] -Desc="Checks if an icon represents a cursor. Returns True if icon represents a cursor or False if icon is a standard icon." +DescEx="

Checks if an icon represents a cursor. Returns True if icon represents a cursor or False if icon is a standard icon.

" Extra="

To create an icon that represent a cursor, store the cursor's handle in the icon's Handle property.

" Units=Graphics,Windows,SysUtils SeeAlso=IsColorIcon,GetIconHotspot,GetIconANDBitmask,GetIconXORBitmask @@ -1313,7 +1313,7 @@ FPC=N [IsTrueTypeFont_A] DisplayName="IsTrueTypeFont (TFont overload)" -Desc="Checks if a font is a true type font." +DescEx="

Checks if a font is a true type font.

" Units=Windows,Graphics Depends=CreateDisplayDC,IsFlagSet SeeAlso=IsTrueTypeFont_B @@ -1338,7 +1338,7 @@ FPC=N [IsTrueTypeFont_B] DisplayName="IsTrueTypeFont (string overload)" -Desc="Checks if a named font is a true type font." +DescEx="

Checks if a named font is a true type font.

" Units=Graphics Depends=IsTrueTypeFont_A SeeAlso=IsTrueTypeFont_A @@ -1380,7 +1380,7 @@ Delphi10S=Y FPC=N [LightenColor] -Desc="System colours are converted to their actual values before conversion." +DescEx="

System colours are converted to their actual values before conversion.

" Extra="

Lightening a colour by 0% does not change it. Lightening by 100% or more makes the colour white.

System colours are converted to the actual colour they represent before lightening.

Inspired by code contributed by both Topellina and Michael Rockett.

" Units=Windows,Graphics Depends=Clamp,ExtractRGB @@ -1405,7 +1405,7 @@ Delphi10S=Y FPC=N [RGBToHSB] -Desc="Converts an RGB colour to the equivalent HSV (HSB) colour." +DescEx="

Converts an RGB colour to the equivalent HSV (HSB) colour.

" Units=Windows,Math Depends=THSBColor SeeAlso=ColorToHSB @@ -1529,7 +1529,7 @@ FPC=Y [RGBQuadArray] Kind=type -Desc="A 256 element array of RGB quad values." +DescEx="

A 256 element array of RGB quad values.

" Extra="

Useful when working with 32 bit bitmap scanlines.

A similar type is used in the implementation of the Delphi Graphics unit, but is not exposed in the unit interface.

" Units=Windows SeeAlso=RGBTripleArray @@ -1554,7 +1554,7 @@ FPC=Y [RGBTripleArray] Kind=type -Desc="A 256 element array of RGB triple values." +DescEx="

A 256 element array of RGB triple values.

" Extra="

Useful when working with 24 bit bitmap scanlines.

A similar type is used in the implementation of the Delphi Graphics unit, but is not exposed in the unit interface.

" Units=Windows SeeAlso=RGBQuadArray @@ -1602,7 +1602,7 @@ FPC=Y [TGreyScaleMethod] Kind=type -Desc="Enumeration of possible methods used when coverting a bitmap to greyscale." +DescEx="

Enumeration of possible methods used when coverting a bitmap to greyscale.

" Extra="

Used in parameter lists of GreyScale overloaded routines.

Names based on the Lightness, Average and Luminosity algorithms presented in The Endeavour blog.

" SeeAlso=GreyScale_A,GreyScale_B Snip=445.dat @@ -1626,7 +1626,7 @@ FPC=Y [THSBColor] Kind=type -Desc="Record storing Hue, Saturation and Brightness colour space values." +DescEx="

Record storing Hue, Saturation and Brightness colour space values.

" SeeAlso=RGBToHSB,ColorToHSB Snip=286.dat Delphi2=Y diff --git a/csdb/collection/hex.ini b/csdb/collection/hex.ini index 68e31c4..3b6af4d 100644 --- a/csdb/collection/hex.ini +++ b/csdb/collection/hex.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [AddHexPrefix] -Desc="Adds a valid hex prefix to the given string of hex digits." +DescEx="

Adds a valid hex prefix to the given string of hex digits.

" Extra="

The hex prefix is '$' when compiled on Delphi or '0x' when compiled on C++ Builder.

" Units=SysUtils Depends=StripHexPrefix @@ -32,7 +32,7 @@ Delphi10S=Y FPC=Y [BufToHex] -Desc="Returns a hexadecimal representation of the bytes in the given buffer which has the given size." +DescEx="

Returns a hexadecimal representation of the bytes in the given buffer which has the given size.

" SeeAlso=BytesToHex,ByteToHex,LongWordToHex,QuadWordToHex,WordToHex TestInfo=advanced Snip=312.dat @@ -55,7 +55,7 @@ Delphi10S=Y FPC=Y [BytesToHex] -Desc="Returns a hexadecimal representation of the given array of bytes." +DescEx="

Returns a hexadecimal representation of the given array of bytes.

" Depends=BufToHex SeeAlso=BufToHex,ByteToHex,LongWordToHex,QuadWordToHex,WordToHex TestInfo=advanced @@ -79,7 +79,7 @@ Delphi10S=Y FPC=Y [ByteToHex] -Desc="Returns the hexadecimal representation of the given byte value." +DescEx="

Returns the hexadecimal representation of the given byte value.

" Units=SysUtils SeeAlso=BufToHex,BytesToHex,LongWordToHex,QuadWordToHex,WordToHex TestInfo=advanced @@ -103,7 +103,7 @@ Delphi10S=Y FPC=Y [LongWordToHex] -Desc="Returns the hexadecimal representation of the given long (4 byte) word value." +DescEx="

Returns the hexadecimal representation of the given long (4 byte) word value.

" Units=SysUtils SeeAlso=BufToHex,BytesToHex,ByteToHex,QuadWordToHex,WordToHex TestInfo=advanced @@ -127,7 +127,7 @@ Delphi10S=Y FPC=Y [QuadWordToHex] -Desc="Returns the hexadecimal representation of the given quad (8 byte) word value." +DescEx="

Returns the hexadecimal representation of the given quad (8 byte) word value.

" Units=SysUtils SeeAlso=BufToHex,BytesToHex,ByteToHex,LongWordToHex,WordToHex TestInfo=advanced @@ -151,7 +151,7 @@ Delphi10S=Y FPC=Y [StripHexPrefix] -Desc="Strips any prefix from the given hexadecimal string. Both Delphi ('$') and C ('0x') prefixes are supported." +DescEx="

Strips any prefix from the given hexadecimal string. Both Delphi ('$') and C ('0x') prefixes are supported.

" Units=SysUtils SeeAlso=AddHexPrefix TestInfo=advanced @@ -225,7 +225,7 @@ Delphi10S=Y FPC=Y [WordToHex] -Desc="Returns the hexadecimal representation of the given (2 byte) word value." +DescEx="

Returns the hexadecimal representation of the given (2 byte) word value.

" Units=SysUtils SeeAlso=BufToHex,BytesToHex,ByteToHex,LongWordToHex,QuadWordToHex TestInfo=advanced @@ -249,7 +249,7 @@ Delphi10S=Y FPC=Y [HexByteSize] -Desc="Returns the number of bytes represented by the given hexadecimal string." +DescEx="

Returns the number of bytes represented by the given hexadecimal string.

" Extra="

Assumes that HexStr contains only valid hex digits, optionally prefixed by '$' or '0x'.

" Depends=StripHexPrefix SeeAlso=HexToBuf @@ -274,7 +274,7 @@ Delphi10S=Y FPC=Y [HexToBuf] -Desc="Writes the bytes represented by the given hexadecimal string into the given buffer, which must be large enough to receive the data." +DescEx="

Writes the bytes represented by the given hexadecimal string into the given buffer, which must be large enough to receive the data.

" Extra="

Use HexByteSize to determine the size of buffer required. This function assumes the buffer is the correct size.

HexStr must not be empty and must contain only valid hex digits, optionally preceded by '$' or '0x'. An exception is raised if an invalid digit is encountered. A leading '0' is added to hex strings with odd length.

" Depends=TryHexToBuf SeeAlso=TryHexToBuf,HexToBytes,HexToInt,HexToInt64 @@ -299,7 +299,7 @@ Delphi10S=Y FPC=Y [HexToBytes] -Desc="Writes the bytes represented by the given hexadecimal string into an array of bytes, which is returned" +DescEx="

Writes the bytes represented by the given hexadecimal string into an array of bytes, which is returned.

" Extra="

HexStr must contain only valid hex digits, optionally prefixed by '$' or '0x' otherwise an exception is raised.

" Depends=TBytes,TryHexToBytes SeeAlso=TryHexToBytes,HexToBuf,HexToInt,HexToInt64 @@ -324,7 +324,7 @@ Delphi10S=Y FPC=Y [HexToInt] -Desc="Converts the given hexadecimal string to an integer." +DescEx="

Converts the given hexadecimal string to an integer.

" Extra="

HexStr must contain only valid hex digits, optionally prefixed by '$' or '0x' otherwise an exception is raised.

" Depends=TryHexToInt SeeAlso=TryHexToInt,HexToIntDef,HexToBuf,HexToBytes,HexToInt64 @@ -349,7 +349,7 @@ Delphi10S=Y FPC=Y [HexToInt64] -Desc="Converts the given hexadecimal string to a 64 bit integer." +DescEx="

Converts the given hexadecimal string to a 64 bit integer.

" Extra="

HexStr must contain only valid hex digits, optionally prefixed by '$' or '0x' otherwise an exception is raised.

" Depends=TryHexToInt64 SeeAlso=TryHexToInt64,HexToInt64Def,HexToBuf,HexToBytes,HexToInt @@ -374,7 +374,7 @@ Delphi10S=Y FPC=Y [HexToInt64Def] -Desc="Converts the given hexadecimal string to a 64 bit integer. If the conversion fails the specified default value is returned." +DescEx="

Converts the given hexadecimal string to a 64 bit integer. If the conversion fails the specified default value is returned.

" Extra="

HexStr may be prefixed by either '$' or '0x' or have no prefix.

" Depends=TryHexToInt64 SeeAlso=TryHexToInt64,HexToInt64,HexToIntDef @@ -399,7 +399,7 @@ Delphi10S=Y FPC=Y [HexToIntDef] -Desc="Converts the given hexadecimal string to an integer. If the conversion fails the specified default value is returned." +DescEx="

Converts the given hexadecimal string to an integer. If the conversion fails the specified default value is returned.

" Extra="

HexStr may be prefixed by either '$' or '0x' or have no prefix.

" Depends=TryHexToInt SeeAlso=TryHexToInt,HexToInt,HexToInt64Def diff --git a/csdb/collection/maths.ini b/csdb/collection/maths.ini index bb6a397..136124f 100644 --- a/csdb/collection/maths.ini +++ b/csdb/collection/maths.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [AllDigitsDifferent] -Desc="Checks if all the digits of the given integer are different to each other." +DescEx="

Checks if all the digits of the given integer are different to each other.

" Extra="

An example of an integer with all digits different is 15862.

" SeeAlso=AllDigitsSame Snip=498.dat @@ -29,7 +29,7 @@ Delphi10S=Y FPC=Y [AllDigitsSame] -Desc="Checks if all the digits of the given integer are the same." +DescEx="

Checks if all the digits of the given integer are the same.

" Extra="

An example of an integer with all digits the same is 777777.

" SeeAlso=AllDigitsDifferent,RepeatedDigits Snip=499.dat @@ -52,7 +52,7 @@ Delphi10S=Y FPC=Y [DigitCount] -Desc="Counts the number of digits in the given integer." +DescEx="

Counts the number of digits in the given integer.

" Extra="

Contributed by Bill Miller.

" SeeAlso=DigitCount2,DigitCountR TestInfo=advanced @@ -76,7 +76,7 @@ Delphi10S=Y FPC=Y [DigitCount2] -Desc="Counts the number of digits in the given integer." +DescEx="

Counts the number of digits in the given integer.

" Extra="

Based on code suggested by Don Rowlett.

" Units=Math SeeAlso=DigitCount,DigitCountR @@ -101,7 +101,7 @@ Delphi10S=Y FPC=Y [DigitCountR] -Desc="Counts the number of digits in the given integer using recursion." +DescEx="

Counts the number of digits in the given integer using recursion.

" Extra="

Contributed by Rubem Nascimento da Rocha.

" SeeAlso=DigitCount,DigitCount2 TestInfo=advanced @@ -125,7 +125,7 @@ Delphi10S=Y FPC=Y [Factorial] -Desc="Calculates the factorial of the given number." +DescEx="

Calculates the factorial of the given number.

" Extra="

Adapted from code contributed by Don Rowlett.

" Snip=231.dat Delphi2=N @@ -217,8 +217,8 @@ Delphi10S=Y FPC=Y [RectArea] -Desc="Returns the area of the given rectangle." -Commants="Adopts the convention that the rectangle's bottom and right are not included in it, so that width = right - left and height = bottom - top." +DescEx="

Returns the area of the given rectangle.

" +Extra="

Adopts the convention that the rectangle's bottom and right are not included in it, so that width = right - left and height = bottom - top.

" SeeAlso=RectHeight,RectSize,RectWidth Units=Windows Snip=496.dat @@ -315,7 +315,7 @@ Delphi10S=Y FPC=Y [RepeatedDigits] -Desc="Checks if the given integer contains only a single repeated digit." +DescEx="

Checks if the given integer contains only a single repeated digit.

" Extra="

An example of an integer with a single repeated digit is 5555.

Slightly modified from code contributed by Rubem Rocha.

" Units=SysUtils,Math SeeAlso=AllDigitsSame @@ -362,7 +362,7 @@ Delphi10S=Y FPC=Y [SignOfFloat] -Desc="Returns the sign of the given floating point value. Returns -1 if the value is positive, 0 if zero or +1 if negative." +DescEx="

Returns the sign of the given floating point value. Returns -1 if the value is positive, 0 if zero or +1 if negative.

" Extra="

Contributed by Bill Miller.

" SeeAlso=SignOfInt Snip=205.dat @@ -385,7 +385,7 @@ Delphi10S=Y FPC=Y [SignOfInt] -Desc="Returns the sign of the given integer. Returns -1 if the integer is positive, 0 if zero or +1 if negative." +DescEx="

Returns the sign of the given integer. Returns -1 if the integer is positive, 0 if zero or +1 if negative.

" Extra="

Contributed by Bill Miller.

" SeeAlso=SignOfFloat Snip=206.dat @@ -431,7 +431,7 @@ Delphi10S=Y FPC=Y [DigitSum] -Desc="Returns the sum of the digits from the given integer, using recursion." +DescEx="

Returns the sum of the digits from the given integer, using recursion.

" Extra="

Sums of digits of negative numbers are negative, for example DigitSum(-42)=-6.

Contributed Rubem Nascimento da Rocha.

" TestInfo=advanced Snip=418.dat @@ -455,7 +455,7 @@ FPC=Y [DistanceBetweenPoints_Float] DisplayName="DistanceBetweenPoints (TPointF overload)" -Desc="Calculates the distance between two given points with double precision floating point valued coordinates." +DescEx="

Calculates the distance between two given points with double precision floating point valued coordinates.

" Depends=TPointF SeeAlso=DistanceBetweenPoints_Int Units=Math @@ -480,7 +480,7 @@ FPC=Y [DistanceBetweenPoints_Int] DisplayName="DistanceBetweenPoints (TPoint overload)" -Desc="Calculates the distance between two points with integer valued co-ordinates." +DescEx="

Calculates the distance between two points with integer valued co-ordinates.

" SeeAlso=DistanceBetweenPoints_Float Units=Math,Types Snip=494.dat @@ -503,7 +503,7 @@ Delphi10S=Y FPC=Y [GCD] -Desc="Determines the greatest common divisor of two given non-zero integers." +DescEx="

Determines the greatest common divisor of two given non-zero integers.

" Extra="

Uses Euclid's method.

Note that GCD(a,b) = GCD(|a|,b) = GCD(a,|b|) = GCD(|a|,|b|), which implies that GCD(a,b) is always positive.

Modified from code by Hans van Kruijssen.

" SeeAlso=GCD2,LCD TestInfo=advanced @@ -527,7 +527,7 @@ Delphi10S=Y FPC=Y [GCD2] -Desc="Determines the greatest common divisor of two given non-zero integers." +DescEx="

Determines the greatest common divisor of two given non-zero integers.

" Extra="

Uses a recursive implementation of Euclid's method.

Note that GCD2(a,b) = GCD2(|a|,b) = GCD2(a,|b|) = GCD2(|a|,|b|), which implies that GCD2(a,b) is always positive.

Modified from code by Hans van Kruijssen.

" SeeAlso=GCD,LCD TestInfo=advanced @@ -551,7 +551,7 @@ Delphi10S=Y FPC=Y [IsPrime] -Desc="Checks if the given number is prime." +DescEx="

Checks if the given number is prime.

" Extra="

On versions of Delphi that support Int64 parameters to the Sqrt function, the type of N, Max & Divisor can be changed to Int64.

Adapted from code contributed by Don Rowlett.

" SeeAlso=IsPrime2 TestInfo=advanced @@ -575,7 +575,7 @@ Delphi10S=Y FPC=Y [IsPrime2] -Desc="Checks if the given number is prime." +DescEx="

Checks if the given number is prime.

" Extra="

Uses less code than IsPrime and does not require any floating point operations.

Contributed by daniel.

" SeeAlso=IsPrime TestInfo=advanced @@ -595,7 +595,7 @@ Delphi10S=Y FPC=Y [LCD] -Desc="Returns the least common divisor of two given non-zero integers." +DescEx="

Returns the least common divisor of two given non-zero integers.

" Extra="

Note that LCD(a,b) = LCD(|a|,b) = LCD(a,|b|) = LCD(|a|,|b|), which implies that LCD(a,b) is always positive.

Modified from code by Hans van Kruijssen.

" Depends=GCD SeeAlso=GCD,GCD2 @@ -741,7 +741,7 @@ FPC=Y [Mid_Double] DisplayName="Mid (Double overload)" -Desc="Returns the middle of three double precision floating point values." +DescEx="

Returns the middle of three double precision floating point values.

" Units=Math SeeAlso=Mid_Extended,Mid_Int64,Mid_Integer,Mid_Single,MaxOfArray_Double,MinOfArray_Double,MinMidMax_Double TestInfo=advanced @@ -766,7 +766,7 @@ FPC=Y [Mid_Extended] DisplayName="Mid (Extended overload)" -Desc="Returns the middle of three extended precision floating point values." +DescEx="

Returns the middle of three extended precision floating point values.

" Extra="

Adapted from code from Bill Miller's snippets collection.

" Units=Math SeeAlso=Mid_Double,Mid_Int64,Mid_Integer,Mid_Single,MaxOfArray_Extended,MinOfArray_Extended,MinMidMax_Extended @@ -792,7 +792,7 @@ FPC=Y [Mid_Int64] DisplayName="Mid (Int64 overload)" -Desc="Returns the middle of three 64 bit integer values." +DescEx="

Returns the middle of three 64 bit integer values.

" Units=Math SeeAlso=Mid_Double,Mid_Extended,Mid_Integer,Mid_Single,MaxOfArray_Int64,MinOfArray_Int64,MinMidMax_Int64 TestInfo=advanced @@ -817,7 +817,7 @@ FPC=Y [Mid_Integer] DisplayName="Mid (Integer overload)" -Desc="Returns the middle of three integer values." +DescEx="

Returns the middle of three integer values.

" Extra="

Adapted from code from Bill Miller's snippets collection.

" Units=Math SeeAlso=Mid_Double,Mid_Extended,Mid_Int64,Mid_Single,MaxOfArray_Integer,MinOfArray_Integer,MinMidMax_Integer @@ -843,7 +843,7 @@ FPC=Y [Mid_Single] DisplayName="Mid (Single overload)" -Desc="Returns the middle of three single precision floating point values." +DescEx="

Returns the middle of three single precision floating point values.

" Units=Math SeeAlso=Mid_Double,Mid_Extended,Mid_Int64,Mid_Integer,MaxOfArray_Single,MinOfArray_Single,MinMidMax_Single TestInfo=advanced @@ -1242,7 +1242,7 @@ Delphi10S=Y FPC=Y [ScaleRect] -Desc="Scales the given rectangle by the given scale factor and returns the scaled rectangle." +DescEx="

Scales the given rectangle by the given scale factor and returns the scaled rectangle.

" Extra="

Slightly modified from code contributed by Montor.

" Units=Types SeeAlso=ZoomRatio_A,ZoomRatio_B,ZoomRatio_C,StretchRect_A,StretchRect_B,ResizeRect_A,ResizeRect_B diff --git a/csdb/collection/multimedia.ini b/csdb/collection/multimedia.ini index dee03e1..746a661 100644 --- a/csdb/collection/multimedia.ini +++ b/csdb/collection/multimedia.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [PlaySound] -Desc="Plays sound from the given wave (.wav) file asynchronously." +DescEx="

Plays sound from the given wave (.wav) file asynchronously.

" Extra="

From Bill Miller's snippets collection.

" Units=MMSystem Snip=403.dat diff --git a/csdb/collection/shell.ini b/csdb/collection/shell.ini index 3151a85..68e8559 100644 --- a/csdb/collection/shell.ini +++ b/csdb/collection/shell.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [AddToRecentDocs] -Desc="Adds the given file to the Recent Documents folder." +DescEx="

Adds the given file to the Recent Documents folder.

" Units=ShlObj SeeAlso=ClearRecentDocs Snip=013.dat @@ -29,7 +29,7 @@ Delphi10S=Y FPC=N [ClearRecentDocs] -Desc="Clears the Recent Documents folder." +DescEx="

Clears the Recent Documents folder.

" Units=ShlObj SeeAlso=AddToRecentDocs Snip=014.dat @@ -238,7 +238,7 @@ Delphi10S=Y FPC=N [GetDesktopFolder] -Desc="Returns the path to the current user's desktop." +DescEx="

Returns the path to the current user's desktop.

" Extra="

Modified from code in Bill Miller's snippets collection.

" SeeAlso=SpecialFolderPath,CommonFilesFolder,ProgramFilesFolder,SystemFolder,TempFolder,WindowsFolder Depends=IsSpecialFolderSupported,SpecialFolderPath @@ -335,7 +335,7 @@ Delphi10S=Y FPC=N [IsShellLink] -Desc="Checks if the given file is a shell link." +DescEx="

Checks if the given file is a shell link.

" Units=ActiveX Depends=LoadShellLink SeeAlso=CreateShellLink,FileFromShellLink,LoadShellLink @@ -477,7 +477,7 @@ Delphi10S=Y FPC=N [TaskbarBounds] -Desc="Returns the bounding rectangle of the Windows taskbar, or an empty rectangle on error." +DescEx="

Returns the bounding rectangle of the Windows taskbar, or an empty rectangle on error.

" Units=Windows,ShellAPI Depends=TaskbarHandle SeeAlso=TaskbarHandle @@ -501,7 +501,7 @@ Delphi10S=Y FPC=N [TaskbarHandle] -Desc="Returns the window handle of the Windows task bar." +DescEx="

Returns the window handle of the Windows task bar.

" Extra="

Based on sample code by Michael Beck in an article formerly on Borland Code Central.

" Units=Windows SeeAlso=TaskbarBounds,TrayHandle @@ -525,7 +525,7 @@ Delphi10S=Y FPC=Y [TrayHandle] -Desc="Returns the window handle of the system tray area of the Windows task bar." +DescEx="

Returns the window handle of the system tray area of the Windows task bar.

" Units=Windows Depends=TaskbarHandle SeeAlso=TaskbarHandle @@ -573,7 +573,7 @@ Delphi10S=Y FPC=Y [IsIEInstalled] -Desc="Checks if Internet Explorer is installed on the system." +DescEx="

Checks if Internet Explorer is installed on the system.

" Extra="Contributed by Michael Rockett and renamed." Depends=ProgIDInstalled Snip=566.dat @@ -717,7 +717,7 @@ Delphi10S=Y FPC=N [TaskAllocWideString] -Desc="Copies the given string to a wide string buffer allocated by the shell's task allocator and returns a pointer to the buffer." +DescEx="

Copies the given string to a wide string buffer allocated by the shell's task allocator and returns a pointer to the buffer.

" Extra="

The buffer returned by the function must be freed using the task allocator, for example with IMalloc.Free.

" Units=Windows,ActiveX Snip=061.dat diff --git a/csdb/collection/string.ini b/csdb/collection/string.ini index 2e961e7..a7226c4 100644 --- a/csdb/collection/string.ini +++ b/csdb/collection/string.ini @@ -195,7 +195,7 @@ Delphi10S=Y FPC=Y [DOSLineBreaks] -Desc="Converts all Unix and Mac line endings in the given string to DOS line endings and returns the result." +DescEx="

Converts all Unix and Mac line endings in the given string to DOS line endings and returns the result.

" Extra="

Any existing DOS line breaks are preserved.

" Units=SysUtils SeeAlso=UnixLineBreaks @@ -243,7 +243,7 @@ Delphi10S=Y FPC=Y [IsValidDouble] -Desc="Checks if the given string represents a valid double precision floating point number." +DescEx="

Checks if the given string represents a valid double precision floating point number.

" Units=SysUtils SeeAlso=IsValidExtended,IsValidSingle Snip=454.dat @@ -266,7 +266,7 @@ Delphi10S=Y FPC=Y [IsValidExtended] -Desc="Checks if the given string represents a valid extended precision floating point number." +DescEx="

Checks if the given string represents a valid extended precision floating point number.

" Units=SysUtils SeeAlso=IsValidDouble,IsValidSingle Snip=455.dat @@ -289,7 +289,7 @@ Delphi10S=Y FPC=Y [IsValidSingle] -Desc="Checks if the given string represents a valid single precision floating point number." +DescEx="

Checks if the given string represents a valid single precision floating point number.

" Units=SysUtils SeeAlso=IsValidDouble,IsValidExtended Snip=456.dat @@ -479,7 +479,7 @@ Delphi10S=Y FPC=Y [AnsiStringToCharSet] -Desc="Creates and returns a set of all the unique characters from the given ANSI string." +DescEx="

Creates and returns a set of all the unique characters from the given ANSI string.

" Extra="

Note: This function works does not work with multi-byte ANSI strings: it assumes a character occupies exactly one byte.

" Depends=RawByteString,TCharSet Snip=363.dat @@ -567,7 +567,7 @@ Delphi10S=Y FPC=Y [CompressWhiteSpace] -Desc="Returns a copy of the given string where each sequence of one or more white space characters is replaced by a single space character." +DescEx="

Returns a copy of the given string where each sequence of one or more white space characters is replaced by a single space character.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Units=SysUtils Depends=IsWhiteSpace @@ -592,7 +592,7 @@ Delphi10S=Y FPC=Y [ContainsWhiteSpace] -Desc="Checks if the given string contains any white space." +DescEx="

Checks if the given string contains any white space.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Depends=ContainsDelims SeeAlso=ContainsDelims,CompressWhiteSpace,IsWhiteSpace,StripWhiteSpace @@ -616,7 +616,7 @@ Delphi10S=Y FPC=Y [CountWords] -Desc="Returns the number of white space delimited words in the given string." +DescEx="

Returns the number of white space delimited words in the given string.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Units=Classes Depends=ExplodeWords @@ -902,7 +902,7 @@ Delphi10S=Y FPC=Y [IsHexStr] -Desc="Checks if the given string contains only valid hex digits. Returns True if so or False otherwise." +DescEx="

Checks if the given string contains only valid hex digits. Returns True if so or False otherwise.

" Units=SysUtils Depends=IsCharInSet Snip=100.dat @@ -973,7 +973,7 @@ Delphi10S=Y FPC=Y [IsWhiteSpace] -Desc="Checks if the given character is white space." +DescEx="

Checks if the given character is white space.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Units=SysUtils SeeAlso=CompressWhiteSpace,ContainsWhiteSpace,StripWhiteSpace @@ -1089,7 +1089,7 @@ Delphi10S=Y FPC=Y [ReverseStr] -Desc="Returns the reverse of the given string." +DescEx="

Returns the reverse of the given string.

" Extra="

Renamed from a routine contributed by Rubem Nascimento da Rocha.

" Units=SysUtils,StrUtils SeeAlso=ReverseStrR @@ -1114,7 +1114,7 @@ Delphi10S=Y FPC=Y [ReverseStrR] -Desc="Returns the reverse of the given string." +DescEx="

Returns the reverse of the given string.

" Extra="

Uses recursion.

Renamed from a routine contributed by Rubem Nascimento da Rocha.

" Units=SysUtils,StrUtils SeeAlso=ReverseStr @@ -1374,7 +1374,7 @@ Delphi10S=Y FPC=Y [UnixLineBreaks] -Desc="Converts all DOS and Mac line endings in the given string to Unix line endings and returns the result." +DescEx="

Converts all DOS and Mac line endings in the given string to Unix line endings and returns the result.

" Extra="

Any existing Unix line breaks are preserved.

" Units=SysUtils SeeAlso=DOSLineBreaks @@ -1645,7 +1645,7 @@ Delphi10S=Y FPC=Y [StripWhiteSpace] -Desc="Removes all white space from the given string and returns the result." +DescEx="

Removes all white space from the given string and returns the result.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Units=SysUtils Depends=IsWhiteSpace @@ -1670,7 +1670,7 @@ Delphi10S=Y FPC=Y [TitleCase] -Desc="Converts the given string to title case and returns the result." +DescEx="

Converts the given string to title case and returns the result.

" Extra="

This function assumes the use of the English language.

True title case should ignore minor words, like "and" and "the" but this function, like many others, doesn't do that.

" Units=SysUtils Depends=IsWhiteSpace,IsCharInSet @@ -1694,7 +1694,7 @@ Delphi10S=Y FPC=Y [WordCount] -Desc="Returns the number of white space delimited words in the given string." +DescEx="

Returns the number of white space delimited words in the given string.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Units=SysUtils Depends=CountDelims,CompressWhiteSpace diff --git a/csdb/collection/structs.ini b/csdb/collection/structs.ini index 59a1421..d65ac3a 100644 --- a/csdb/collection/structs.ini +++ b/csdb/collection/structs.ini @@ -119,7 +119,7 @@ FPC=Y [TPointF] Kind=type -Desc="Encapsulates a point with double precision floating point coordinates." +DescEx="

Encapsulates a point with double precision floating point coordinates.

" SeeAlso=PointF,TRectF Snip=489.dat Delphi2=Y @@ -142,7 +142,7 @@ FPC=Y [TRange] Kind=type -Desc="Encapsulates the upper and lower bounds of a range of values." +DescEx="

Encapsulates the upper and lower bounds of a range of values.

" SeeAlso=Range SeeAlso=Range,TRangeEx Snip=579.dat @@ -161,7 +161,7 @@ FPC=Y [TRectF] Kind=type -Desc="Encapsulates a rectangle with double precision floating point size and position." +DescEx="

Encapsulates a rectangle with double precision floating point size and position.

" SeeAlso=RectF,BoundsF,TPointF Depends=TPointF Snip=490.dat @@ -185,7 +185,7 @@ FPC=Y [TRangeEx] Kind=class -Desc="Encapsulates a range of integers with a methods to test whether a value falls within the range and to adjust the value to fit." +DescEx="

Encapsulates a range of integers with a methods to test whether a value falls within the range and to adjust the value to fit.

" Units=Math SeeAlso=Range,TRange Snip=578.dat diff --git a/csdb/collection/sys.ini b/csdb/collection/sys.ini index 9352341..c0bb59d 100644 --- a/csdb/collection/sys.ini +++ b/csdb/collection/sys.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [DebuggerPresent] -Desc="Indicates whether the calling process is running within a debugger." +DescEx="

Indicates whether the calling process is running within a debugger.

" Extra="

Contributed by DennisLV.

" Units=Windows Snip=136.dat @@ -29,7 +29,7 @@ Delphi10S=Y FPC=Y [Delay] -Desc="Delays processing for the given number of milliseconds without processing any messages." +DescEx="

Delays processing for the given number of milliseconds without processing any messages.

" Extra="

This routine is aimed at console applications and threads that have no message queue. Normal GUI applications should not use this routine.

Modified in line with Pause routine per suggestions by Montor.

" Units=Windows SeeAlso=Pause @@ -53,7 +53,7 @@ Delphi10S=Y FPC=Y [EmptyKeyQueue] -Desc="Empties all keyboard messages from the message queue of any window belonging to the current thread." +DescEx="

Empties all keyboard messages from the message queue of any window belonging to the current thread.

" Extra="

Contributed by DennisLV.

" Units=Windows,Messages SeeAlso=SendKeysToWindow @@ -77,7 +77,7 @@ Delphi10S=Y FPC=Y [GetBiosVendor] -Desc="Returns the name of the computer's BIOS vendor." +DescEx="

Returns the name of the computer's BIOS vendor.

" Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetProcessorIdentifier,GetProcessorName,GetSystemManufacturer,GetSystemProductName @@ -170,7 +170,7 @@ Delphi10S=Y FPC=N [GetProcessorIdentifier] -Desc="Returns the identifier of the computer's processor." +DescEx="

Returns the identifier of the computer's processor.

" Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorName,GetSystemManufacturer,GetSystemProductName @@ -194,7 +194,7 @@ Delphi10S=Y FPC=Y [GetProcessorName] -Desc="Return the name of the computer's processor." +DescEx="

Return the name of the computer's processor.

" Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorIdentifier,GetSystemManufacturer,GetSystemProductName @@ -218,7 +218,7 @@ Delphi10S=Y FPC=Y [GetSystemManufacturer] -Desc="Returns the name of the computer's manufacturer." +DescEx="

Returns the name of the computer's manufacturer.

" Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorIdentifier,GetProcessorName,GetSystemProductName @@ -242,7 +242,7 @@ Delphi10S=Y FPC=Y [GetSystemProductName] -Desc="Returns the system product name." +DescEx="

Returns the system product name.

" Extra="

Contributed by Bill Miller.

" Units=Windows,Registry SeeAlso=GetBiosVendor,GetProcessorIdentifier,GetProcessorName,GetSystemManufacturer @@ -336,7 +336,7 @@ Delphi10S=Y FPC=Y [HostIPAddress] -Desc="Detects and returns the machine's local IP address, or 0.0.0.0 if the address is not found." +DescEx="

Detects and returns the machine's local IP address, or 0.0.0.0 if the address is not found.

" Extra="

Contributed by DennisLV.

" Units=SysUtils,Windows,WinSock Snip=108.dat @@ -359,7 +359,7 @@ Delphi10S=Y FPC=Y [IsAdmin] -Desc="Checks if the current user has administrator privileges." +DescEx="

Checks if the current user has administrator privileges.

" Extra="

Contributed by Rubem Nascimento da Rocha.

" Units=Windows Snip=404.dat @@ -428,7 +428,7 @@ Delphi10S=Y FPC=Y [IsRunningOnBattery] -Desc="Checks if the computer is running on battery power and returns True if so or False when running on mains or if the power status is unknown." +DescEx="

Checks if the computer is running on battery power and returns True if so or False when running on mains or if the power status is unknown.

" Extra="

Based on code published on the Delphi FAQ.

" Units=Windows SeeAlso=RemainingBatteryPercent @@ -477,7 +477,7 @@ Delphi10S=Y FPC=Y [ProgramFileName] -Desc="Returns the executing program's file name." +DescEx="

Returns the executing program's file name.

" Units=SysUtils Depends=ProgramFileSpec SeeAlso=ProgramFileSpec,ProgramName,ProgramPath @@ -501,7 +501,7 @@ Delphi10S=Y FPC=Y [ProgramFileSpec] -Desc=Returns the fully specified path and file name of the executing program. +DescEx="

Returns the fully specified path and file name of the executing program.

" Extra="

Based on code suggested by Alan Bailey.

" SeeAlso=ProgramFileName,ProgramPath,ProgramName Snip=104.dat @@ -524,7 +524,7 @@ Delphi10S=Y FPC=Y [ProgramName] -Desc="Returns the name of the executing program (i.e. the program file name minus its extension)." +DescEx="

Returns the name of the executing program (i.e. the program file name minus its extension).

" Depends=ProgramFileName,RemoveFileExt SeeAlso=ProgramFileSpec,ProgramFileName,ProgramPath Snip=107.dat @@ -547,7 +547,7 @@ Delphi10S=Y FPC=Y [ProgramPath] -Desc="Returns the directory containing the executing program." +DescEx="

Returns the directory containing the executing program.

" Extra="

Based on code suggested by Alan Bailey.

" Units=SysUtils Depends=ProgramFileSpec @@ -572,7 +572,7 @@ Delphi10S=Y FPC=Y [RemainingBatteryPercent] -Desc="Returns remaining battery life as a percentage (0..100), or -1 if the remaining battery life is unknown." +DescEx="

Returns remaining battery life as a percentage (0..100), or -1 if the remaining battery life is unknown.

" Extra="

Based on code published on the Delphi FAQ.

" Units=Windows SeeAlso=IsRunningOnBattery @@ -644,7 +644,7 @@ Delphi10S=Y FPC=Y [CurrentMemoryUsage] -Desc="Gets the current application memory usage or 0 on error." +DescEx="

Gets the current application memory usage or 0 on error.

" Extra="

Note: According to MSDN this function requires Windows 2000 as a minimum. The PsAPI unit loads GetProcessMemoryInfo dynamically so that there is no catastrophic error on earlier OSs: CurrentMemoryUsage will quietly return 0.

Contributed by EX4.

" SeeAlso=TrimAppMemorySize Units=SysUtils,Windows,PsAPI @@ -786,7 +786,7 @@ Delphi10S=Y FPC=N [GetDefaultPrinterName] -Desc="Returns the name of the default printer or empty string if there is no default printer." +DescEx="

Returns the name of the default printer or empty string if there is no default printer.

" Units=Printers Snip=562.dat Delphi2=Y @@ -808,7 +808,7 @@ Delphi10S=Y FPC=N [GetEnvironmentBlockSize] -Desc="Returns the size of the current process' environment block, in characters." +DescEx="

Returns the size of the current process' environment block, in characters.

" Extra="

Note: This routine returns the number of characters of data in the environment block, not the number of bytes. To get the number of bytes in the block, multiply the retuned value by SizeOf(Char).

" SeeAlso=GetAllEnvVars,GetEnvVar,SetEnvVar,SetEnvVarValue,DeleteEnvVar Units=SysUtils,Windows @@ -845,7 +845,7 @@ Delphi10S=Y FPC=Y [GetErrorMessageWithId] -Desc="Returns an error message string, in the current user's default language, that corresponds to the given OS error code. If the error code is zero, the empty string is returned." +DescEx="

Returns an error message string, in the current user's default language, that corresponds to the given OS error code. If the error code is zero, the empty string is returned.

" Extra="

This routine is identical to SysUserErrorMessage except when OSErrorCode is 0, when SysUserErrorMessage returns a message and GetLastErrorMessageWithId returns the empty string.

Derived from code contributed by Johan Keizer.

" Depends=SysUserErrorMessage SeeAlso=SysUserErrorMessage @@ -864,7 +864,7 @@ Delphi10S=Y FPC=Y [GetMacAddress] -Desc="Returns the MAC address of the first ethernet adapter on the computer or the empty string if there is no adapter or if the function fails." +DescEx="

Returns the MAC address of the first ethernet adapter on the computer or the empty string if there is no adapter or if the function fails.

" Extra="

Warning 1: Does not work on Windows Vista, Windows 2008 Server or later. This code depends on Netbios which is not supported on these OSs.

Warning 2: According to MSDN this code may not work reliably on the Windows 9x platform.

" Units=SysUtils,Windows,Nb30 Snip=090.dat @@ -925,7 +925,7 @@ Delphi10S=Y FPC=N [IsAppResponding] -Desc="Checks if the application that owns the window with the given handle is responding (returns True), or hung (returns False)." +DescEx="

Checks if the application that owns the window with the given handle is responding (returns True), or hung (returns False).

" Extra="

Exceptions are raised if the window handle is not valid or if the required API functions can't be loaded.

The code uses different User32 functions for Windows 95 and Windows NT - IsHungThread is used on Windows 9x and IsHungAppWindow on Windows NT.

" Units=SysUtils,Windows Depends=GetWindowThreadID,IsWinNT @@ -996,7 +996,7 @@ Delphi10S=Y FPC=Y [ProcessMessages] -Desc="Processes all the messages a program's message queue." +DescEx="

Processes all the messages a program's message queue.

" Extra="

Can be used as light weight replacement for Application.ProcessMessages.

Conributed by Joe Donth.

" Units=Windows,Messages Snip=143.dat @@ -1019,7 +1019,7 @@ Delphi10S=Y FPC=Y [RefreshEnvironment] -Desc="Notifies all windows that the system environment variables have been changed." +DescEx="

Notifies all windows that the system environment variables have been changed.

" Extra="

If you modify environment variables in the registry the rest of the system will not notice unless you notify them. Use this routine to do that.

Note: You must change environment variables in the registry for the changes to have a global effect - changing your own application's environment won't work.

Contributed by Michael Rockett. Adapted for 64 bit by DelphiDabbler.

" Units=Windows,Messages @@ -1082,7 +1082,7 @@ Delphi10S=Y FPC=Y [SysUserErrorMessage] -Desc="Returns an error message string, in the current user's default language, that corresponds to the given OS error code." +DescEx="

Returns an error message string, in the current user's default language, that corresponds to the given OS error code.

" Extra="

This routine is identical to GetLastErrorMessageWithId except when OSErrorCode is 0, when SysUserErrorMessage returns a message and GetLastErrorMessageWithId returns the empty string.

Closely based on code contributed by Johan Keizer.

" SeeAlso=GetErrorMessageWithId Units=SysUtils,Windows @@ -1119,7 +1119,7 @@ Delphi10S=Y FPC=Y [TrimAppMemorySize] -Desc="Trims the application's working set to its minimum size." +DescEx="

Trims the application's working set to its minimum size.

" Extra="

This routine temporarily trims the application's working set size to zero. This effectively means the process is swapped out of physical RAM.

Note: This routine requires the correct privileges to succeed on Windows NT operating systems. See the MSDN documentation for SetProcessWorkingSetSize for details.

Slightly modified from code contributed by Shlomo Abuisak.

" SeeAlso=CurrentMemoryUsage Units=Windows diff --git a/csdb/collection/utils.ini b/csdb/collection/utils.ini index bda56c0..cb86289 100644 --- a/csdb/collection/utils.ini +++ b/csdb/collection/utils.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [BytesToGB] -Desc="Converts the given number of bytes to gigabytes." +DescEx="

Converts the given number of bytes to gigabytes.

" SeeAlso=BytesToGBStr,BytesToKB,BytesToMB Snip=295.dat Delphi2=N @@ -51,7 +51,7 @@ Delphi10S=Y FPC=Y [BytesToKB] -Desc="Converts the given number of bytes to kilobytes." +DescEx="

Converts the given number of bytes to kilobytes.

" SeeAlso=BytesToKBStr,BytesToMB,BytesToGB Snip=297.dat Delphi2=N @@ -96,7 +96,7 @@ Delphi10S=Y FPC=Y [BytesToMB] -Desc="Converts the given number of bytes to megabytes." +DescEx="

Converts the given number of bytes to megabytes.

" SeeAlso=BytesToMBStr,BytesToKB,BytesToGB Snip=299.dat Delphi2=N @@ -184,7 +184,7 @@ Delphi10S=Y FPC=Y [EndianSwap] -Desc="Swaps the given cardinal value between little endian and big endian format, and vica versa, and returns the result." +DescEx="

Swaps the given cardinal value between little endian and big endian format, and vica versa, and returns the result.

" Extra="

Contributed by Montor.

" Snip=293.dat Delphi2=Y @@ -206,7 +206,7 @@ Delphi10S=Y FPC=Y [ExchangeInt] -Desc="Exchanges the values of two given integers." +DescEx="

Exchanges the values of two given integers.

" Snip=123.dat Delphi2=Y Delphi3=Y @@ -296,7 +296,7 @@ Delphi10S=Y FPC=Y [IntToNumberText] -Desc="Returns the English text representation of the given integer." +DescEx="

Returns the English text representation of the given integer.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=SysUtils SeeAlso=FloatToNumberText,IntToRoman @@ -435,7 +435,7 @@ Delphi10S=Y FPC=Y [ReadBigEndianWord] -Desc="Reads and returns a word value from the given stream in big-endian format." +DescEx="

Reads and returns a word value from the given stream in big-endian format.

" Units=Classes Snip=219.dat Delphi2=Y @@ -527,7 +527,7 @@ Delphi10S=Y FPC=Y [CheckBDEInstalled] -Desc="Checks if the BDE is installed." +DescEx="

Checks if the BDE is installed.

" Extra="

Warning: Some editions of Delphi (e.g. Delphi 6 personal) do not provide the BDE unit, and so the routine will not compile on them.

Contributed by mdeltas.

" Units=BDE Snip=256.dat @@ -574,7 +574,7 @@ FPC=N [Exchange_Byte] DisplayName="Exchange (Byte overload)" -Desc="Exchanges the values of two given unsigned 8 bit integers." +DescEx="

Exchanges the values of two given unsigned 8 bit integers.

" SeeAlso=Exchange_Int64,Exchange_Longint,Exchange_Longword,Exchange_Shortint,Exchange_Smallint,Exchange_UInt64,Exchange_Word Snip=459.dat Delphi2=N @@ -597,7 +597,7 @@ FPC=Y [Exchange_Int64] DisplayName="Exchange (Int64 overload)" -Desc="Exchanges the values of two given signed 64 bit integers." +DescEx="

Exchanges the values of two given signed 64 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Longint,Exchange_Longword,Exchange_Shortint,Exchange_Smallint,Exchange_UInt64,Exchange_Word Snip=460.dat Delphi2=N @@ -620,7 +620,7 @@ FPC=Y [Exchange_Longint] DisplayName="Exchange (Longint overload)" -Desc="Exchanges the values of two given signed 32 bit integers." +DescEx="

Exchanges the values of two given signed 32 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Int64,Exchange_Longword,Exchange_Shortint,Exchange_Smallint,Exchange_UInt64,Exchange_Word,ExchangeInt. Snip=461.dat Delphi2=N @@ -643,7 +643,7 @@ FPC=Y [Exchange_Longword] DisplayName="Exchange (Longword overload)" -Desc="Exchanges the values of two given unsigned 32 bit integers." +DescEx="

Exchanges the values of two given unsigned 32 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Int64,Exchange_Longint,Exchange_Shortint,Exchange_Smallint,Exchange_UInt64,Exchange_Word Snip=462.dat Delphi2=N @@ -666,7 +666,7 @@ FPC=Y [Exchange_Shortint] DisplayName="Exchange (Shortint overload)" -Desc="Exchanges the values of two given signed 8 bit integers." +DescEx="

Exchanges the values of two given signed 8 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Int64,Exchange_Longint,Exchange_Longword,Exchange_Smallint,Exchange_UInt64,Exchange_Word Snip=463.dat Delphi2=N @@ -689,7 +689,7 @@ FPC=Y [Exchange_Smallint] DisplayName="Exchange (Smallint overload)" -Desc="Exchanges the values of two given signed 16 bit integers." +DescEx="

Exchanges the values of two given signed 16 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Int64,Exchange_Longint,Exchange_Longword,Exchange_Shortint,Exchange_UInt64,Exchange_Word Snip=464.dat Delphi2=N @@ -712,7 +712,7 @@ FPC=Y [Exchange_UInt64] DisplayName="Exchange (UInt64 overload)" -Desc="Exchanges the values of two given unsigned 64 bit integers." +DescEx="

Exchanges the values of two given unsigned 64 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Int64,Exchange_Longint,Exchange_Longword,Exchange_Shortint,Exchange_Smallint,Exchange_Word Snip=465.dat Delphi2=N @@ -735,7 +735,7 @@ FPC=Y [Exchange_Word] DisplayName="Exchange (Word overload)" -Desc="Exchanges the values of two given unsigned 16 bit integers." +DescEx="

Exchanges the values of two given unsigned 16 bit integers.

" SeeAlso=Exchange_Byte,Exchange_Int64,Exchange_Longint,Exchange_Longword,Exchange_Shortint,Exchange_Smallint,Exchange_UInt64 Snip=466.dat Delphi2=N @@ -861,7 +861,7 @@ Delphi10S=Y FPC=N [FractionToStr] -Desc="Converts a fraction expressed as a numerator and denominator to a string." +DescEx="

Converts a fraction expressed as a numerator and denominator to a string.

" Extra="

From Bill Miller's snippets collection.

" Units=SysUtils SeeAlso=FractionToStrEx,NormaliseFractionSign @@ -1018,7 +1018,7 @@ Delphi10S=Y FPC=Y [ProgIDInstalled] -Desc="Checks if the given program identifier is known to the system, i.e. is installed." +DescEx="

Checks if the given program identifier is known to the system, i.e. is installed.

" Extra="

Example: if ProgIdInstalled('InternetExplorer.Application') then ...

Contributed by Michael Rockett.

" Units=ActiveX Snip=331.dat diff --git a/csdb/collection/wb.ini b/csdb/collection/wb.ini index 1b21d79..e2a5ef5 100644 --- a/csdb/collection/wb.ini +++ b/csdb/collection/wb.ini @@ -183,7 +183,7 @@ Delphi10S=Y FPC=N [WBIsDOMLoaded] -Desc="Checks if the given web browser control contains a valid document that supports the DOM." +DescEx="

Checks if the given web browser control contains a valid document that supports the DOM.

" Extra="Examples of document types that support the DOM are HTML and XML. This routine is a combination of versions of the same code contributed by Bill Miller and Peter Johnson." SeeAlso=WBWaitForDocToLoad,WBWaitForDOMToLoad Units=SysUtils,SHDocVw,MSHTML @@ -203,7 +203,7 @@ FPC=N [WBNavigate_A] DisplayName="WBNavigate (basic version)" -Desc="Loads the document with the given URL into the given browser control and waits for the document to load." +DescEx="

Loads the document with the given URL into the given browser control and waits for the document to load.

" Extra="

Inspired by code contributed by Bill Miller.

" SeeAlso=WBBlankDocument,WBNavigate_B Depends=WBWaitForDocToLoad @@ -324,7 +324,7 @@ Delphi10S=Y FPC=N [WBShowFindDlg] -Desc="Displays the given web browser control's Find dialogue box to enable the currently loaded document to be searched." +DescEx="

Displays the given web browser control's Find dialogue box to enable the currently loaded document to be searched.

" Extra="

Some document types do not support this command. In those cases nothing will be displayed.

Slightly modified from code contributed by Bill Miller.

" SeeAlso=WBShowPageSetupDlg,WBShowPrintDlg,WBShowPrintPreviewDlg,WBShowPropertiesDlg,WBShowSourceCode Depends=WBInvokeCmd_B @@ -344,7 +344,7 @@ Delphi10S=Y FPC=N [WBShowPageSetupDlg] -Desc="Displays the given browser control's Page Setup dialogue box to provide print options for the currently loaded document." +DescEx="

Displays the given browser control's Page Setup dialogue box to provide print options for the currently loaded document.

" Extra="

Some document types do not support this command. In those cases nothing will be displayed.

Modified from code contributed by Bill Miller.

" SeeAlso=WBShowFindDlg,WBShowPrintDlg,WBShowPrintPreviewDlg,WBShowPropertiesDlg,WBShowSourceCode Depends=WBInvokeCmd_B @@ -364,7 +364,7 @@ Delphi10S=Y FPC=N [WBShowPrintDlg] -Desc="Displays the given web browser control's Print dialogue box to enable any currently loaded document to be printed." +DescEx="

Displays the given web browser control's Print dialogue box to enable any currently loaded document to be printed.

" Extra="

The print dialogue box can be used for any type of document that the browser control knows how to print. The appearance of the dialogue box may change, depending on the document type.

Modified from code contributed by Bill Miller.

" SeeAlso=WBShowFindDlg,WBShowPageSetupDlg,WBShowPrintPreviewDlg,WBShowPropertiesDlg,WBShowSourceCode Depends=WBInvokeCmd_B @@ -384,7 +384,7 @@ Delphi10S=Y FPC=N [WBShowPrintPreviewDlg] -Desc="Displays the given web browser control's Print Preview dialogue box displaying a preview of the currently loaded document." +DescEx="

Displays the given web browser control's Print Preview dialogue box displaying a preview of the currently loaded document.

" Extra="

Some document types do not support this command. In those cases nothing will be displayed.

Modified from code contributed by Bill Miller.

" SeeAlso=WBShowFindDlg,WBShowPageSetupDlg,WBShowPrintDlg,WBShowPropertiesDlg,WBShowSourceCode Depends=WBInvokeCmd_B @@ -404,7 +404,7 @@ Delphi10S=Y FPC=N [WBShowPropertiesDlg] -Desc="Displays the given webbrowser control's Properties dialogue box containing details of the currently loaded document." +DescEx="

Displays the given webbrowser control's Properties dialogue box containing details of the currently loaded document.

" Extra="

Some document types do not support this command. In those cases nothing will be displayed.

Inspired by code contributed by Bill Miller.

" SeeAlso=WBShowFindDlg,WBShowPageSetupDlg,WBShowPrintDlg,WBShowPrintPreviewDlg,WBShowSourceCode Depends=WBInvokeCmd_B @@ -424,7 +424,7 @@ Delphi10S=Y FPC=N [WBShowSourceCode] -Desc="Displays the source code of the document currently loaded in the given web browser control." +DescEx="

Displays the source code of the document currently loaded in the given web browser control.

" Extra="

The source code is displayed in Internet Explorer's default editor.

This command is not valid for all document types: in those cases no dialogue box will appear.

Slightly modified from code contributed by Bill Miller.

" SeeAlso=WBShowFindDlg,WBShowPageSetupDlg,WBShowPrintDlg,WBShowPrintPreviewDlg,WBShowPropertiesDlg Depends=WBInvokeCmd_B diff --git a/csdb/collection/web.ini b/csdb/collection/web.ini index db96d6d..7f7df11 100644 --- a/csdb/collection/web.ini +++ b/csdb/collection/web.ini @@ -52,7 +52,7 @@ Delphi10S=Y FPC=N [DownloadURLToFile] -Desc="Downloads the contents of a file at the specified URL and stores in the given local file. Returns True if the download succeeds and False on failure." +DescEx="

Downloads the contents of a file at the specified URL and stores in the given local file. Returns True if the download succeeds and False on failure.

" Extra="

A connection to the internet must be open for the download to succeed.

" Units=UrlMon,Windows,SysUtils SeeAlso=IsValidURLProtocol @@ -76,7 +76,7 @@ Delphi10S=Y FPC=Y [GetIEVersionStr] -Desc="The the version of Internet Explorer installed on the computer. Returns '' if IE is not installed or if it is earlier than v4." +DescEx="

The the version of Internet Explorer installed on the computer. Returns '' if IE is not installed or if it is earlier than v4.

" Units=Windows,Registry Snip=266.dat Delphi2=N @@ -98,7 +98,7 @@ Delphi10S=Y FPC=Y [IsValidURLProtocol] -Desc="Checks if the given URL is valid per RFC1738. Returns True if valid and False if not." +DescEx="

Checks if the given URL is valid per RFC1738. Returns True if valid and False if not.

" Units=SysUtils SeeAlso=BrowseURL,DownloadURLToFile Snip=024.dat @@ -144,7 +144,7 @@ Delphi10S=Y FPC=Y [ExtractURIFragment] -Desc="Returns any fragment component of the given URI. Returns the empty string if the URI has no fragment." +DescEx="

Returns any fragment component of the given URI. Returns the empty string if the URI has no fragment.

" Extra="

Fragments appear at the end of a URI and begin with a '#'character, which is not included in the return value.

Note: Unexpected results may occur if the URI is malformed or is not properly URI encoded.

" Units=SysUtils SeeAlso=ExtractURIQueryString,RemoveURIFragment @@ -168,7 +168,7 @@ Delphi10S=Y FPC=Y [ExtractURIQueryString] -Desc="Returns any query string component of a given URI. Returns the empty string if the URI has no query string." +DescEx="

Returns any query string component of a given URI. Returns the empty string if the URI has no query string.

" Extra="

Query strings begin with the '?' character, which is not included in the return value. A query string may be followed by a fragment, which begins with '#'. Fragments are not included in the returned query string.

Note: Unexpected results may occur if the URI is malformed or if the query string is not properly URI encoded.

" Units=SysUtils SeeAlso=ExtractURIFragment,RemoveURIQueryString @@ -192,7 +192,7 @@ Delphi10S=Y FPC=Y [IsInternetConnected] -Desc="Checks if a computer is connected to the internet." +DescEx="

Checks if a computer is connected to the internet.

" Extra="

A return value of True indicates that at least a connection to the Internet is available. It doesn't guarantee that a connection to a specific host can be established. For more information see the InternetGetConnectedState documentation on MSDN.

NOTE: This function has been found to be unreliable on some operating systems. Please see the alternative CheckInternetConnection routine.

" Units=Windows,WinInet SeeAlso=CheckInternetConnection @@ -216,7 +216,7 @@ Delphi10S=Y FPC=Y [MakeSafeHTMLText] -Desc="Replaces any characters in the given text that are not HTML-compatible with suitable escaped versions and returns the modified string." +DescEx="

Replaces any characters in the given text that are not HTML-compatible with suitable escaped versions and returns the modified string.

" Extra="

Warning: This function was designed in the expectation that the output HTML would be ANSI or ASCII encoded. Therefore so all characters above ASCII 126 are encoded as character entities containing character codes. This may cause problems where Unicode (inc UTF-8) encoded HTML is expected since the character codes may not map correctly in those encodings.

" Units=SysUtils SeeAlso=URIEncode @@ -240,7 +240,7 @@ Delphi10S=Y FPC=Y [RemoveURIFragment] -Desc="Removes any fragment part from the end of the given URI and returns the result. The URI is returned unchanged if it has no fragment." +DescEx="

Removes any fragment part from the end of the given URI and returns the result. The URI is returned unchanged if it has no fragment.

" Extra="

Fragments appear at the end of a URI and begin with a '#'character.

Note: Unexpected results may occur if the URI is malformed or is not properly URI encoded.

" Units=SysUtils SeeAlso=ExtractURIFragment,RemoveURIQueryString @@ -264,7 +264,7 @@ Delphi10S=Y FPC=Y [RemoveURIQueryString] -Desc="Removes any query string from the given URI and returns the result. The URI is returned unchanged if it has no query string." +DescEx="

Removes any query string from the given URI and returns the result. The URI is returned unchanged if it has no query string.

" Extra="

Query strings begin with the '?' character. A query string may be followed by a fragment, which begins with a '#'.

Note: Unexpected results may occur if the query string is malformed or is not properly URI encoded.

" Units=SysUtils SeeAlso=ExtractURIQueryString,RemoveURIFragment @@ -336,7 +336,7 @@ Delphi10S=Y FPC=Y [URLDecode] -Desc="Decodes the given encoded URL or URL query string. Raises an exception if the encoded URL is badly formed." +DescEx="

Decodes the given encoded URL or URL query string. Raises an exception if the encoded URL is badly formed.

" Extra="

Note: Where possible you should used URIDecode in preference to this snippet because URIDecode is fully standards compliant whereas this snippet is not.

Derived from a similar function published on Torry's Delphi Pages.

" Units=SysUtils SeeAlso=URIDecode,URIEncode,URLEncode diff --git a/csdb/collection/windows.ini b/csdb/collection/windows.ini index d2a07cb..16d96f4 100644 --- a/csdb/collection/windows.ini +++ b/csdb/collection/windows.ini @@ -53,7 +53,7 @@ Delphi10S=Y FPC=N [DisableLayersSupport] -Desc="Disables layers (transparency) support for the window with the given handle." +DescEx="

Disables layers (transparency) support for the window with the given handle.

" Units=Windows SeeAlso=EnableLayersSupport,WindowSupportsLayers Snip=283.dat @@ -76,7 +76,7 @@ Delphi10S=Y FPC=Y [DisableTreeViewToolTips] -Desc="Disables the tool tips that are displayed in the given treeview control when the mouse is hovered over an item that is cropped because it is too large to display." +DescEx="

Disables the tool tips that are displayed in the given treeview control when the mouse is hovered over an item that is cropped because it is too large to display.

" Extra="

This routine is of use with earlier versions of Delphi in which the tree view component does not have a property to switch tool tips on and off.

" Units=Windows,ComCtrls,CommCtrl Snip=507.dat @@ -123,7 +123,7 @@ Delphi10S=Y FPC=Y [GetIdleTime] -Desc="Returns the time ellapsed since the last user input." +DescEx="

Returns the time ellapsed since the last user input.

" Extra="

Modified from code contributed by Topellina.

" Units=Windows Snip=371.dat @@ -193,7 +193,7 @@ Delphi10S=Y FPC=Y [HScrollbarHeight] -Desc="Returns the height of the given control's horizontal scrollbar if shown, or 0 if not shown." +DescEx="

Returns the height of the given control's horizontal scrollbar if shown, or 0 if not shown.

" Units=Controls,Windows,StdCtrls Depends=WinControlScrollbars SeeAlso=VScrollbarWidth,WinControlScrollbars,WindowScrollbars @@ -217,7 +217,7 @@ Delphi10S=Y FPC=N [IsEqualResID] -Desc="Checks whether the two given resource ids are equal." +DescEx="

Checks whether the two given resource ids are equal.

" Units=SysUtils,Windows Depends=IsIntResource SeeAlso=IsIntResource,ResourceIDToStr @@ -241,7 +241,7 @@ Delphi10S=Y FPC=Y [IsTopLevelWindow] -Desc="Checks if the window with the given handle is a top level window." +DescEx="

Checks if the window with the given handle is a top level window.

" Units=Windows SeeAlso=GetTopLevelWindow Snip=172.dat @@ -383,7 +383,7 @@ Delphi10S=Y FPC=Y [TreeNodeChildCount] -Desc="Returns the number of child nodes of the given tree node." +DescEx="

Returns the number of child nodes of the given tree node.

" Extra="

Derived from code contributed by Bill Miller.

" Units=ComCtrls Snip=508.dat @@ -406,7 +406,7 @@ Delphi10S=Y FPC=N [VScrollbarWidth] -Desc="Returns the width of the given control's vertical scrollbar if shown, or 0 if not shown." +DescEx="

Returns the width of the given control's vertical scrollbar if shown, or 0 if not shown.

" Units=Controls,Windows,StdCtrls Depends=WinControlScrollbars SeeAlso=HScrollbarHeight,WinControlScrollbars,WindowScrollbars @@ -454,7 +454,7 @@ Delphi10S=Y FPC=N [WindowScrollbars] -Desc="Returns a value that specifies which, if any, scroll bars are displayed by the window with the given handle." +DescEx="

Returns a value that specifies which, if any, scroll bars are displayed by the window with the given handle.

" Extra="

Based on code by Peter Below from the now defunct Delphi Pool website.

" Units=Windows,StdCtrls SeeAlso=HScrollbarHeight,VScrollbarWidth,WinControlScrollbars @@ -478,7 +478,7 @@ Delphi10S=Y FPC=N [WindowSupportsLayers] -Desc="Checks if the window with the given handler supports layers (i.e. transparency)." +DescEx="

Checks if the window with the given handler supports layers (i.e. transparency).

" Units=Windows Depends=IsFlagSet SeeAlso=DisableLayersSupport,EnableLayersSupport @@ -502,7 +502,7 @@ Delphi10S=Y FPC=Y [ContainsFocus] -Desc="Returns True if the specified control, or one of its child controls, currently has the input focus." +DescEx="

Returns True if the specified control, or one of its child controls, currently has the input focus.

" Extra="

Adapted from the article "Implementing 'Contains Focus' for Delphi's Container Controls: TPanel, TGroupBox" on About.com.

" Depends=FocusedControl SeeAlso=FocusedControl @@ -574,7 +574,7 @@ Delphi10S=Y FPC=Y [LangIDFromLCID] -Desc="Extracts and returns a language identifier from the given locale identifier." +DescEx="

Extracts and returns a language identifier from the given locale identifier.

" Extra="

Emulates the Windows LANGIDFROMLCID macro.

" Units=Windows SeeAlso=MakeLCID,SortIDFromLCID @@ -645,7 +645,7 @@ Delphi10S=Y FPC=Y [PrimaryLangID] -Desc="Extracts and returns a primary language identifier from the given language identifier." +DescEx="

Extracts and returns a primary language identifier from the given language identifier.

" Extra="

Emulates the Windows PRIMARYLANGID macro.

" SeeAlso=MakeLangID,MakeLCID,SubLangID Snip=169.dat @@ -692,7 +692,7 @@ Delphi10S=Y FPC=N [SortIDFromLCID] -Desc="Extracts and returns a sort order identifier from the given locale identifier." +DescEx="

Extracts and returns a sort order identifier from the given locale identifier.

" Extra="

Emulates the Windows SORTIDFROMLCID macro.

" Units=Windows SeeAlso=LangIDFromLCID,MakeLCID @@ -716,7 +716,7 @@ Delphi10S=Y FPC=Y [SubLangID] -Desc="Extracts and returns a sublanguage identifier from the given language identifier." +DescEx="

Extracts and returns a sublanguage identifier from the given language identifier.

" Extra="

Emulates the Windows SUBLANGID macro.

" SeeAlso=MakeLangID,MakeLCID,PrimaryLangID Snip=170.dat diff --git a/csdb/collection/winsys.ini b/csdb/collection/winsys.ini index 9347ef0..fbe43fc 100644 --- a/csdb/collection/winsys.ini +++ b/csdb/collection/winsys.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [CommonFilesFolder] -Desc="Returns the Windows common files directory." +DescEx="

Returns the Windows common files directory.

" Depends=GetCurrentVersionRegStr SeeAlso=ProgramFilesFolder,SystemFolder,TempFolder,WindowsFolder,GetDesktopFolder Snip=040.dat @@ -29,7 +29,7 @@ Delphi10S=Y FPC=Y [ComputerName] -Desc="Returns the name of the host computer." +DescEx="

Returns the name of the host computer.

" Units=Windows SeeAlso=UserName Snip=129.dat @@ -75,7 +75,7 @@ Delphi10S=Y FPC=Y [IsMediaCenterOS] -Desc="Checks if the host operating system includes Windows Media Center." +DescEx="

Checks if the host operating system includes Windows Media Center.

" Units=Windows SeeAlso=IsTabletOS,IsWinNT,IsWin9x,IsWow64,IsVista,IsWindows7 Snip=092.dat @@ -98,7 +98,7 @@ Delphi10S=Y FPC=Y [IsTabletOS] -Desc="Checks if the host operating system is a Windows Tablet edition." +DescEx="

Checks if the host operating system is a Windows Tablet edition.

" Units=Windows SeeAlso=IsMediaCenterOS,IsWinNT,IsWin9x,IsWow64,IsVista,IsWindows7 Snip=093.dat @@ -121,9 +121,8 @@ Delphi10S=Y FPC=Y [IsVista] -Desc="Checks if the host operating system is Windows Vista or later." -Extra="

Contributed by Laurent Pierre.

" -Extra="

Works correctly even if the application has defined a Windows XP (or other) compatibility mode.

" +DescEx="

Checks if the host operating system is Windows Vista or later.

" +Extra="

Works correctly even if the application has defined a Windows XP (or other) compatibility mode.

Contributed by Laurent Pierre.

" Units=Windows SeeAlso=IsWin9x,IsWinNT,IsWow64,IsTabletOS,IsMediaCenterOS,IsWindows7 Snip=151.dat @@ -146,7 +145,7 @@ Delphi10S=Y FPC=Y [IsWin9x] -Desc="Checks if the host operating system is on the Windows 9x platform." +DescEx="

Checks if the host operating system is on the Windows 9x platform.

" Units=SysUtils,Windows SeeAlso=IsWinNT,IsWow64,IsVista,IsWindows7,IsTabletOS,IsMediaCenterOS Snip=091.dat @@ -169,7 +168,7 @@ Delphi10S=Y FPC=Y [IsWindows7] -Desc="Checks if the host operating system is Windows 7 (or Windows Server 2008 R2) or later." +DescEx="

Checks if the host operating system is Windows 7 (or Windows Server 2008 R2) or later.

" Extra="

Works correctly even if the application has defined a Windows Vista (or other) compatibility mode.

" Units=Windows SeeAlso=IsWin9x,IsWinNT,IsWow64,IsTabletOS,IsMediaCenterOS,IsVista @@ -193,7 +192,7 @@ Delphi10S=Y FPC=Y [IsWinNT] -Desc="Checks if the host operating system is on the Windows NT platform." +DescEx="

Checks if the host operating system is on the Windows NT platform.

" Units=SysUtils,Windows SeeAlso=IsVista,IsWindows7,IsWin9x,IsWow64,IsTabletOS,IsMediaCenterOS Snip=065.dat @@ -216,7 +215,7 @@ Delphi10S=Y FPC=Y [IsWow64] -Desc="Checks if the current process is executing as a 32 bit process under WOW64 on 64 bit Windows." +DescEx="

Checks if the current process is executing as a 32 bit process under WOW64 on 64 bit Windows.

" Units=SysUtils,Windows SeeAlso=IsWin9x,IsWinNT,IsVista,IsWindows7,IsTabletOS,IsMediaCenterOS Snip=085.dat @@ -239,7 +238,7 @@ Delphi10S=Y FPC=Y [ProgramFilesFolder] -Desc="Returns the Windows program files directory." +DescEx="

Returns the Windows program files directory.

" Depends=GetCurrentVersionRegStr SeeAlso=CommonFilesFolder,SystemFolder,TempFolder,WindowsFolder,GetDesktopFolder Snip=039.dat @@ -284,7 +283,7 @@ Delphi10S=Y FPC=Y [SystemFolder] -Desc="Returns the Windows system directory." +DescEx="

Returns the Windows system directory.

" Units=Windows SeeAlso=CommonFilesFolder,ProgramFilesFolder,TempFolder,WindowsFolder,GetDesktopFolder Snip=042.dat @@ -307,7 +306,7 @@ Delphi10S=Y FPC=Y [TempFolder] -Desc="Returns the Windows temporary directory." +DescEx="

Returns the Windows temporary directory.

" Units=Windows SeeAlso=CommonFilesFolder,ProgramFilesFolder,SystemFolder,TempFileName,WindowsFolder,TempFolder Snip=043.dat @@ -330,7 +329,7 @@ Delphi10S=Y FPC=Y [UserName] -Desc="Returns the name of the current user." +DescEx="

Returns the name of the current user.

" Units=Windows SeeAlso=ComputerName Snip=130.dat @@ -353,7 +352,7 @@ Delphi10S=Y FPC=Y [WindowsFolder] -Desc="Returns the Windows directory." +DescEx="

Returns the Windows directory.

" Units=Windows SeeAlso=CommonFilesFolder,ProgramFilesFolder,SystemFolder,TempFolder,WindowsFolder Snip=041.dat @@ -376,7 +375,7 @@ Delphi10S=Y FPC=Y [WindowsProductID] -Desc="Returns the Windows product ID." +DescEx="

Returns the Windows product ID.

" Units=Windows Depends=GetRegistryString,IsWinNT Snip=071.dat @@ -399,7 +398,7 @@ Delphi10S=Y FPC=Y [IsRemoteSession] -Desc="Checks if the program is running under Windows Terminal Server in a remote client session." +DescEx="

Checks if the program is running under Windows Terminal Server in a remote client session.

" Extra="

Note: This function requires Windows NT4 SP4 or later. It does not work on the Windows 9x platform.

" Units=Windows Snip=302.dat From cbdb9b0c60bcc158bb3c400a147fea3322756ea6 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 26 Dec 2021 11:25:26 +0000 Subject: [PATCH 04/99] Made all DescEx and Extra values REML conformant Achieved by adding enclosing

..

tags to all REML that didn't have it. --- csdb/collection/arrays.ini | 2 +- csdb/collection/consts.ini | 2 +- csdb/collection/date.ini | 8 ++++---- csdb/collection/drive.ini | 2 +- csdb/collection/encoding.ini | 2 +- csdb/collection/file.ini | 12 ++++++------ csdb/collection/graphics.ini | 38 ++++++++++++++++++------------------ csdb/collection/hex.ini | 2 +- csdb/collection/io.ini | 12 ++++++------ csdb/collection/maths.ini | 8 ++++---- csdb/collection/shell.ini | 10 +++++----- csdb/collection/string.ini | 26 ++++++++++++------------ csdb/collection/structs.ini | 6 +++--- csdb/collection/sys.ini | 16 +++++++-------- csdb/collection/types.ini | 4 ++-- csdb/collection/utils.ini | 14 ++++++------- csdb/collection/wb.ini | 2 +- csdb/collection/web.ini | 2 +- csdb/collection/windows.ini | 22 ++++++++++----------- csdb/collection/winsys.ini | 4 ++-- 20 files changed, 97 insertions(+), 97 deletions(-) diff --git a/csdb/collection/arrays.ini b/csdb/collection/arrays.ini index 2f7cc09..2692d1f 100644 --- a/csdb/collection/arrays.ini +++ b/csdb/collection/arrays.ini @@ -140,7 +140,7 @@ Delphi10S=Y FPC=Y [AppendByteArray] -DescEx="Appends array of bytes B2 to the end of byte array B1." +DescEx="

Appends array of bytes B2 to the end of byte array B1.

" Depends=TBytes SeeAlso=ConcatByteArrays Snip=364.dat diff --git a/csdb/collection/consts.ini b/csdb/collection/consts.ini index 4fb2ed3..ba9ad18 100644 --- a/csdb/collection/consts.ini +++ b/csdb/collection/consts.ini @@ -8,7 +8,7 @@ [SHIL_Enum] Kind=const DisplayName=SHIL_* Constants -DescEx="Constants that can be passed as flags to specify the required image type in calls to the SysImageListHandleEx routine." +DescEx="

Constants that can be passed as flags to specify the required image type in calls to the SysImageListHandleEx routine.

" Extra="

Contributed by Bill Miller.

" SeeAlso=SysImageListHandleEx Snip=332.dat diff --git a/csdb/collection/date.ini b/csdb/collection/date.ini index 31db4c2..a48cd46 100644 --- a/csdb/collection/date.ini +++ b/csdb/collection/date.ini @@ -751,7 +751,7 @@ Delphi10S=Y FPC=Y [MSecToDateTime] -DescEx="Converts the given number of milliseconds to a TDateTime value." +DescEx="

Converts the given number of milliseconds to a TDateTime value.

" Units=SysUtils Snip=458.dat Delphi2=N @@ -797,7 +797,7 @@ Delphi10S=Y FPC=Y [SQLDateToDateTime] -DescEx="Converts a date in SQL format into a TDateTime." +DescEx="

Converts a date in SQL format into a TDateTime.

" Extra="

Handles only the date component. Any time component is ignored.

" Units=SysUtils SeeAlso=SQLDate @@ -1225,7 +1225,7 @@ Delphi10S=Y FPC=Y [RFC2822Date] -DescEx="Returns the RFC 2822 representation of the date (in local time) specified in the LocalTime parameter. The IsDST parameter indicates whether LocalTime is in daylight saving time or not." +DescEx="

Returns the RFC 2822 representation of the date (in local time) specified in the LocalTime parameter. The IsDST parameter indicates whether LocalTime is in daylight saving time or not.

" Extra="

This date format is defined by section 3.3 of RFC 2882.

" Units=SysUtils,Windows Snip=374.dat @@ -1248,7 +1248,7 @@ Delphi10S=Y FPC=Y [SecondsToTime] -DescEx="Converts a number of seconds into a TDateTime value." +DescEx="

Converts a number of seconds into a TDateTime value.

" Extra="

This routine uses knowledge of the internal composition of a TDateTime.

" Units=SysUtils Snip=357.dat diff --git a/csdb/collection/drive.ini b/csdb/collection/drive.ini index f991a09..1033d49 100644 --- a/csdb/collection/drive.ini +++ b/csdb/collection/drive.ini @@ -215,7 +215,7 @@ FPC=Y [GetDriveNumber] DescEx="

Returns the zero based drive number for given drive. -1 is returned if drive name does not start with a valid drive letter in the range A..Z.

" -Extra="Drive can be specified as a disk letter (e.g. C), a drive name (e.g C: or C:\) or an absolute file path on the drive (e.g. C:\Foo\Bar.txt)." +Extra="

Drive can be specified as a disk letter (e.g. C), a drive name (e.g C: or C:\) or an absolute file path on the drive (e.g. C:\Foo\Bar.txt).

" Units=SysUtils Depends=IsCharInSet SeeAlso=IsValidDriveNum diff --git a/csdb/collection/encoding.ini b/csdb/collection/encoding.ini index 2722e5a..14c8096 100644 --- a/csdb/collection/encoding.ini +++ b/csdb/collection/encoding.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [BytesToAnsiString] -DescEx="Converts the given array of bytes to an ANSI raw byte string, which is returned. The returned string has the code page specified by CodePage." +DescEx="

Converts the given array of bytes to an ANSI raw byte string, which is returned. The returned string has the code page specified by CodePage.

" Extra="

Based on code from the Stack Overflow posting How can I convert TBytes to RawByteString?.

" Units=SysUtils Snip=359.dat diff --git a/csdb/collection/file.ini b/csdb/collection/file.ini index 7f339b5..b852aa2 100644 --- a/csdb/collection/file.ini +++ b/csdb/collection/file.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [CopyFile] -DescEx="Copies Source file to Dest file, preserving modification date." +DescEx="

Copies Source file to Dest file, preserving modification date.

" Units=Classes,SysUtils SeeAlso=CopyFiles Snip=029.dat @@ -309,7 +309,7 @@ Delphi10S=Y FPC=Y [GetFixedFileVerInfo] -DescEx="Extracts fixed version information from file named by FileName. If file contains version information it is returned via FFI parameter and function returns True, otherwise False is returned and FFI is undefined." +DescEx="

Extracts fixed version information from file named by FileName.

If file contains version information it is returned via FFI parameter and function returns True, otherwise False is returned and FFI is undefined.

" Units=Windows SeeAlso=HasVerInfo Snip=010.dat @@ -896,7 +896,7 @@ Delphi10S=Y FPC=Y [IsDirectory] -DescEx="Returns True if given name is a valid directory and False otherwise. DirName can be any file system name (with or without trailing path delimiter)." +DescEx="

Returns True if given name is a valid directory and False otherwise. DirName can be any file system name (with or without trailing path delimiter).

" Extra="

This routine avoids using DirectoryExists in FileCtrl and hence avoids the overhead of using that unit.

" Units=SysUtils Depends=IsFlagSet @@ -1065,7 +1065,7 @@ Delphi10S=Y FPC=Y [SubDirectoryCount] -DescEx="Counts all the sub-directories of directory specified by Path. If Recurse is True all sub-directories are counted recursively, otherwise only immediate sub-directories are counted." +DescEx="

Counts all the sub-directories of directory specified by Path.

If Recurse is True all sub-directories are counted recursively, otherwise only immediate sub-directories are counted.

" Extra="

Adapted from code contributed by Bill Miller.

" Units=IOUtils,Types Snip=409.dat @@ -1088,7 +1088,7 @@ Delphi10S=Y FPC=N [TempFileName] -DescEx="Returns a unique temporary file name in the user's Temp folder. The file name includes the first three characters of Stub followed by hexadecimal characters. If Create is True then the file is created. Returns an empty string on failure." +DescEx="

Returns a unique temporary file name in the user's Temp folder. The file name includes the first three characters of Stub followed by hexadecimal characters.

If Create is True then the file is created. Returns an empty string on failure.

" Extra="

Note: Even if ACreate is false the file will be created momentarily. This means that APath must exist and the current user must have write access to the path or the routine will fail.

" Units=Windows,SysUtils SeeAlso=TempFolder,TempFileNameEx @@ -1112,7 +1112,7 @@ Delphi10S=Y FPC=Y [TempFileNameEx] -DescEx="Returns a unique temporary file name in the directory specified in APath. The file name includes the first three characters of AStub followed by hexadecimal characters. If ACreate is True then the file is created. Returns an empty string on failure." +DescEx="

Returns a unique temporary file name in the directory specified in APath. The file name includes the first three characters of AStub followed by hexadecimal characters.

If ACreate is True then the file is created. Returns an empty string on failure.

" Extra="

Note: Even if ACreate is false the file will be created momentarily. This means that APath must exist and the current user must have write access to the path or the routine will fail.

From Bill Miller's snippets collection.

" Units=Windows,SysUtils SeeAlso=TempFileName diff --git a/csdb/collection/graphics.ini b/csdb/collection/graphics.ini index 343bf05..cfef4c8 100644 --- a/csdb/collection/graphics.ini +++ b/csdb/collection/graphics.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [AdjustColorBrightness] -DescEx="Adjusts the brightness of colour Color by a specified Delta in range -255..255." +DescEx="

Adjusts the brightness of colour Color by a specified Delta in range -255..255.

" Extra="

Based on code found on the former EFG's Delphi Reference Library.

" Units=Windows,Graphics SeeAlso=AdjustBitmapBrightness @@ -30,7 +30,7 @@ Delphi10S=Y FPC=N [BitmapToMetafile] -DescEx="Converts a bitmap into an extended meta file object. Metafile EMF is updated to contain a copy of bitmap Bmp." +DescEx="

Converts a bitmap into an extended meta file object. Metafile EMF is updated to contain a copy of bitmap Bmp.

" Units=Graphics SeeAlso=GraphicToBitmap Snip=178.dat @@ -54,7 +54,7 @@ FPC=N [CloneCursorAsBitmap] DescEx="

Creates and returns a bitmap object that contains a copy of the given cursor.

The bitmap has the pixel format specified by PixelFmt. If PixelFmt is pfCustom, then the default format is used.

TransparentColor specifies the colour in the cursor that is to be drawn as transparent in the bitmap. TransparentColor has no effect if it is clNone.

" -Extra="Note: The caller is responsible for freeing the bitmap created by this function." +Extra="

Note: The caller is responsible for freeing the bitmap created by this function.

" Units=Controls,Graphics,Forms Depends=CloneCursorHandleAsBitmap SeeAlso=CloneCursorHandleAsBitmap,CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsIcon,CursorHandleToBitmap,CursorToBitmap @@ -79,7 +79,7 @@ FPC=N [CloneCursorAsIcon] DescEx="

Creates and returns an icon object that contains a copy of the given cursor.

" -Extra="Note: The caller is responsible for freeing the icon created by this function." +Extra="

Note: The caller is responsible for freeing the icon created by this function.

" Units=Controls,Graphics,Forms Depends=CloneCursorHandleAsIcon SeeAlso=CloneCursorAsBitmap,CloneCursorHandleAsBitmap,CloneCursorHandleAsIcon,CursorHandleToBitmap,CursorToBitmap @@ -104,7 +104,7 @@ FPC=N [CloneCursorHandleAsBitmap] DescEx="

Creates and returns a bitmap object that contains a copy of the cursor whose handle is given by Handle.

The bitmap has the pixel format specified by PixelFmt. If PixelFmt is pfCustom, then the default format is used.

TransparentColor specifies the colour in the cursor that is to be drawn as transparent in the bitmap. TransparentColor has no effect if it is clNone.

" -Extra="Note: The caller is responsible for freeing the bitmap created by this function." +Extra="

Note: The caller is responsible for freeing the bitmap created by this function.

" Units=Windows,Graphics Depends=CloneGraphicAsBitmap SeeAlso=CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsIcon,CursorHandleToBitmap,CursorToBitmap @@ -129,7 +129,7 @@ FPC=N [CloneCursorHandleAsIcon] DescEx="

Creates and returns an icon object that contains a copy of the cursor with the given handle.

" -Extra="Note: The caller is responsible for freeing the icon created by this function." +Extra="

Note: The caller is responsible for freeing the icon created by this function.

" Units=Windows,Graphics SeeAlso=CloneCursorAsBitmap,CloneCursorAsIcon,CloneCursorHandleAsBitmap,CursorHandleToBitmap,CursorToBitmap Snip=274.dat @@ -153,7 +153,7 @@ FPC=N [CloneGraphicAsBitmap] DescEx="

Creates and returns a bitmap object that contains a copy of given graphic object Src.

The bitmap has the pixel format specified by PixelFmt. If PixelFmt is pfCustom, then the default format is used, unless Src is a bitmap when its own format is used.

If Src is transparent then the bitmap is set to transparent and TransparentColor is used as the bitmap's transparent colour. TransparentColor is ignored if it is clNone or if Src is not transparent.

" -Extra="Note: The caller is responsible for freeing the bitmap created by this function." +Extra="

Note: The caller is responsible for freeing the bitmap created by this function.

" Units=Graphics Depends=GraphicToBitmap SeeAlso=GraphicToBitmap,CloneJPEGAsBitmap @@ -178,7 +178,7 @@ FPC=N [CloneJPEGAsBitmap] DescEx="

Creates and returns a bitmap object that contains a copy of the given JPEG image.

" -Extra="Note: The caller is responsible for freeing the bitmap created by this function." +Extra="

Note: The caller is responsible for freeing the bitmap created by this function.

" Units=Graphics,JPEG SeeAlso=JPEGFileToBitmapFile,CloneGraphicAsBitmap Snip=279.dat @@ -201,7 +201,7 @@ Delphi10S=Y FPC=N [ColorToRGBTriple] -DescEx="Converts the given TColor value into an RGB triple value, which is returned." +DescEx="

Converts the given TColor value into an RGB triple value, which is returned.

" Extra="

System colours are converted to their actual values before conversion.

" Units=Windows,Graphics Depends=ExtractRGB @@ -392,7 +392,7 @@ Delphi10S=Y FPC=N [ExtractRGB] -DescEx="Extracts constituent RGB values from the given colour and returns them via the Red, Green and Blue parameters." +DescEx="

Extracts constituent RGB values from the given colour and returns them via the Red, Green and Blue parameters.

" Extra="

System colours are converted to their actual values before extracting the RGB values.

" Units=Graphics,Windows SeeAlso=ColorToRGBTriple @@ -438,7 +438,7 @@ Delphi10S=Y FPC=N [GetIconANDBitmask] -DescEx="Copies the given icon's AND bitmask to bitmap Mask." +DescEx="

Copies the given icon's AND bitmask to bitmap Mask.

" Units=Graphics,Windows,SysUtils SeeAlso=IsCursorIcon,IsColorIcon,GetIconHotspot,GetIconXORBitmask Snip=116.dat @@ -461,7 +461,7 @@ Delphi10S=Y FPC=N [GetIconXORBitmask] -DescEx="Copies the given icon's XOR bitmask to bitmap Mask." +DescEx="

Copies the given icon's XOR bitmask to bitmap Mask.

" Units=Graphics,Windows,SysUtils,Classes SeeAlso=IsCursorIcon,IsColorIcon,GetIconHotspot,GetIconANDBitmask Snip=117.dat @@ -671,7 +671,7 @@ Delphi10S=Y FPC=N [RGBTripleToColor] -DescEx="Converts an RGB triple value into a TColor value." +DescEx="

Converts an RGB triple value into a TColor value.

" Units=Windows,Graphics SeeAlso=ColorToRGBTriple Snip=096.dat @@ -694,7 +694,7 @@ Delphi10S=Y FPC=N [SetDefaultFont] -DescEx="Sets the given TFont object to the default GUI font for the operating system." +DescEx="

Sets the given TFont object to the default GUI font for the operating system.

" Extra="

From Bill Miller's snippets collection.

" Units=Windows,Graphics SeeAlso=SetDesktopIconFont @@ -815,7 +815,7 @@ Delphi10S=Y FPC=N [AdjustBitmapBrightness] -DescEx="Changes the brightness of bitmap Bmp by a given Delta value in range -255..+255." +DescEx="

Changes the brightness of bitmap Bmp by a given Delta value in range -255..+255.

" Extra="

Based on code found on the former EFG's Delphi Reference Library.

Note from EFG: Normally a pf24bit bitmap scanline would be accessed as a type TRGBTripleArray = array[Word] of TRGBTriple, but since we can treat the three color components (rgbtRed, rgbtGreen, rgbtBlue) in exactly the same way, we can access the scanline as a pByteArray of 3 * Bitmap.Width bytes.

" Units=SysUtils,Graphics SeeAlso=AdjustColorBrightness @@ -917,7 +917,7 @@ Delphi10S=Y FPC=N [ColorToHSB] -DescEx="Converts the given TColor value to a THSBColor value, which is returned." +DescEx="

Converts the given TColor value to a THSBColor value, which is returned.

" Extra="

System colours are converted to their actual values before conversion.

" Units=Graphics Depends=THSBColor,ColorToRGBTriple,RGBToHSB @@ -1453,7 +1453,7 @@ FPC=N [ScaleBitmap_A] DisplayName="ScaleBitmap (copy overload)" -DescEx="Performs a high quality scaling of bitmap ASrcBmp and copies the result into ADestBmp. The required scale factor is given by AScaling." +DescEx="

Performs a high quality scaling of bitmap ASrcBmp and copies the result into ADestBmp. The required scale factor is given by AScaling.

" Extra="

Modified from code contributed by Montor.

" Units=Graphics,Types Depends=ScaleRect,RectWidth,RectHeight,HalftoneStretch_A @@ -1479,7 +1479,7 @@ FPC=N [ScaleBitmap_B] DisplayName="ScaleBitmap (inplace overload)" -DescEx="Performs a high quality scaling of the given bitmap by scale factor AScaling. The bitmap is modified in place." +DescEx="

Performs a high quality scaling of the given bitmap by scale factor AScaling. The bitmap is modified in place.

" Extra="

Slightly modified from code contributed by Montor.

" Units=Graphics Depends=ScaleBitmap_A @@ -1579,7 +1579,7 @@ FPC=Y [TColorRec] Kind=type -DescEx="Cracker record that provides several different views of a TColor value and allows it to be assembled from its constituent parts." +DescEx="

Cracker record that provides several different views of a TColor value and allows it to be assembled from its constituent parts.

" Extra="

Contributed by Montor.

Note: Care needs to be taken when using SysFlag to detect a system colour, because SysFlag will be equal to $FF if a normal colour has an alpha transparency of $FF.

" Snip=375.dat Delphi2=Y diff --git a/csdb/collection/hex.ini b/csdb/collection/hex.ini index 3b6af4d..214176b 100644 --- a/csdb/collection/hex.ini +++ b/csdb/collection/hex.ini @@ -201,7 +201,7 @@ FPC=Y [TryHexToInt64] DescEx="

Attempts to convert the given hexadecimal string into a 64 bit integer.

Returns True on success and set Value to the converted value. Returns False on error, leaving Value undefined.

" -Extra="

The hexadecimal string must contain only valid hex digits, optionally prefixed by either '$' or '0x'.

" +Extra="

The hexadecimal string must contain only valid hex digits, optionally prefixed by either '$' or '0x'.

" Depends=AddHexPrefix SeeAlso=HexToInt64,HexToInt64Def,TryHexToBuf,TryHexToInt TestInfo=advanced diff --git a/csdb/collection/io.ini b/csdb/collection/io.ini index ba69c86..2370c5c 100644 --- a/csdb/collection/io.ini +++ b/csdb/collection/io.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [FileToString] -DescEx="Reads text in the default ANSI encoding from file named by FileName into a string, which is returned." +DescEx="

Reads text in the default ANSI encoding from file named by FileName into a string, which is returned.

" Units=Classes,SysUtils Depends=StreamToString SeeAlso=StringToFile,UnicodeFileToWideString,WideStringToUnicodeFile @@ -30,7 +30,7 @@ Delphi10S=Y FPC=Y [StreamToString] -DescEx="Reads text in the default ANSI encoding from stream Stm into a string, which is returned. The stream is read from the current position." +DescEx="

Reads text in the default ANSI encoding from stream Stm into a string, which is returned. The stream is read from the current position.

" Units=Classes SeeAlso=StringToStream,WideStringToUnicodeStream,UnicodeStreamToWideString Snip=078.dat @@ -53,7 +53,7 @@ Delphi10S=Y FPC=Y [StringToFile] -DescEx="Writes string Src to text file named by FileName. Text is written in default ANSI encoding." +DescEx="

Writes string Src to text file named by FileName. Text is written in default ANSI encoding.

" Units=Classes Depends=StringToStream SeeAlso=FileToString,UnicodeFileToWideString,WideStringToUnicodeFile @@ -77,7 +77,7 @@ Delphi10S=Y FPC=Y [StringToStream] -DescEx="Writes string Str into stream Stm at the current stream position. Text is written in default ANSI encoding." +DescEx="

Writes string Str into stream Stm at the current stream position. Text is written in default ANSI encoding.

" Units=Classes SeeAlso=StreamToString,WideStringToUnicodeStream,UnicodeStreamToWideString Snip=080.dat @@ -100,7 +100,7 @@ Delphi10S=Y FPC=Y [WideStringToUnicodeFile] -DescEx="Writes wide string Str to Unicode text file, named by FileName, in UTF16 little endian format with byte order mark." +DescEx="

Writes wide string Str to Unicode text file, named by FileName, in UTF16 little endian format with byte order mark.

" Units=Classes Depends=WideStringToUnicodeStream SeeAlso=UnicodeFileToWideString,FileToString,StringToFile @@ -124,7 +124,7 @@ Delphi10S=Y FPC=Y [WideStringToUnicodeStream] -DescEx="Writes wide string Str to stream Stm in Unicode UTF16 little endian format, with byte order mark." +DescEx="

Writes wide string Str to stream Stm in Unicode UTF16 little endian format, with byte order mark.

" Units=Windows,Classes SeeAlso=UnicodeStreamToWideString,StringToStream,StreamToString Snip=084.dat diff --git a/csdb/collection/maths.ini b/csdb/collection/maths.ini index 136124f..a55b2f6 100644 --- a/csdb/collection/maths.ini +++ b/csdb/collection/maths.ini @@ -192,7 +192,7 @@ Delphi10S=Y FPC=Y [NormalizeRect] -DescEx="Normalises the given rectangle so that Left <= Right and Top <= Bottom." +DescEx="

Normalises the given rectangle so that Left <= Right and Top <= Bottom.

" Extra="

Inspired by code published by Marco Cantù in supplementary chapter 22 of Mastering Delphi 5.

" Units=Windows Depends=ExchangeInt @@ -1336,7 +1336,7 @@ FPC=Y [ZoomRatio_A] DisplayName="ZoomRatio (Integer overload)" -DescEx="Calculates and returns the largest scaling that can be applied to a rectangle of width SrcWidth and height SrcHeight to fit it, without changing the aspect ratio, within a second rectangle of width DestWidth and height DestHeight." +DescEx="

Calculates and returns the largest scaling that can be applied to a rectangle of width SrcWidth and height SrcHeight to fit it, without changing the aspect ratio, within a second rectangle of width DestWidth and height DestHeight.

" Extra="

Slightly modified from code contributed by Montor.

" Units=Math SeeAlso=ZoomRatio_B,ZoomRatio_C,ScaleRect,StretchRect_A,StretchRect_B,ResizeRect_A,ResizeRect_B @@ -1361,7 +1361,7 @@ FPC=Y [ZoomRatio_B] DisplayName="ZoomRatio (TSize overload)" -DescEx="Calculates and returns the largest scaling that can be applied to a rectangle of size SrcSize to fit it, without changing the aspect ratio, within a second rectangle of size DestSize." +DescEx="

Calculates and returns the largest scaling that can be applied to a rectangle of size SrcSize to fit it, without changing the aspect ratio, within a second rectangle of size DestSize.

" Units=Types Depends=ZoomRatio_A SeeAlso=ZoomRatio_A,ZoomRatio_C,ScaleRect,StretchRect_A,StretchRect_B,ResizeRect_A,ResizeRect_B @@ -1386,7 +1386,7 @@ FPC=Y [ZoomRatio_C] DisplayName="ZoomRatio (TRect overload)" -DescEx="Calculates and returns the largest scaling that can be applied to rectangle SrcRect to fit it, without changing the aspect ratio, within rectangle DestRect." +DescEx="

Calculates and returns the largest scaling that can be applied to rectangle SrcRect to fit it, without changing the aspect ratio, within rectangle DestRect.

" Units=Types Depends=RectSize,ZoomRatio_B SeeAlso=ZoomRatio_A,ZoomRatio_B,ScaleRect,StretchRect_A,StretchRect_B,ResizeRect_A,ResizeRect_B diff --git a/csdb/collection/shell.ini b/csdb/collection/shell.ini index 68e8559..ef7e25c 100644 --- a/csdb/collection/shell.ini +++ b/csdb/collection/shell.ini @@ -216,7 +216,7 @@ Delphi10S=Y FPC=Y [FreePIDL] -DescEx="Frees the memory used by the item ID list pointed to by PIDL. The memory is freed using the shell allocator." +DescEx="

Frees the memory used by the item ID list pointed to by PIDL. The memory is freed using the shell allocator.

" Units=ActiveX,Windows,ShlObj Snip=052.dat Delphi2=N @@ -311,7 +311,7 @@ Delphi10S=Y FPC=Y [GetKnownFolderPath] -DescEx="Returns the "known folder path" specified by FolderID, or the empty string if FolderID is not valid on the host operating system." +DescEx="

Returns the "known folder path" specified by FolderID, or the empty string if FolderID is not valid on the host operating system.

" Extra="

This routine requires Windows Vista or later.

Contributed by Ariel Rivas.

" Units=ShlObj,ActiveX SeeAlso=SpecialFolderPath @@ -406,7 +406,7 @@ Delphi10S=Y FPC=Y [PIDLToFolderPath] -DescEx="Returns the full path of the file system folder identified by PIDL, or returns the empty string if PIDL identifies a virtual folder or is not valid." +DescEx="

Returns the full path of the file system folder identified by PIDL, or returns the empty string if PIDL identifies a virtual folder or is not valid.

" Units=Windows,ShlObj SeeAlso=SpecialFolderPath,FreePIDL Snip=053.dat @@ -574,7 +574,7 @@ FPC=Y [IsIEInstalled] DescEx="

Checks if Internet Explorer is installed on the system.

" -Extra="Contributed by Michael Rockett and renamed." +Extra="

Contributed by Michael Rockett and renamed.

" Depends=ProgIDInstalled Snip=566.dat Delphi2=N @@ -596,7 +596,7 @@ Delphi10S=Y FPC=Y [IsSpecialFolderSupported] -DescEx="Checks if the special folder specified by CSIDL is supported on the host operating system." +DescEx="

Checks if the special folder specified by CSIDL is supported on the host operating system.

" Extra="

The CSIDL_* constants can be found in the ShlObj and (in later version of Delphi) ShFolder units.

" Units=ShlObj,Windows Depends=FreePIDL diff --git a/csdb/collection/string.ini b/csdb/collection/string.ini index a7226c4..44de637 100644 --- a/csdb/collection/string.ini +++ b/csdb/collection/string.ini @@ -52,7 +52,7 @@ Delphi10S=Y FPC=Y [CountDelims] -DescEx="Returns the number of occurences of any character from Delims in the given string S." +DescEx="

Returns the number of occurences of any character from Delims in the given string S.

" Units=SysUtils SeeAlso=ContainsDelims Snip=032.dat @@ -75,7 +75,7 @@ Delphi10S=Y FPC=Y [CountUnquotedWords] -DescEx="Returns the number of space delimited words in string S. Any words enclosed by the quote character AQuote are counted as one word." +DescEx="

Returns the number of space delimited words in string S. Any words enclosed by the quote character AQuote are counted as one word.

" Extra="

Contributed by Rubem Rocha.

" Units=Classes SeeAlso=ExplodeUnquotedWords,CountWords,WordCount @@ -526,7 +526,7 @@ Delphi10S=Y FPC=Y [ChangeChar] -DescEx="Replaces all occurrences the character ASearch in AString with the AReplace character, and returns the resulting string." +DescEx="

Replaces all occurrences the character ASearch in AString with the AReplace character, and returns the resulting string.

" Extra="

Warning: This routine replaces code points rather than characters. It is not safe for use with ANSI multi-byte character sets or, on Unicode versions of Delphi, with characters outside the Unicode basic multilingual plane.

Contributed by Bill Miller.

" Snip=349.dat Delphi2=Y @@ -762,7 +762,7 @@ Delphi10S=Y FPC=Y [ExplodeWords] -DescEx="Extracts a list of white space delimited words from string S and returns the number of words found. The extracted words are stored in stringlist Words, overwriting any existing content." +DescEx="

Extracts a list of white space delimited words from string S and returns the number of words found. The extracted words are stored in stringlist Words, overwriting any existing content.

" Extra="

Note: This function treats only the space, TAB, LF, VT, FF and CR characters as white space.

" Units=Classes Depends=ExplodeStr,CompressWhiteSpace @@ -998,7 +998,7 @@ Delphi10S=Y FPC=Y [PadCenter] -DescEx="Centre aligns string AString within a string of size AWidth and returns the result. The string is padded as necessary with character AChar." +DescEx="

Centre aligns string AString within a string of size AWidth and returns the result. The string is padded as necessary with character AChar.

" Extra="

When an odd number of padding characters is required, the extra character is added on the right.

" SeeAlso=PadLeft,PadRight Snip=246.dat @@ -1021,7 +1021,7 @@ Delphi10S=Y FPC=Y [PadLeft] -DescEx="Left aligns string AString within a string of size AWidth and returns the result. The string is padded on the right as necessary with character AChar." +DescEx="

Left aligns string AString within a string of size AWidth and returns the result. The string is padded on the right as necessary with character AChar.

" Extra="

Contributed by Bill Miller.

" SeeAlso=PadCenter,PadRight Snip=247.dat @@ -1162,7 +1162,7 @@ Delphi10S=Y FPC=Y [StripAccelChars] -DescEx="Strips all accelerator ('&') characters from the given string and returns the resulting string." +DescEx="

Strips all accelerator ('&') characters from the given string and returns the resulting string.

" Extra="

Renamed from a routine contributed by Rubem Nascimento da Rocha.

" Units=SysUtils TestInfo=advanced @@ -1186,7 +1186,7 @@ Delphi10S=Y FPC=Y [StripLastChar] -DescEx="Removes the last character from the string S and returns the resulting string. If S is empty then it is returned unchanged." +DescEx="

Removes the last character from the string S and returns the resulting string. If S is empty then it is returned unchanged.

" Extra="

Note: This routine is not suitable for use with multi-byte character sets.

Contributed by Guru Kathiresan.

" SeeAlso=LastChar Snip=382.dat @@ -1280,7 +1280,7 @@ Delphi10S=Y FPC=Y [TrimChar] -DescEx="Trims occurrences of character C from both ends of string S and returns the result." +DescEx="

Trims occurrences of character C from both ends of string S and returns the result.

" Extra="

The character to be trimmed must be a single byte character.

" Depends=TrimLeftChar,TrimRightChar SeeAlso=TrimLeftChar,TrimRightChar @@ -1304,7 +1304,7 @@ Delphi10S=Y FPC=Y [TrimLeftChar] -DescEx="Trims occurrences of character C from the start of string S and returns the result." +DescEx="

Trims occurrences of character C from the start of string S and returns the result.

" Extra="

The character to be trimmed must be a single byte character.

" SeeAlso=TrimChar,TrimRightChar Snip=196.dat @@ -1327,7 +1327,7 @@ Delphi10S=Y FPC=Y [TrimRightChar] -DescEx="Trims occurrences of character C from the end of string S and returns the result." +DescEx="

Trims occurrences of character C from the end of string S and returns the result.

" Extra="

The character to be trimmed must be a single byte character.

" SeeAlso=TrimChar,TrimLeftChar Snip=197.dat @@ -1442,7 +1442,7 @@ Delphi10S=Y FPC=Y [QuoteSpacedString] -DescEx="If string S contains white space it is surrounded in the quotes specified by Quote and the result is returned. If S does not contain white space it is returned unchanged." +DescEx="

If string S contains white space it is surrounded in the quotes specified by Quote and the result is returned. If S does not contain white space it is returned unchanged.

" Extra="

Any quote characters already contained within the string are left unchanged: they are not escaped.

Note: This function recognises only the space, TAB, LF, VT, FF and CR characters as white space.

" Depends=ContainsWhiteSpace Snip=249.dat @@ -1465,7 +1465,7 @@ Delphi10S=Y FPC=Y [ReduceStr] -DescEx="Reduces the length of string S by the number of characters given by ReduceBy and returns the result." +DescEx="

Reduces the length of string S by the number of characters given by ReduceBy and returns the result.

" Extra="

Warning: This function actually operates on code points rather than characters, making it unsafe for use with ANSI multi-byte character sets or characters outside the Unicode basic multilingual plane.

Contributed by Bill Miller.

" Snip=350.dat Delphi2=Y diff --git a/csdb/collection/structs.ini b/csdb/collection/structs.ini index d65ac3a..444ab30 100644 --- a/csdb/collection/structs.ini +++ b/csdb/collection/structs.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [BoundsF] -DescEx="Constructs and returns a TRectF record with the given top-left coordinate, width and height." +DescEx="

Constructs and returns a TRectF record with the given top-left coordinate, width and height.

" SeeAlso=RectF,TRectF Depends=TRectF Snip=493.dat @@ -29,7 +29,7 @@ Delphi10S=Y FPC=Y [PointF] -DescEx="Constructs and returns a TPointF record with the given x & y coordinates." +DescEx="

Constructs and returns a TPointF record with the given x & y coordinates.

" SeeAlso=TPointF,RectF Depends=TPointF Snip=491.dat @@ -71,7 +71,7 @@ Delphi10S=Y FPC=Y [RectF] -DescEx="Constructs and returns a TRectF record with the given left, top, right & bottom coordinates." +DescEx="

Constructs and returns a TRectF record with the given left, top, right & bottom coordinates.

" SeeAlso=BoundsF,PointF,TRectF Depends=TRectF Snip=492.dat diff --git a/csdb/collection/sys.ini b/csdb/collection/sys.ini index c0bb59d..89c4243 100644 --- a/csdb/collection/sys.ini +++ b/csdb/collection/sys.ini @@ -124,7 +124,7 @@ Delphi10S=Y FPC=Y [GetParentProcessID] -DescEx="Returns the ID of the process that is the parent of the process identified by PID." +DescEx="

Returns the ID of the process that is the parent of the process identified by PID.

" Units=Windows,TlHelp32 SeeAlso=GetWindowProcessID Snip=240.dat @@ -313,7 +313,7 @@ Delphi10S=Y FPC=N [GetWindowThreadID] -DescEx="Returns the identifier of the thread that created the window with handle Wnd, or -1 if Wnd is invalid or if the thread can't be found." +DescEx="

Returns the identifier of the thread that created the window with handle Wnd, or -1 if Wnd is invalid or if the thread can't be found.

" Units=Windows SeeAlso=GetWindowProcessID Snip=241.dat @@ -452,7 +452,7 @@ Delphi10S=Y FPC=Y [Pause] -DescEx="Pauses for ADelay milliseconds before returning." +DescEx="

Pauses for ADelay milliseconds before returning.

" Extra="

Performs a busy wait.

Modifications to handle potential clock roll over and sleeping suggested by Montor.

" Units=Windows Depends=ProcessMessages @@ -596,7 +596,7 @@ Delphi10S=Y FPC=Y [SendKeysToWindow] -DescEx="Sends key strokes to the window with the handle HWnd that correspond to the characters in string Text." +DescEx="

Sends key strokes to the window with the handle HWnd that correspond to the characters in string Text.

" Extra="

Based on code suggested by DennisLV.

" Units=Windows,Messages SeeAlso=EmptyKeyQueue,PostKeyEx32 @@ -709,7 +709,7 @@ FPC=Y [DOSCommandRedirect_A] DisplayName="DOSCommandRedirect (TStream overload)" DescEx="

Executes the given DOS command in a hidden window and redirects its output to the given stream.

Returns True if the command executes or False otherwise.

" -Extra="Closely based on code contributed by Joe Donth." +Extra="

Closely based on code contributed by Joe Donth.

" Units=Classes,Windows SeeAlso=DOSCommand,DOSCommandRedirect_B Snip=614.dat @@ -949,8 +949,8 @@ Delphi10S=Y FPC=N [IsLibraryInstalled] -DescEx="Checks if a library with name LibFileName is installed." -Extra="Note: For compilers that don't support SafeLoadLibrary, use Windows.LoadLibrary instead, but note that the FPU control word could be changed and a warning dialog may be displayed if the DLL can't be found." +DescEx="

Checks if a library with name LibFileName is installed.

" +Extra="

Note: For compilers that don't support SafeLoadLibrary, use Windows.LoadLibrary instead, but note that the FPU control word could be changed and a warning dialog may be displayed if the DLL can't be found.

" Units=SysUtils,Windows Snip=118.dat Delphi2=N @@ -972,7 +972,7 @@ Delphi10S=Y FPC=Y [PostKeyEx32] -DescEx="Manufactures a series of key events. Key is the virtual key code of the required key, Shift is a set of shift keys and SpecialKey informs if the key is a special key such as the numeric pad." +DescEx="

Manufactures a series of key events. Key is the virtual key code of the required key, Shift is a set of shift keys and SpecialKey informs if the key is a special key such as the numeric pad.

" Extra="

Code by Peter Below, contributed by Bill Miller.

The events go to the control that has focus. Note that for characters Key is always the upper-case version of the character. Sending without any modifier keys will result in a lower-case character, sending with [ssShift] will result in an upper-case character.

" Units=Classes,Windows SeeAlso=SendKeysToWindow diff --git a/csdb/collection/types.ini b/csdb/collection/types.ini index fc1edea..2fceea4 100644 --- a/csdb/collection/types.ini +++ b/csdb/collection/types.ini @@ -7,7 +7,7 @@ [RawByteString] Kind=type -DescEx="Definition of RawByteString type for non-Unicode compilers." +DescEx="

Definition of RawByteString type for non-Unicode compilers.

" Extra="

Note: This type is defined in the System unit on Unicode compilers.

" Snip=358.dat Delphi2=Y @@ -54,7 +54,7 @@ FPC=Y [TCharSet] Kind=type -DescEx="Definition of a set of characters that can safely be used with Unicode and non-Unicode versions of Delphi, along with versions that don't support TSysCharSet." +DescEx="

Definition of a set of characters that can safely be used with Unicode and non-Unicode versions of Delphi, along with versions that don't support TSysCharSet.

" Units=SysUtils SeeAlso=IsCharInSet Snip=250.dat diff --git a/csdb/collection/utils.ini b/csdb/collection/utils.ini index cb86289..43fe8c4 100644 --- a/csdb/collection/utils.ini +++ b/csdb/collection/utils.ini @@ -320,7 +320,7 @@ Delphi10S=Y FPC=Y [IntToOctal] -DescEx="Returns a string containing the octal value of integer Value. Digits indicates the minimum number of octal digits to return." +DescEx="

Returns a string containing the octal value of integer Value. Digits indicates the minimum number of octal digits to return.

" Depends=PadRight Snip=255.dat Delphi2=Y @@ -342,7 +342,7 @@ Delphi10S=Y FPC=Y [IntToRoman] -DescEx="Converts non negative integer AValue into a string containing its roman numeral representation." +DescEx="

Converts non negative integer AValue into a string containing its roman numeral representation.

" Extra="

For values greater than 4999 the output string can get very long and difficult to read.

Modified from code contributed by Michael Rockett.

" SeeAlso=IntToNumberText Snip=457.dat @@ -365,7 +365,7 @@ Delphi10S=Y FPC=Y [IsSubClassOf] -DescEx="Checks if object instance AnInstance is a sub-class of, or the same class as, class AClass." +DescEx="

Checks if object instance AnInstance is a sub-class of, or the same class as, class AClass.

" Extra="

Contributed by Rubem Nascimento da Rocha.

" Snip=372.dat Delphi2=Y @@ -812,7 +812,7 @@ FPC=Y [FormInstanceCount_A] DisplayName="FormInstanceCount (class type overload)" -DescEx="Counts and returns the current number of form instances that have, or descend from, class AFormClass." +DescEx="

Counts and returns the current number of form instances that have, or descend from, class AFormClass.

" Extra="

Contributed by Rubem Nascimento da Rocha.

" Units=Forms SeeAlso=FormInstanceCount_B @@ -837,7 +837,7 @@ FPC=N [FormInstanceCount_B] DisplayName="FormInstanceCount (class name overload)" -DescEx="Counts and returns the current number of form instances that have class name AFormClassName." +DescEx="

Counts and returns the current number of form instances that have class name AFormClassName.

" Extra="

Contributed by Rubem Nascimento da Rocha.

Requires an exact match of class name. Descendant classes are excluded.

" Units=Forms SeeAlso=FormInstanceCount_A @@ -972,7 +972,7 @@ Delphi10S=Y FPC=Y [IsCharInSet] -DescEx="Checks if character Ch is in the set of characters Chars." +DescEx="

Checks if character Ch is in the set of characters Chars.

" Extra="

This routine works correctly with Unicode and non-Unicode versions of Delphi.

" Units=SysUtils Depends=TCharSet @@ -996,7 +996,7 @@ Delphi10S=Y FPC=Y [IsFlagSet] -DescEx="Checks if the bit flags given by Flags are set in bitmask Mask." +DescEx="

Checks if the bit flags given by Flags are set in bitmask Mask.

" Extra="

Flags may contain one or more bit flags. IsFlagSet returns True only if all the bit flags in Flags are set in Mask.

" Snip=212.dat Delphi2=Y diff --git a/csdb/collection/wb.ini b/csdb/collection/wb.ini index e2a5ef5..bce5aad 100644 --- a/csdb/collection/wb.ini +++ b/csdb/collection/wb.ini @@ -184,7 +184,7 @@ FPC=N [WBIsDOMLoaded] DescEx="

Checks if the given web browser control contains a valid document that supports the DOM.

" -Extra="Examples of document types that support the DOM are HTML and XML. This routine is a combination of versions of the same code contributed by Bill Miller and Peter Johnson." +Extra="

Examples of document types that support the DOM are HTML and XML. This routine is a combination of versions of the same code contributed by Bill Miller and Peter Johnson.

" SeeAlso=WBWaitForDocToLoad,WBWaitForDOMToLoad Units=SysUtils,SHDocVw,MSHTML Snip=572.dat diff --git a/csdb/collection/web.ini b/csdb/collection/web.ini index 7f7df11..2f648a4 100644 --- a/csdb/collection/web.ini +++ b/csdb/collection/web.ini @@ -121,7 +121,7 @@ Delphi10S=Y FPC=Y [CheckInternetConnection] -DescEx="Checks if a computer is connected to the internet by trying to resolve the name of the web host specified by AHost." +DescEx="

Checks if a computer is connected to the internet by trying to resolve the name of the web host specified by AHost.

" Extra="

AHost should be the web address of some suitable site with a fast response in the form www.example.com.

Note: Users of Unicode Delphi compilers please note that the use of PAnsiChar is necessary here. Don't pass a pointer to a Unicode string.

Contributed by Irwin Scollar.

" Units=WinSock Snip=370.dat diff --git a/csdb/collection/windows.ini b/csdb/collection/windows.ini index 16d96f4..fffbbc9 100644 --- a/csdb/collection/windows.ini +++ b/csdb/collection/windows.ini @@ -6,7 +6,7 @@ # https://gravatar.com/delphidabbler [ClientRectToScreen] -DescEx="Translates the rectangle CliRect, which has coordinates relative to the client area of control Ctrl, into global screen coordinates and returns the result." +DescEx="

Translates the rectangle CliRect, which has coordinates relative to the client area of control Ctrl, into global screen coordinates and returns the result.

" Units=Controls,Windows SeeAlso=CtrlBoundsToScreen Snip=262.dat @@ -29,7 +29,7 @@ Delphi10S=Y FPC=N [CtrlBoundsToScreen] -DescEx="Returns the bounding rectangle of control Ctrl in terms of global screen co-ordinates." +DescEx="

Returns the bounding rectangle of control Ctrl in terms of global screen co-ordinates.

" Units=Classes,Controls,Windows Depends=ClientRectToScreen SeeAlso=ClientRectToScreen @@ -264,7 +264,7 @@ Delphi10S=Y FPC=Y [MemoCursorPos] -DescEx="Returns a TPoint value containing the coordinates of the cursor in the given memo control." +DescEx="

Returns a TPoint value containing the coordinates of the cursor in the given memo control.

" Extra="

Based on code contributed by Shlomo Abuisak.

" Units=Messages,Windows,StdCtrls Snip=334.dat @@ -287,7 +287,7 @@ Delphi10S=Y FPC=N [ResourceExists] -DescEx="Checks if a resource with name ResName and type ResType exists in the module with handle Module." +DescEx="

Checks if a resource with name ResName and type ResType exists in the module with handle Module.

" Extra="

This routine is language agnostic: it takes no account of the language of the required resource.

" Units=Windows SeeAlso=ResourceExistsEx @@ -311,7 +311,7 @@ Delphi10S=Y FPC=Y [ResourceExistsEx] -DescEx="Checks if a resource with name ResName, type ResType and language ID Language exists in the module with handle Module." +DescEx="

Checks if a resource with name ResName, type ResType and language ID Language exists in the module with handle Module.

" Units=Windows SeeAlso=ResourceExists Snip=199.dat @@ -358,7 +358,7 @@ Delphi10S=Y FPC=Y [SetTransparencyLevel] -DescEx="Sets the transparency level of the window with handle HWnd to the value given by Level." +DescEx="

Sets the transparency level of the window with handle HWnd to the value given by Level.

" Extra="

This function requires that the window supports layers. The transparency level is in the range [0..255].

" Units=Windows Depends=WindowSupportsLayers @@ -430,7 +430,7 @@ Delphi10S=Y FPC=N [WinControlScrollbars] -DescEx="Returns a value that specifies which, if any, scroll bars are displayed by the given TWinControl." +DescEx="

Returns a value that specifies which, if any, scroll bars are displayed by the given TWinControl.

" Units=Controls,StdCtrls Depends=WindowScrollbars SeeAlso=HScrollbarHeight,VScrollbarWidth,WindowScrollbars @@ -550,7 +550,7 @@ Delphi10S=Y FPC=N [IsIntResource] -DescEx="Checks whether ResID is an integer identifier for a resource." +DescEx="

Checks whether ResID is an integer identifier for a resource.

" Extra="

Emulates the Windows IS_INTRESOURCE macro.

" SeeAlso=IsEqualResID,ResourceIDToStr Units=Windows @@ -598,7 +598,7 @@ Delphi10S=Y FPC=Y [MakeLangID] -DescEx="Creates and returns a language identifier from primary language identifier P and sublanguage identifier S." +DescEx="

Creates and returns a language identifier from primary language identifier P and sublanguage identifier S.

" Extra="

Emulates the Windows MAKELANGID macro.

" SeeAlso=MakeLCID,PrimaryLangID,SubLangID Snip=168.dat @@ -621,7 +621,7 @@ Delphi10S=Y FPC=Y [MakeLCID] -DescEx="Creates and returns a locale identifier from language identifier LanguageID and sort order identifier SortID." +DescEx="

Creates and returns a locale identifier from language identifier LanguageID and sort order identifier SortID.

" Extra="

Emulates the Windows MAKELCID macro.

" Units=Windows SeeAlso=MakeLangID,PrimaryLangID,SubLangID @@ -668,7 +668,7 @@ Delphi10S=Y FPC=Y [REWordAtPos] -DescEx="Returns the word at coordinates (X,Y) in rich edit control RE." +DescEx="

Returns the word at coordinates (X,Y) in rich edit control RE.

" Extra="

Note: This function assumes that words are separated by one or more of the following white space characters: space, TAB, LF, VT, FF and CR.

Adapted from code contributed by Arno Wolff.

" Units=SysUtils,Classes,Messages,Windows,ComCtrls,RichEdit Depends=IsWhiteSpace diff --git a/csdb/collection/winsys.ini b/csdb/collection/winsys.ini index fbe43fc..9b7fc04 100644 --- a/csdb/collection/winsys.ini +++ b/csdb/collection/winsys.ini @@ -52,7 +52,7 @@ Delphi10S=Y FPC=Y [GetCurrentVersionRegStr] -DescEx="Returns the string value named by ValName from the Windows "CurrentVersion" registry key." +DescEx="

Returns the string value named by ValName from the Windows "CurrentVersion" registry key.

" Units=Windows Depends=GetRegistryString Snip=038.dat @@ -261,7 +261,7 @@ Delphi10S=Y FPC=Y [ScreenResolution] -DescEx="Returns the current screen resolution in a TSize record whose cx and cy fields give the screen width and height respectively." +DescEx="

Returns the current screen resolution in a TSize record whose cx and cy fields give the screen width and height respectively.

" Units=Windows,Types Snip=509.dat Delphi2=N From c7706d5d93a09651db45a8024dc4a398f74a9046 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 26 Dec 2021 13:17:23 +0000 Subject: [PATCH 05/99] Revise docs re collection v2.1.0 changes Changes were: * DescEx now required * Desc, Comments, Comments_URL and Credits tags now deprecated --- csdb/docs/collection-format.html | 80 ++++++++++++++++++++++++++++---- 1 file changed, 70 insertions(+), 10 deletions(-) diff --git a/csdb/docs/collection-format.html b/csdb/docs/collection-format.html index bc26092..34ac514 100644 --- a/csdb/docs/collection-format.html +++ b/csdb/docs/collection-format.html @@ -156,16 +156,16 @@

[snippet-name]
 DisplayName=<snippet-display-name>
-Desc=<description-text>
+Desc=<description-text> *
 DescEx=<description-REML>
 Snip=<snippet-file-name>
 Units=<required-units>
 Depends=<required-snippets>
 SeeAlso=<cross-referenced-snippets>
 Extra=<extra-info-REML>
-Credits=<credits-text>
-Credits_URL=<url-used-in-credits>
-Comments=<comments-text>
+Credits=<credits-text> *
+Credits_URL=<url-used-in-credits> *
+Comments=<comments-text> *
 Delphi2=<"Y"|"N"|"Q"|"W">
 Delphi3=<"Y"|"N"|"Q"|"W">
 Delphi4=<"Y"|"N"|"Q"|"W">
@@ -190,6 +190,11 @@ 

FPC=<"Y"|"N"|"Q"|"W"> Kind=<"freeform"|"routine"|"type"|"const"|"class"|"unit"> TestInfo=<"none"|"basic"|"advanced">

+

The sections in these files are named with identifiers that uniquely identify a snippet. This must be a valid Unicode Pascal identifier. The keys in a section have the following purpose:

@@ -207,22 +212,44 @@

Desc

+

Description of the snippet as plain text.

- Desc is ignored if a non-empty DescEx key is present. At least one of the Desc or DescEx keys are required to be present and non-empty. + For v2.0.x only, Desc is ignored if a non-empty DescEx key is present. At least one of the Desc or DescEx keys are required to be present and non-empty.

DescEx
+

Formatted description of the snippet using REML1 code.

- May be empty, in which case the Desc key is used. Desc is ignored if DescEx has a non-empty value. At least one of the Desc or DescEx keys are required to be present and non-empty. + For version 2.0.x only, DescEx may be empty, in which case the Desc key is used. Desc is ignored if DescEx has a non-empty value. At least one of the Desc or DescEx keys are required to be present and non-empty.

@@ -291,16 +318,27 @@

Provides extra information about the snippet. When present the value must be a valid string of REML1 code.

- May be omitted or empty. In this case any extra information is generated from the values of any Comments, Credits and Credits_URL keys, if present. + May be omitted or empty.

- When Extra has a non-empty value the Comments, Credits and Credits_URL keys are ignored. + For v2.0.x only, if and only if Extra is empty, extra information is generated from the Comments, Credits and Credits_URL key values.

Credits2
+

Text that notes any credits / acknowledgements. Credits may optionally contain one (and only one) section of text delimited by [ and ] characters that indicate the presence of a hyperlink. The enclosed text is used as the text of a hyperlink whose URL must be specified in the Credits_URL key.

@@ -312,6 +350,17 @@

Credits_URL2

+

The URL used in any hyperlink present in the Credits key.

@@ -323,6 +372,17 @@

Comments
+

Text string containing any additional comments about the snippet.

@@ -650,11 +710,11 @@

  • REML is a text markup language used to format text. REML version 4 is supported. The REML format is documented in reml.html. -

    +

  • - Here is an example of how the Credits and Credits_URL keys work together. + Here is an example of how the deprecated Credits and Credits_URL keys work together.

    If Credits="See [example 1]" and Credits_URL="http://example.com" and the Extra key is empty or missing then the extra REML code generated will be See <a href="example.com">example 1</a>. From 87f8b38dc487c26e13608bbe267710ff1793860c Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 26 Dec 2021 13:26:39 +0000 Subject: [PATCH 06/99] Update REML docs Note that, from REML v2.1.0, all REML in code snippets database collection is fully REML conformant. --- csdb/docs/reml.html | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/csdb/docs/reml.html b/csdb/docs/reml.html index 98d3475..1699547 100644 --- a/csdb/docs/reml.html +++ b/csdb/docs/reml.html @@ -135,7 +135,17 @@

    <p>wrong </p><heading>blah</heading><p>wrong </p><p>blah</p><p>wrong</p>

    From 2ae3a97f4f86a105913a20dc22f660d6d1144531 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 26 Dec 2021 13:48:20 +0000 Subject: [PATCH 07/99] Update change log re v2.1.0 changes --- csdb/CHANGELOG.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/csdb/CHANGELOG.md b/csdb/CHANGELOG.md index bf5d536..cd8fdc3 100644 --- a/csdb/CHANGELOG.md +++ b/csdb/CHANGELOG.md @@ -8,6 +8,16 @@ From v2.0.0 all notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## v2.1.0 of 2021/12/26 + +* Deprecated `Desc`, `Comments`, `Credits` & `Credits_URL` keys in Code Snippets Database collection and changed `DescEx` key to be required. Made following changes to `.ini` files as a consequence: + * Changed all `Desc` keys to `DescEx` keys and removed all `Desc` keys as a result. + * Converted content of all `Comments`, `Credits` & `Credits_URL` keys to `Extra` key values and removed the deprecated keys. +* Made all `DescEx` and `Extra` values fully REML v4 compliant by ensuring all content is wrapped in `

    `..`

    ` tags. +* Fixed errors in `.ini` files. Fixes [issue #6](https://github.com/delphidabbler/code-snippets/issues/6). +* Updated a small number of snippet descriptions and extra information. +* Updated documentation in `collection-format.html` and `reml.html` to reflect the above changes. + ## v2.0.1 of 2021/10/12 * Add new unit tests and demo code for _some_ snippets from the database. All such code was added to a new `tests` directory. See `tests/README.md` for details. From ba4cfaa73d88b9c6feb9f7d2049181e51509d7f7 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sun, 26 Dec 2021 13:48:32 +0000 Subject: [PATCH 08/99] Bump version number to v2.1.0 --- csdb/collection/VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csdb/collection/VERSION b/csdb/collection/VERSION index 7ceb00b..4c71058 100644 --- a/csdb/collection/VERSION +++ b/csdb/collection/VERSION @@ -1 +1 @@ -2.0.1 +2.1.0 From 96bbd60fa3d33adce918a33479129817b15d9742 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Wed, 29 Dec 2021 09:50:01 +0000 Subject: [PATCH 09/99] Fix malformed & nested

    tags. --- csdb/collection/graphics.ini | 2 +- csdb/collection/shell.ini | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/csdb/collection/graphics.ini b/csdb/collection/graphics.ini index cfef4c8..f0d493f 100644 --- a/csdb/collection/graphics.ini +++ b/csdb/collection/graphics.ini @@ -370,7 +370,7 @@ FPC=N [EllipsifyText] DescEx="

    Shortens the given text if necessary to fit within MaxWidth pixels on the given canvas.

    If AsPath is True the text is shortened path-wise by inserting an ellipsis in the text body, otherwise it is trunctated and an ellipsis is appended.

    " -Extra="Provided by Bill Miller. Date: Wed, 29 Dec 2021 10:00:32 +0000 Subject: [PATCH 10/99] Update change log re hotfix release 2.1.1 changes --- csdb/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/csdb/CHANGELOG.md b/csdb/CHANGELOG.md index cd8fdc3..e27edee 100644 --- a/csdb/CHANGELOG.md +++ b/csdb/CHANGELOG.md @@ -8,6 +8,10 @@ From v2.0.0 all notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## v2.1.1 of 2021/12/29 (HOTFIX) + +* Fixed malformed REML tags. Fixes [issue #7](https://github.com/delphidabbler/code-snippets/issues/7). + ## v2.1.0 of 2021/12/26 * Deprecated `Desc`, `Comments`, `Credits` & `Credits_URL` keys in Code Snippets Database collection and changed `DescEx` key to be required. Made following changes to `.ini` files as a consequence: From 2b75959e4f33a6272f2de535016d5957592c6654 Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Wed, 29 Dec 2021 10:01:22 +0000 Subject: [PATCH 11/99] Bump version number to v2.1.1 --- csdb/collection/VERSION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/csdb/collection/VERSION b/csdb/collection/VERSION index 4c71058..1ac95c1 100644 --- a/csdb/collection/VERSION +++ b/csdb/collection/VERSION @@ -1 +1 @@ -2.1.0 +2.1.1 From 688a482b86a3eba5f86e07de97f125b953d61a08 Mon Sep 17 00:00:00 2001 From: Peter Johnson <5164283+delphidabbler@users.noreply.github.com> Date: Mon, 7 Nov 2022 23:27:40 +0000 Subject: [PATCH 12/99] Update code-snippets/csdb/MakeRelease.sh Update header comments to note the 3rd zip file containing tests. Some other minor edits. Update file's copyright date. --- csdb/MakeRelease.sh | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/csdb/MakeRelease.sh b/csdb/MakeRelease.sh index d42783b..a68cc3b 100644 --- a/csdb/MakeRelease.sh +++ b/csdb/MakeRelease.sh @@ -5,13 +5,14 @@ # # Build tool for Windows to package up files ready for release. # -# This file is licensed under the MIT license, copyright © 2020-2021 Peter +# This file is licensed under the MIT license, copyright © 2020-2022 Peter # Johnson, https://gravatar.com/delphidabbler # # -# Two packages are made, each in a zip file: one containing the collection and -# the other containing documentation. Both zip files are written to the -# _release sub-folder in the collection's home directory. +# Three packages are made, each in a zip file: one containing the +# collection, another containing documentation and a third containing tests. +# All zip files are written to the _release sub-folder in the collection's +# home directory. # # Any pre-existing _release sub-folder is cleared before the zip files are # created. @@ -19,9 +20,9 @@ # Requirements: # # - The release version number must be passed to this script as a command -# line. +# line parameter. # -# - The zip utility is required to zip up the files. +# - The zip utility program is required to zip up the files. # # -------------------------------------------------------------------------- From 7cfd48c561f585d4bdbcd91281577504ef46bcbc Mon Sep 17 00:00:00 2001 From: Peter Johnson <5164283+delphidabbler@users.noreply.github.com> Date: Mon, 7 Nov 2022 23:46:42 +0000 Subject: [PATCH 13/99] Update code-snippets/csdb/README.md Correct name of `collection` directory in License section. --- csdb/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/csdb/README.md b/csdb/README.md index 265c9f3..e6b7f69 100644 --- a/csdb/README.md +++ b/csdb/README.md @@ -46,8 +46,8 @@ The project's change log can be found in `CHANGELOG.md` in the collection's base ## License -All snippets in this collection (stored in `.dat` files in the `collections` directory) are licensed under the MIT license and are copyright © 2005-2020, [Peter Johnson](https://gravatar.com/delphidabbler) and Contributors. The full license and a list of contributors can be found in the `LICENSE` and `CONTRIBUTORS` files in the `collection` sub-directory. +All snippets in this collection (stored in `.dat` files in the `collection` directory) are licensed under the MIT license and are copyright © 2005-2020, [Peter Johnson](https://gravatar.com/delphidabbler) and Contributors. The full license and a list of contributors can be found in the `LICENSE` and `CONTRIBUTORS` files in the `collection` sub-directory. -Certain files in the `tests` directory contain copies of snippets extracted from the collection. These files are identified as such in the comments at the start of the file. The files are licensed under the same license as the `.dat` files in the `collections` directory. See the paragraph above for details. +Certain files in the `tests` directory contain copies of snippets extracted from the collection. These files are identified as such in the comments at the start of the file. The files are licensed under the same license as the `.dat` files in the `collection` directory. See the paragraph above for details. All other files in this project are licensed under the MIT license and are copyright © 2020-2021, [Peter Johnson](https://gravatar.com/delphidabbler). From 0e249c6c82ef205cb40d225b2733eb50bf28c1dd Mon Sep 17 00:00:00 2001 From: Peter Johnson <5164283+delphidabbler@users.noreply.github.com> Date: Fri, 7 Jul 2023 01:58:33 +0100 Subject: [PATCH 14/99] Update csdb/docs/index.html Fix error in header comments - described file as REML docs, not index page --- csdb/docs/index.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/csdb/docs/index.html b/csdb/docs/index.html index 75c4382..ace0afc 100644 --- a/csdb/docs/index.html +++ b/csdb/docs/index.html @@ -4,8 +4,7 @@ * This file copyright (C) 2020-2021, Peter Johnson (gravatar.com/delphidabbler) * and is licensed under the MIT License: https://opensource.org/licenses/MIT * - * DelphiDabbler Code Snippets Database Documentation: REML markup language - * documentation. + * DelphiDabbler Code Snippets Database Documentation: Index page --> From f25f5391ad23b7c87cc9f36bcfa06a982fceb48e Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sat, 15 Jul 2023 08:18:32 +0100 Subject: [PATCH 15/99] Update main project license copyright date --- LICENSE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE.md b/LICENSE.md index ba1b023..a0fbd8c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -**Copyright (c) 2020 Peter Johnson (https://en.gravatar.com/delphidabbler)** +**Copyright (c) 2020-2023 Peter Johnson (https://en.gravatar.com/delphidabbler)** Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: From 7d38ea4daf9c2f4ee66b5d031267126ff520d29c Mon Sep 17 00:00:00 2001 From: delphidabbler <5164283+delphidabbler@users.noreply.github.com> Date: Sat, 15 Jul 2023 08:22:03 +0100 Subject: [PATCH 16/99] Bring csdb copyright dates up to date In README.md: Snippet license copyright date corrected to include 2021, which was last time collection was updated. Project license copyright date updated to include 2023. Copyright dates updated to include 2023 for files in csdb/docs that have been updated since 2020 Updated copyright date in MakeRelease.sh --- csdb/MakeRelease.sh | 2 +- csdb/README.md | 4 ++-- csdb/docs/collection-format.html | 4 ++-- csdb/docs/index.html | 2 +- csdb/docs/reml.html | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/csdb/MakeRelease.sh b/csdb/MakeRelease.sh index a68cc3b..9433301 100644 --- a/csdb/MakeRelease.sh +++ b/csdb/MakeRelease.sh @@ -5,7 +5,7 @@ # # Build tool for Windows to package up files ready for release. # -# This file is licensed under the MIT license, copyright © 2020-2022 Peter +# This file is licensed under the MIT license, copyright © 2020-2023 Peter # Johnson, https://gravatar.com/delphidabbler # # diff --git a/csdb/README.md b/csdb/README.md index e6b7f69..16b53b3 100644 --- a/csdb/README.md +++ b/csdb/README.md @@ -46,8 +46,8 @@ The project's change log can be found in `CHANGELOG.md` in the collection's base ## License -All snippets in this collection (stored in `.dat` files in the `collection` directory) are licensed under the MIT license and are copyright © 2005-2020, [Peter Johnson](https://gravatar.com/delphidabbler) and Contributors. The full license and a list of contributors can be found in the `LICENSE` and `CONTRIBUTORS` files in the `collection` sub-directory. +All snippets in this collection (stored in `.dat` files in the `collection` directory) are licensed under the MIT license and are copyright © 2005-2021, [Peter Johnson](https://gravatar.com/delphidabbler) and Contributors. The full license and a list of contributors can be found in the `LICENSE` and `CONTRIBUTORS` files in the `collection` sub-directory. Certain files in the `tests` directory contain copies of snippets extracted from the collection. These files are identified as such in the comments at the start of the file. The files are licensed under the same license as the `.dat` files in the `collection` directory. See the paragraph above for details. -All other files in this project are licensed under the MIT license and are copyright © 2020-2021, [Peter Johnson](https://gravatar.com/delphidabbler). +All other files in this project are licensed under the MIT license and are copyright © 2020-2023, [Peter Johnson](https://gravatar.com/delphidabbler). diff --git a/csdb/docs/collection-format.html b/csdb/docs/collection-format.html index 34ac514..5201abe 100644 --- a/csdb/docs/collection-format.html +++ b/csdb/docs/collection-format.html @@ -1,8 +1,8 @@