mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-09 01:28:19 +02:00
docs: fixed xml
git-svn-id: branches/fixes_2_0@60957 -
This commit is contained in:
mattias
parent
322d482ec2
commit
1b23f4ee0d
@ -11,9 +11,9 @@
|
||||
<p>
|
||||
lazutf8classes implements UTF-8-enabled classes and routines, including: TFileStreamUTF8, TMemoryStreamUTF8, and TStringListUTF8.
|
||||
</p>
|
||||
<remarks>
|
||||
<remark>
|
||||
lazutf8classes has an implementation dependency on the lazfileutils unit.
|
||||
</remarks>
|
||||
</remark>
|
||||
</descr>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
@ -45,7 +45,7 @@
|
||||
AFilename contains the name for the file (created using FileCreateUTF8 or opened using FileOpenUTF8).
|
||||
</p>
|
||||
<p>
|
||||
Mode is the File Mode for the specified file and contains one of the follwing values:
|
||||
Mode is the File Mode for the specified file and contains one of the following values:
|
||||
</p>
|
||||
<dl>
|
||||
<dt>fmCreate</dt>
|
||||
@ -76,14 +76,14 @@
|
||||
Please note that sharing is advisory on Unix-like platforms.
|
||||
</p>
|
||||
<p>
|
||||
Rights is the file rights for the specified file. The default value is 438 (Decimal) or &666 (Octal) and indicates that the owner, group, and others can read and/or write to the file. The value in Rights is ignored on the Windows platform.
|
||||
Rights is the file rights for the specified file. The default value is 438 (Decimal) or &666 (Octal) and indicates that the owner, group, and others can read and/or write to the file. The value in Rights is ignored on the Windows platform.
|
||||
</p>
|
||||
<p>
|
||||
Create instantiates a THandleStream (owned by the current class instance) which uses the valid file handle.
|
||||
</p>
|
||||
<remarks>
|
||||
<remark>
|
||||
Please note that Create can raise an exception if the file handle from FileCreateUTF8 or FileOpenUTF8 is invalid (contains feInvalidHandle).
|
||||
</remarks>
|
||||
</remark>
|
||||
</descr>
|
||||
<errors>
|
||||
<dl>
|
||||
@ -121,7 +121,8 @@
|
||||
Name of the file where stream content is read or written
|
||||
</short>
|
||||
<descr>
|
||||
FIleName is a read-only String property that contains the name of the file where stream content is read or written. FileName can contain UTF-8-encoded characters.
|
||||
FileName is a read-only String property that contains the name of the file where stream content is read or
|
||||
written. FileName can contain UTF-8-encoded characters.
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -192,7 +193,8 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
SaveToFile is a procedure used to save the content in the string list to the specified file name. FileName can contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to create the file specified in FIleName, and calls the SaveToStream method to store values from the string list.
|
||||
SaveToFile is a procedure used to save the content in the string list to the specified file name. FileName can
|
||||
contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to create the file specified in FileName, and calls the SaveToStream method to store values from the string list.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -259,7 +261,8 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
LoadStringsFromFileUTF8 is a procedure used to load the content for a string list from the specified file name. List is the TStrings decendant where the content from FileName is stored. FIleName can contain UTF-8-encoded characters. LoadStringsFromFileUTF8 creates an internal TStringListUTF8 instance (when needed) that is used to load the content in FileName, and calls the Assign method in List to store the values.
|
||||
LoadStringsFromFileUTF8 is a procedure used to load the content for a string list from the specified file name.
|
||||
List is the TStrings decendant where the content from FileName is stored. FileName can contain UTF-8-encoded characters. LoadStringsFromFileUTF8 creates an internal TStringListUTF8 instance (when needed) that is used to load the content in FileName, and calls the Assign method in List to store the values.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -282,7 +285,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
SaveStringsToFileUTF8 is a procedure used to save the content in the List to the specified file name. List is a TStrings desccendant with the content to store in the specified file name. FileName can contaIn UTF-8-encoded character values. SaveStringsToFileUTF8 uses a TStringListUTF8 (when needed) to store the content in the string list to the specified FileName.
|
||||
SaveStringsToFileUTF8 is a procedure used to save the content in the List to the specified file name. List is a TStrings desccendant with the content to store in the specified file name. FileName can contain UTF-8-encoded character values. SaveStringsToFileUTF8 uses a TStringListUTF8 (when needed) to store the content in the string list to the specified FileName.
|
||||
</p>
|
||||
</descr>
|
||||
<seealsao></seealsao>
|
||||
@ -308,14 +311,14 @@
|
||||
CompareStringListItemsUTF8LowerCase is an Integer function used to perform lowercase comparison of string values in a string list. List is the TStrings descendant with values for the comparison. Index1 and Index2 specify the ordinal positions in List for strings used in the comparison.
|
||||
</p>
|
||||
<p>
|
||||
CompareStringListItemsUTF8LowerCase converts the string values to lowercase using UTF8LowerCase, and calls the CompareStr function to perform the comparison. The return vaue is in the following ranges:
|
||||
CompareStringListItemsUTF8LowerCase converts the string values to lowercase using UTF8LowerCase, and calls the CompareStr function to perform the comparison. The return value is in the following ranges:
|
||||
</p>
|
||||
<dl>
|
||||
<dt><code> <0 </code></dt>
|
||||
<dt><code> <0 </code></dt>
|
||||
<dd>String at Index1 comes before String at Index2</dd>
|
||||
<dt><code> 0 </code></dt>
|
||||
<dd>Strings have the same value</dd>
|
||||
<dt><code> >0 </code> </dt>
|
||||
<dt><code> >0 </code> </dt>
|
||||
<dd>String at Index1 comes after String at Index2</dd>
|
||||
</dl>
|
||||
</descr>
|
||||
|
||||
@ -81,6 +81,7 @@
|
||||
<descr>
|
||||
<p>
|
||||
SetCommandLineUTF8 is the write access specifier for the CommandLine property.
|
||||
</p>
|
||||
</descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
@ -186,7 +187,7 @@
|
||||
<element name="TProcessUTF8.Create" link="#fcl.Process.TProcess.Create">
|
||||
<short>
|
||||
Constructor for the class instance
|
||||
</short>
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create is the constructor for the class instance, Create calls the inherited constructor using AOwner as the owner of the class instance. Create ensures that resources are allocated for the Environment and Parameters properties.
|
||||
@ -220,7 +221,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Execute causes the Executable for the process to be started with the Parameters and Environment specified in the respective properties. Execute calls the UpdateEnvironment method to pass the values in Parameters and Environment to the ancestor class. Execute calls gthe inherited Execute method.
|
||||
Execute causes the Executable for the process to be started with the Parameters and Environment specified in the respective properties. Execute calls the UpdateEnvironment method to pass the values in Parameters and Environment to the ancestor class. Execute calls the inherited Execute method.
|
||||
</p>
|
||||
</descr>
|
||||
<errors></errors>
|
||||
@ -233,9 +234,9 @@
|
||||
</short>
|
||||
<descr>
|
||||
<!-- Note: deprecated in TProcess 2.5.1-->
|
||||
<remarks>
|
||||
Please note that ApplicationName has been deprecated in TProcess (the ancestor class) since FPC version 2.5.1. ApplicationName has been superseded by the Executable and Parameters properties.
|
||||
</remarks>
|
||||
<remark>
|
||||
Please note that ApplicationName has been deprecated in TProcess (the ancestor class) since FPC version 2.5.1. ApplicationName has been superseded by the Executable and Parameters properties.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -250,9 +251,9 @@
|
||||
<p>
|
||||
Setting the value in CommandLine causes the value in Executable to be updated, and the value in Parameters is cleared and reloaded as necessary.
|
||||
</p>
|
||||
<remarks>
|
||||
Please note that CommandLine has been deprecated in TProcess (the ancestor class) since FPC version 2.5.1. To avoid problems with command line options with spaces in them, and the quoting problems that this entails, it has been superseded by the Executable and Parameters properties. Use these properties instead of CommandLine.
|
||||
</remarks>
|
||||
<remark>
|
||||
Please note that CommandLine has been deprecated in TProcess (the ancestor class) since FPC version 2.5.1. To avoid problems with command line options with spaces in them, and the quoting problems that this presents, it has been superseded by the Executable and Parameters properties. Use these properties instead of CommandLine.
|
||||
</remark>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -368,7 +369,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
RunCmdFromPath is used to execute a command which can be found in the current PATH environment. For example, the following locates and executes the /bin/ls command with the specified arguments:
|
||||
RunCmdFromPath is used to execute a command which can be found in the current <var>PATH</var> environment. For example, the following locates and executes the /bin/ls command with the specified arguments:
|
||||
</p>
|
||||
<code>
|
||||
RunCmdFromPath('ls', '-l /home');
|
||||
|
||||
Loading…
Reference in New Issue
Block a user