<class namespace="ZLib">TCustomZlibStream</class> is an abstract class, which forms the base for TCompressionStream and TDecompressionStream. Since it is an abstract class, instances of <class namespace="ZLib">TCustomZlibStream</class> cannot be directly instantiated. <class namespace="ZLib">TCustomZlibStream</class> serves as the starting point for your own custom data compression streams.</para>
</comments>
</member>
<member name="M:ZLib.ZLib.Create">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes an instance of a <method namespace="ZLib" class="TCustomZlibStream">TCustomZlibStream</method>-derived object.</para>
<method namespace="ZLib" class="TCustomZlibStream">TCustomZlibStream</method> is intended to be an abstract base class for your own custom data compression streams. Its constructor is protected; therefore you cannot directly instantiate an instance of this class.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A concrete class derived from <method namespace="ZLib" class="TCustomZlibStream">TCustomZlibStream</method> should, in its own public constructor, call the constructor inherited from <method namespace="ZLib" class="TCustomZlibStream">TCustomZlibStream</method>.</para>
</comments>
</member>
<member name="M:ZLib.ZLib.Progress">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Calls the On<method namespace="ZLib" class="TCustomZlibStream">Progress</method> method, if assigned.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Derived compression stream classes should call the <method namespace="ZLib" class="TCustomZlibStream">Progress</method> method when reading or writing a large block of data in a single call. This gives the derived class an opportunity to update a user interface control such as a progress indicator.</para>
</comments>
</member>
<member name="E:ZLib.ZLib.OnProgress">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when reading or writing a large block of data in a single call.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Classes derived from <event namespace="ZLib" class="TCustomZlibStream">TCustomZlibStream</event> can use the <event namespace="ZLib" class="TCustomZlibStream">OnProgress</event> event to perform some action during a long read or write operation.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, the TCompressionStream class calls the <event namespace="ZLib" class="TCustomZlibStream">OnProgress</event> event handler, after the stream's output buffer has been filled and subsequently written. Similarly, the TDecompressionStream class calls the <event namespace="ZLib" class="TCustomZlibStream">OnProgress</event> event handler when its input buffer has been filled and is ready to be decompressed.</para>
<class namespace="ZLib">TCompressionStream</class> is a write-only, sequential access stream that compresses data as it is written. The compressed data is written to a separate stream, which is passed to the <class namespace="ZLib">TCompressionStream</class> constructor. <class namespace="ZLib">TCompressionStream</class> does not take ownership of the output stream; you are responsible for creating, initializing, and destroying the stream when it is no longer needed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reading from a <class namespace="ZLib">TCompressionStream</class> object will raise an exception of type ECompressionError, with the message string set to "Invalid Stream Operation." Similarly, a Seek operation causes an ECompressionError exception, however, you can perform a Seek operation with a zero offset from the current position. This will return the number of raw, uncompressed bytes that have been written to the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">You set the compression level to be used when you create the stream object. The possible compression levels are: clNone, clFastest, clDefault, and clMax.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the stream's output buffer is filled, a Write operation on <class namespace="ZLib">TCompressionStream</class> will write the contents of the buffer to the output stream, and then call the OnProgress event. You can use the OnProgress event to update a user interface control such as a progress indicator.</para>
</comments>
</member>
<member name="M:ZLib.ZLib.Read">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Raises an exception of type ECompressionError.</para>
<method namespace="ZLib" class="TCompressionStream">Read</method> operations are not permitted on a <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method> object. If a <method namespace="ZLib" class="TCompressionStream">Read</method> is attempted, an exception of type ECompressionError will be raised, with the message string "Invalid Stream Operation."</para>
<method namespace="ZLib" class="TCompressionStream">Write</method>s compressed data to the destination output stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="ZLib" class="TCompressionStream">Write</method> method causes the data in the supplied buffer to be written the output stream. Buffer contains the raw (uncompressed) data to be written, and Count contains the number of bytes to write.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method> object caches data internally; data is flushed to the output stream when the cache becomes full, and when the object is destroyed (if pending data remains in the cache).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After data is written to the output stream, the OnProgress event is called. This gives you an opportunity to update a user interface control such as a progress indicator. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The result of the <method namespace="ZLib" class="TCompressionStream">Write</method> method is the number of bytes transferred from the buffer</para>
</comments>
</member>
<member name="M:ZLib.ZLib.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Raises an exception of type ECompressionErrror.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method> is a write-only, sequential access data stream. Read operations are not permitted, and will raise an exception of type ECompressionError. Similarly, <method namespace="ZLib" class="TCompressionStream">Seek</method> operations will also raise an ECompressionError, with the message string "Invalid Stream Operation."</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">However, you can call the <method namespace="ZLib" class="TCompressionStream">Seek</method> method with an offset of zero, and the Origin set to soFromCurrent. In this special case, the <method namespace="ZLib" class="TCompressionStream">Seek</method> method will return the number of raw (uncompressed) bytes that have been written to the stream so far.</para>
<method namespace="ZLib" class="TCompressionStream">Create</method>s and initializes an instance of a <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="ZLib" class="TCompressionStream">Create</method> to instantiate a <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method> object. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The CompressionLevel parameter determines the type of compression algorithm to be used, and must be one of the following: clNone, clFastest, clDefault, or clMax.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Dest parameter is a TStream object; compressed data will be written to this stream.</para>
<method namespace="ZLib" class="TCompressionStream">Destroy</method>s the <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the <method namespace="ZLib" class="TCompressionStream">Destroy</method> method directly. Instead, use the Free method, as this will check the validity of the object before calling <method namespace="ZLib" class="TCompressionStream">Destroy</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All data in the <method namespace="ZLib" class="TCompressionStream">TCompressionStream</method>'s cache is flushed to the output stream when the object is destroyed.</para>
</comments>
</member>
<member name="P:ZLib.ZLib.CompressionRate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the percentage by which the data has been compressed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The compression rate is a read-only property. Its value is calculated and updated as data is written to the stream. For example, if a total of 100 raw (uncompressed) bytes have been written to the stream, and only 25 compressed bytes have been written out, then reading the <property namespace="ZLib" class="TCompressionStream">CompressionRate</property> property will return a value of 75.</para>
</comments>
</member>
<member name="E:ZLib.ZLib.OnProgress">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after the stream's output buffer has been written.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <event namespace="ZLib" class="TCompressionStream">OnProgress</event> event is automatically called from a Write operation, after the object's internal buffer has been filled and written to the output stream. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <event namespace="ZLib" class="TCompressionStream">OnProgress</event> event is of type TNotifierEvent. When your procedure is called, the Sender parameter will be set to the object itself. You can use the <event namespace="ZLib" class="TCompressionStream">OnProgress</event> event to update a user interface control, such as a progress indicator. You can use the Position property, inherited from TStream, to determine the number of raw (uncompressed) bytes written to the output stream so far.</para>
</comments>
</member>
<member name="T:ZLib.TDecompressionStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Decompresses data that was written to a TCompressionStream object.</para>
<class namespace="ZLib">TDecompressionStream</class> is the analog of the TCompressionStream class. It is a read-only, unidirectional stream; you can seek forward in the stream, but not backwards. A separate input stream provides the source data. The input stream will be a stream that was previously written to using a TCompressionStream object. The input stream is passed to the constructor, however, <class namespace="ZLib">TDecompressionStream</class> does not take ownership of this object. You are responsible for creating, initializing, and destroying the input stream when it is no longer needed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writing to the stream will raise an exception, as will requesting the size of the stream, and attempting to perform a Seek operation backwards or relative to the current position.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="ZLib">TDecompressionStream</class> object's OnProgress event is called when a block of data is read from the input stream. You can read the <class namespace="ZLib">TDecompressionStream</class> object's Position property to determine the number of raw, uncompressed bytes that have been read from the input stream so far.</para>
<method namespace="ZLib" class="TDecompressionStream">Read</method>s a block of data from the input stream, and decompresses it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="ZLib" class="TDecompressionStream">Read</method> method reads a block of data from the input stream, decompresses it, and stores it in the supplied buffer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Buffer parameter is the destination for the decompressed data.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Count is size of the destination buffer. The <method namespace="ZLib" class="TDecompressionStream">Read</method> operation will end when the destination buffer is full, or when there are no more bytes available to be read from the input stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After reading a block of data, the OnProgress event is fired by the object. This gives you a chance to update a user interface control such as a progress indicator during a long <method namespace="ZLib" class="TDecompressionStream">Read</method> operation.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The result of the <method namespace="ZLib" class="TDecompressionStream">Read</method> operation is the number of decompressed bytes placed into the destination buffer.</para>
</comments>
</member>
<member name="M:ZLib.ZLib.Write">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Raises an exception of type ECompressionError.</para>
<method namespace="ZLib" class="TDecompressionStream">Write</method> operations are not permitted on a <method namespace="ZLib" class="TDecompressionStream">TDecompressionStream</method> object. If a <method namespace="ZLib" class="TDecompressionStream">Write</method> operation is attempted, an exception of type ECompressionError will be raised, with the message string set to "Invalid Stream Operation."</para>
</comments>
</member>
<member name="M:ZLib.ZLib.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Resets the input stream, or moves the position forward.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A <method namespace="ZLib" class="TDecompressionStream">TDecompressionStream</method> is a read-only, unidirectional input stream. Write operations are not permitted, and will raise an exception of type ECompressionError. <method namespace="ZLib" class="TDecompressionStream">Seek</method> operations can be used to move the stream position forward, but a <method namespace="ZLib" class="TDecompressionStream">Seek</method> operation that attempts to move the position backwards will raise an ECompressionError exception, with the message string set to "Invalid Stream Operation."</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">You can call the <method namespace="ZLib" class="TDecompressionStream">Seek</method> method with an Offset of zero, and the Origin set to soFromBeginning. This has the effect of resetting the input stream, effectively rewinding the stream back to the beginning.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Otherwise, the Offset parameter must be a positive Longint, and the Origin parameter must be either soFromCurrent, or soFromBeginning. This has the effect of moving the input stream position forward, decompressing data as it goes.</para>
<method namespace="ZLib" class="TDecompressionStream">Create</method>s and initializes an instance of a <method namespace="ZLib" class="TDecompressionStream">TDecompressionStream</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="ZLib" class="TDecompressionStream">Create</method> to instantiate a <method namespace="ZLib" class="TDecompressionStream">TDecompressionStream</method> object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Source parameter is the source input stream, which was previously created with a TCompressionStream object. Subsequent Read operations will read data from the Source stream, and decompress the data on the fly.</para>
<method namespace="ZLib" class="TDecompressionStream">Destroy</method>s the <method namespace="ZLib" class="TDecompressionStream">TDecompressionStream</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the <method namespace="ZLib" class="TDecompressionStream">Destroy</method> method directly. Instead, use the Free method, as this will check the validity of the object before calling <method namespace="ZLib" class="TDecompressionStream">Destroy</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If there is data remaining in the object's internal buffer, the input stream position is moved backwards by the number of bytes remaining.</para>
</comments>
</member>
<member name="E:ZLib.ZLib.OnProgress">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after a block of data has been read from the input stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <event namespace="ZLib" class="TDecompressionStream">OnProgress</event> event is automatically called from a Read operation. The event occurs after a block of data has been read from the input stream, and before the data has been decompressed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <event namespace="ZLib" class="TDecompressionStream">OnProgress</event> event is of type TNotifierEvent. When your procedure is called, the Sender parameter will be set to the object itself. You can use the <event namespace="ZLib" class="TDecompressionStream">OnProgress</event> event to update a user interface control, such as a progress indicator. You can use the Position property, inherited from TStream, to determine the number of raw (uncompressed) bytes read from the input stream so far.</para>
</comments>
</member>
<member name="M:WinSpool.SetPrinter">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Replaces the global instance of TPrinter that manages interaction with the printer.</para>
<routine namespace="Printers">SetPrinter</routine> replaces the global TPrinter object with another TPrinter object. This allows applications to change the way they handle printing by substituting a TPrinter descendant for the default TPrinter object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">NewPrinter is the new TPrinter object that replaces the current global TPrinter object.</para>
<para>The global TPrinter object is freed automatically when the application shuts down. After a call to <routine namespace="Printers">SetPrinter</routine>, the printer that is returned is not automatically freed. It is the caller's responsibility to either free the return value, or replace it using another call to <routine namespace="Printers">SetPrinter</routine> and to free the substitute printer that the second <routine namespace="Printers">SetPrinter</routine> call returns.</para>
<routine namespace="Printers">SetPrinter</routine> is declared in the Printers unit. To use the <routine namespace="Printers">SetPrinter</routine> function, add Printers to the uses clause of your unit (Delphi) or include Printers.hpp in the source file (C++) .</para>
<type namespace="Qt">TPoint</type> type defines a pixel location onscreen.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <type namespace="Qt">TPoint</type> type defines a pixel location onscreen, with the origin in the top left corner. X specifies the horizontal coordinate of the point, Y specifies the vertical coordinate.</para>
<type namespace="Qt">TRect</type> represents the dimensions of a rectangle. The coordinates are specified as either four separate integers representing the left, top, right, and bottom sides, or as two points representing the locations of the top left and bottom right corners. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Typically, <type namespace="Qt">TRect</type> values represent pixel locations, where the origin of the pixel coordinate system is in the top left corner of the screen (screen coordinates) or the top left corner of a control's client area (client coordinates). When a <type namespace="Qt">TRect</type> value represents a rectangle on the screen, by convention the top and left edges are considered inside the rectangle and the bottom and right edges are considered outside the rectangle. This convention allows the width of the rectangle to be Right - Left and the height to be Bottom - Top.</para>
<type namespace="Qt">TSmallPoint</type> type defines a point with two 16-bit coordinates.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <type namespace="Qt">TSmallPoint</type> type defines a point where each coordinate is a 16-bit integer. x specifies the horizontal coordinate of the point, y specifies the vertical coordinate.</para>
</comments>
</member>
<member name="T:Windows.TOwnerDrawState">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates state information that can influence how an item is drawn.</para>
<type namespace="OleAuto">TOwnerDrawState</type> is used by event handlers in owner-draw controls to indicate the state of an item about to be drawn. It is a set that includes zero or more of the following:</para>
<routine namespace="SysUtils">DeleteFile</routine> deletes the file named by FileName from the disk. If the file cannot be deleted or does not exist, the function returns false.</para>
</comments>
</member>
<member name="M:Windows.FindClose">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Releases memory allocated by FindFirst.</para>
<routine namespace="SysUtils">InterlockedDecrement</routine> increments I in such a way that other threads cannot access I until the operation is complete. The return value of <routine namespace="SysUtils">InterlockedDecrement</routine> has the same sign as the decremented result, but not necessarily the exact same value.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <routine namespace="SysUtils">InterlockedDecrement</routine> defined in the SysUtils unit is only available on Linux. On Windows, applications use the Win32 API with the same name.</para>
</comments>
</member>
<member name="M:Windows.InterlockedExchange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Swaps two integer values in a thread-safe manner.</para>
<routine namespace="SysUtils">InterlockedExchange</routine> exchanges the values of A and B in such a way that other threads cannot access either variable until the operation is complete. The return value of <routine namespace="SysUtils">InterlockedExchange</routine> is the new value of B.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <routine namespace="SysUtils">InterlockedExchange</routine> defined in the SysUtils unit is only available on Linux. On Windows, applications use the Win32 API with the same name.</para>
</comments>
</member>
<member name="M:Windows.InterlockedExchangeAdd">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds two integers in a thread-safe manner.</para>
<routine namespace="SysUtils">InterlockedExchangeAdd</routine> adds B to A in such a way that other threads cannot access either variable until the operation is complete. The return value of <routine namespace="SysUtils">InterlockedExchangeAdd</routine> is the old value of A.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <routine namespace="SysUtils">InterlockedExchangeAdd</routine> defined in the SysUtils unit is only available on Linux. On Windows, applications use the Win32 API with the same name.</para>
</comments>
</member>
<member name="M:Windows.InterlockedIncrement">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Increments an integer value in a thread-safe manner.</para>
<routine namespace="SysUtils">InterlockedIncrement</routine> increments I in such a way that other threads cannot access I until the operation is complete. The return value of InterlockedDrecrement has the same sign as the incremented result, but not necessarily the exact same value.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <routine namespace="SysUtils">InterlockedIncrement</routine> defined in the SysUtils unit is only available on Linux. On Windows, applications use the Win32 API with the same name.</para>
<routine namespace="System">GetLastError</routine> returns the last error reported by an API call into the operating system. Calling this function usually resets the operating system error state.</para>
</comments>
</member>
<member name="M:Windows.GetModuleFileName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the fully qualified name for a module, given its handle.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="System">GetModuleFileName</routine> to obtain the fully qualified name of a module, given its handle. The version of <routine namespace="System">GetModuleFileName</routine> defined in the System unit is available only on Linux. On Windows, use the Windows API with the same name instead.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Module is the handle of the module whose file name is required.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Buffer is a buffer that receives the file name.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">BufLen is the number of bytes in Buffer.</para>
<routine namespace="System">GetModuleFileName</routine> is not always successful. Depending on the way the application is called, the presence of the /proc file system, and other factors, there are times when <routine namespace="System">GetModuleFileName</routine> may return a name that is not fully qualified or in some cases, no file name at all. Be sure to check the results of this function before using the returned value.</para>
</warning>
</comments>
</member>
<member name="M:Windows.MulDiv">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Peforms a specified integer multiplication followed by a specified integer division.</para>
<routine namespace="Graphics">MulDiv</routine> returns the result from multiplying Number by Numerator and then (integer) dividing by Denominator. If Denominator is 0, <routine namespace="Graphics">MulDiv</routine> returns ΓÇô1.</para>
</comments>
</member>
<member name="M:Windows.Sleep">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Delay program execution for a specified number of microseconds.</para>
<routine namespace="SysUtils">Sleep</routine> pauses program executions as specified by the milliseconds parameter. Under Windows, <routine namespace="SysUtils">Sleep</routine> is just a link to the <routine namespace="SysUtils">Sleep</routine> function in the system API. Under Linux, <routine namespace="SysUtils">Sleep</routine> calls the usleep library routine.</para>
</comments>
</member>
<member name="M:Windows.EqualRect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether two TRect values are the same.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Types">EqualRect</routine> to compare two TRect values. <routine namespace="Types">EqualRect</routine> returns true if R1 and R2 are identical (same position and size), false if they are different.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Controls">GetCursorPos</routine> to determine the current screen coordinates of the mouse cursor.</para>
</comments>
</member>
<member name="M:Windows.IntersectRect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the intersection of two rectangles</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Types">IntersectRect</routine> to obtain the rectangle that is the intersection of R1 and R2. The intersection is returned as the Rect parameter.</para>
<routine namespace="Types">IntersectRect</routine> returns true if the two rectangles have a nonempty intersection. If R1 and R2 do not overlap, <routine namespace="Types">IntersectRect</routine> returns false, and the Rect parameter is set to a rectangle at position (0,0) with 0 Width and 0 Height.</para>
</comments>
</member>
<member name="M:Windows.IsRectEmpty">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates wither a specified rectangle has a positive width and height.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Types">IsRectEmpty</routine> to determine whether the rectangle specified by Rect encloses a positive amount of space.</para>
<routine namespace="Types">IsRectEmpty</routine> returns true if both the width and height of Rect are greater than 0. If either the width or height is less than or equal to 0, <routine namespace="Types">IsRectEmpty</routine> returns false. Note that this means non-normalized rectangles (rectangles with negative height or width) are considered empty. </para>
</comments>
</member>
<member name="M:Windows.OffsetRect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes the origin of a rectangle by a specified amount.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Types">OffsetRect</routine> to move the upper left corner of the rectangle specified by Rect while maintaining the same width and height. The left of the rectangle moves by DX while the top moves by DY.</para>
<routine namespace="Types">OffsetRect</routine> returns true if the Rect parameter is not nil(Delphi) or NULL (C++), false if it can't return a new rectangle because Rect is nil(Delphi) or NULL (C++). </para>
</comments>
</member>
<member name="M:Windows.PtInRect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a specified point lies inside a specified rectangle.</para>
<routine namespace="Types">PtInRect</routine> does not consider a point inside a rectangle if the rectangle has a negative width or height. A point is considered inside a rectangle if it lies on the left or top edge, but not if it lies on the right or bottom edge.</para>
</comments>
</member>
<member name="M:Windows.RegisterClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers a class of persistent object so that it's class type can be retrieved.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">RegisterClass</routine> to register a class with the streaming system. Form classes and component classes that are referenced in a form declaration (instance variables) are automatically registered. Any other classes used by an application must be explicitly registered by calling <routine namespace="Classes">RegisterClass</routine> if instances are to be saved.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once classes are registered, they can be loaded or saved by the component streaming system. IdentToInt returns nil (Delphi) or NULL (C++) when passed the class name of an unregistered class, and FindClass raises an exception for unregistered classes.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AClass parameter is the class that is descended from TPersistent. Put the call to <routine namespace="Classes">RegisterClass</routine> in a Register procedure. In Delphi, you can also put the call in the initialization section of the unit in which the class is defined. In C++, the call can also go in the namespace of the compilation unit that defines the class.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the class is already registered, <routine namespace="Classes">RegisterClass</routine> does nothing. If a different class with the same name is already registered, <routine namespace="Classes">RegisterClass</routine> raises an EFilerError exception.</para>
<para>Registering a component using the RegisterNoIcon or RegisterComponents method does not automatically register the class. It is still necessary to call <routine namespace="Classes">RegisterClass</routine> for components.</para>
</note>
</comments>
</member>
<member name="M:Windows.UnionRect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the union of two rectangles</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Types">UnionRect</routine> to obtain the smallest rectangle that includes both R1 and R2. The union is returned as the Rect parameter.</para>
<routine namespace="Types">UnionRect</routine> returns true if the resulting rectangle is nonempty. If the resulting rectangle as a width or height that is less than or equal to 0, <routine namespace="Types">UnionRect</routine> returns false.</para>
</comments>
</member>
<member name="M:Windows.UnregisterClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unregisters an object class.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">UnregisterClass</routine> to unregister an object class. When a class is unregistered, it can't be loaded or saved by the component streaming system.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After unregistering a class, its name can be reused to register another object class.</para>
<class namespace="asptlb">TASPMTSObject</class> is the base class for Active Server pages when using IIS 4 or IIS 5.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When you specify Object Context, the Active Server Object wizard generates a <class namespace="asptlb">TASPMTSObject</class> descendant to implement the Automation server object that is embedded in its generated Active Server Page. The generated Active Server Page instantiates the <class namespace="asptlb">TASPMTSObject</class> descendant by calling Server.CreateObject.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In addition to the support for the IDispatch interface that it inherits from TAutoObject, <class namespace="asptlb">TASPMTSObject</class> introduces several properties that surface the ASP intrinsics (built-in Application, Session, Server, Request, and Response objects).</para>
</comments>
</member>
<member name="P:AspTlb.AspTlb.Application">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the application-level interface for the server.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Application to access the ASP intrinsic Application object. This interface lets you share information among all users of a given application. An ASP-based application is defined as all the .asp files in a virtual directory and its subdirectories. Because the Application object can be shared by more than one user, the interface supplies Lock and Unlock methods to prevent multiple users from trying to alter a property simultaneously.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, see Microsoft's documentation of the Application Object.</para>
</comments>
</member>
<member name="P:AspTlb.AspTlb.Request">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the request message from the Web browser.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Request to access the ASP intrinsic Request object. This interface lets you access the HTTP headers of the request message from the Web browser that caused the Active Server page to be opened.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, see Microsoft's documentation of the Request Object.</para>
</comments>
</member>
<member name="P:AspTlb.AspTlb.Response">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the response message that is returned to the Web browser.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Response to access the ASP intrinsic Response object. This interface lets you send output to the client Web browser by specifying the HTTP headers or content of an HTTP response message that ASP sends to the Web browser. For example, you can add cookies or set the expiration of the response content, or redirect the request to a different URL.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, see Microsoft's documentation of the Response Object.</para>
</comments>
</member>
<member name="P:AspTlb.AspTlb.Session">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the interface for the ASP Session.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Session to access the ASP intrinsic Session object. This interface lets you store information needed for a particular user-session. Variables stored in the Session object are not discarded when the user jumps between pages in the application; instead, these variables persist for the entire user-session. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Web server automatically creates a Session object when a user who does not already have a session requests a Web page from the application. The server destroys the Session object when the session expires or is abandoned. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, see Microsoft's documentation of the Session Object.</para>
</comments>
</member>
<member name="P:AspTlb.AspTlb.Server">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to the interface for the ASP server.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Server to access the ASP intrinsic Server object. This interface lets you access the properties and methods of the ASP server. These include the time-out property that prevents Web browsers from waiting indefinitely if the Active Server Page hangs while trying to run its script. They also include utilities for working with HTML and URLs so that you do not need to explicitly encode escape characters for HTML reserved characters or URLs and can map virtual paths to physical paths.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information, see Microsoft's documentation of the Server Object.</para>
<class namespace="ScktComp">ESocketError</class> is the exception class for failures that occur when trying to create, use, or shut down Windows socket objects.</para>
<class namespace="ScktComp">ESocketError</class> is raised if </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A socket cannot be created.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A socket cannot be initialized.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A socket cannot be opened.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An application tries to change the properties of an already open socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A failure occurs when reading from or writing to a socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A socket cannot be properly closed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">There are two <class namespace="ScktComp">ESocketError</class> classes, one in the ScktComp unit and one in the Sockets unit. The two exception classes are identically defined and serve the same function for different categories of socket objects. The two definitions occur simply to ensure that <class namespace="ScktComp">ESocketError</class> is defined for all socket objects.</para>
<class namespace="scktcomp">TCustomWinSocket</class> introduces properties, events, and methods to describe an endpoint in a Windows socket connection. Descendants of <class namespace="scktcomp">TCustomWinSocket</class> are used by socket components to manage the Windows socket API calls and to store information about a socket communication link.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Windows socket encapsulates a set of communication protocols to allow the application to connect to other machines for reading or writing information. Windows sockets provide connections based on the TCP/IP protocol. They also allow connections that use the Xerox Network System (XNS), Digital's DECnet protocol, or Novell's IPX/SPX family. Sockets allow an application to form connections to other machines without being concerned with the details of the actual networking software.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <class namespace="scktcomp">TCustomWinSocket</class> represent different endpoints in socket connections. TClientWinSocket represents the client endpoint of a socket communication link to a server socket. TServerWinSocket represents the server endpoint of a listening connection. TServerClientWinSocket represents the server endpoint of a socket communication link to a client socket.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.InitSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates a windows Internet socket address structure from a description of the desired socket port.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can not call <method namespace="scktcomp" class="TCustomWinSocket">InitSocket</method>. It is called by the Open or Listen method to obtain a Windows Internet socket address structure for the parameters obtained from a socket component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter is the host name for the socket.<condition language="Delphi"/>The Address parameter is the IP address. The Service parameter is the service for which the socket is to used. The Port parameter is the port number for the socket. The Client parameter indicates whether the socket address structure is to be used by a client socket to describe the destination of a connection or by a server socket to describe the listening connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The host portion of the Windows Internet socket address is obtained from the host name if it is given. Otherwise the Address parameter is used. If Client is true, either the Name or the Address parameter must be specified. If Client is false, they may both be left blank to specify a server that listens on multiple addresses.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If port number for the Windows Internet socket address is obtained from the Service parameter if it is given. Otherwise, the Port parameter is used. One of these two parameters must be specified.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.LookupName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates the portion of a Windows Internet socket address structure that describes the host.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">LookupName</method> to obtain the Internet address associated with the system identified by the name parameter. <method namespace="scktcomp" class="TCustomWinSocket">LookupName</method> is used by InitSocket to generate the portion of the Windows Internet socket address structure that identifies the host.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.LookupService">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the port number associated with a specific service.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">LookupService</method> to obtain the standard port number for the service named by the service parameter. Windows provides a number of standard service names such as ftp, http, finger, or time. Each standard service is associated, by convention, with a specific port number. These standard port numbers allow client sockets to indicate the desired service by requesting a specific port number. They allow server sockets to listen on an expected port number for the service offered. Servers can specify additional services and their associated ports in a SERVICES file. For more information on the SERVICES file, see the Microsoft documentation for Windows sockets.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">InitSocket calls <method namespace="scktcomp" class="TCustomWinSocket">LookupService</method> to obtain the port number for the Service specified by a socket component.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.ReceiveLength">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the number of bytes ready to be sent over the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">ReceiveLength</method> to determine the amount of information to read over the socket connection in response to an asynchronous read notification.</para>
<method namespace="scktcomp" class="TCustomWinSocket">ReceiveLength</method> is not guaranteed to be accurate for streaming socket connections.</para>
</note>
</comments>
</member>
<member name="M:ScktComp.ScktComp.ReceiveText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a string from the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TCustomWinSocket">ReceiveText</method> to read a string from the socket connection in the OnSocketEvent event handler of a Windows socket object or in the OnRead or OnClientRead event handler of a socket component. <method namespace="scktcomp" class="TCustomWinSocket">ReceiveText</method> returns the string that was read.</para>
<method namespace="scktcomp" class="TCustomWinSocket">ReceiveText</method> only works in response to a read notification to a non-blocking windows socket. Blocking sockets must use a TWinSocketStream for reading. The TWinSocketStream object waits for the remote socket to be ready before transferring information.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.SendBuf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes Count bytes to the socket connection from the Buf parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TCustomWinSocket">SendBuf</method> to write to the socket connection. Call this method from the OnSocketEvent event handler of a Windows socket object or in the OnWrite or OnClientWrite event handler of a socket component. Alternately, Use <method namespace="scktcomp" class="TCustomWinSocket">SendBuf</method> to write when a connection is first formed when the socket does not expect notification that the socket on the other end of the connection is expecting to read.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For non-blocking sockets, the data is sent to the WinSock DLL which has it's own internal buffers. If the WinSock can accept additional data, <method namespace="scktcomp" class="TCustomWinSocket">SendBuf</method> returns immediately with the number of bytes queued. If the WinSock internal buffer space is not able to accept the buffer being sent, <method namespace="scktcomp" class="TCustomWinSocket">SendBuf</method> returns -1 and no data is queued at all. In this case, wait a bit for the WinSock to have a chance to send out already-queued data; then try again.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For blocking sockets, <method namespace="scktcomp" class="TCustomWinSocket">SendBuf</method> returns the number of bytes actually written. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If an error occurs while writing to the connection, <method namespace="scktcomp" class="TCustomWinSocket">SendBuf</method> terminates the connection and raises an ESocketError exception.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes all the information that can be read from the AStream parameter to the socket connection and then terminates the connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TCustomWinSocket">SendStreamThenDrop</method> to write to a socket connection when the connection is no longer needed after the writing is complete. SendStream reads information from the stream indicated by AStream and writes it to the socket connection, shutting down the connection when it is done. The value returned by SendStream indicates whether any information was successfully written to the connection.</para>
<para>The Stream passed as a parameter to SendStream becomes "owned" by the windows socket object. The Windows socket object frees the stream when it is finished with it. Do not attempt to free the stream after it has been passed as a parameter.</para>
</note>
</comments>
</member>
<member name="M:ScktComp.ScktComp.SendText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the string S to the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TCustomWinSocket">SendText</method> to write a string to the socket connection. The writing may occur in the OnSocketEvent event handler of a Windows socket object or in the OnWrite or OnClientWrite event handler of a socket component. Alternately, <method namespace="scktcomp" class="TCustomWinSocket">SendText</method> may write from a socket that is expected to write to the connection without a notification to signal the connection's readiness to read. If an error occurs while writing to the connection, <method namespace="scktcomp" class="TCustomWinSocket">SendText</method> terminates the connection and raises an ESocketError exception.</para>
<method namespace="scktcomp" class="TCustomWinSocket">SendText</method> returns the number of bytes sent. Note that this may be less than the length of the string S if the socket is nonblocking.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Create</method>s an instance of <method namespace="scktcomp" class="TCustomWinSocket">TCustomWinSocket</method> from a Windows socket handle.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">Create</method> to create a Windows socket object. Most Windows socket objects are created automatically by the socket component that uses them. Applications may create their own Windows socket objects in an OnGetSocket event handler for a server socket component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="scktcomp" class="TCustomWinSocket">Create</method>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Makes sure that Winsock.dll is initialized.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Allocates helper objects to manage multithreading issues.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes ASyncStyles to [asRead, asWrite, asConnect, asClose]</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the SocketHandle property to the ASocket parameter and sets the Connected property to reflect whether ASocket is the handle of a valid open Windows socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the Addr property.</para>
<method namespace="scktcomp" class="TCustomWinSocket">AsyncInitSocket</method> is used internally to open a socket connection in non-blocking sockets. It is called by the Open or Listen method when that method's Block parameter is false.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter is the host name for the socket. The Address parameter is the IP address. The Service parameter is the service for which the socket is to used. The Port parameter is the port number for the socket. The QueueSize parameter indicates the number of client requests a listening connection can hold while waiting to form connections. The Client parameter indicates whether the socket address structure is to be used by a client socket to describe the destination of a connection or by a server socket to describe the listening connection.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.DoOpen">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens a connection to a remote socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The socket uses <method namespace="scktcomp" class="TCustomWinSocket">DoOpen</method> internally to open a connection to a remote socket. <method namespace="scktcomp" class="TCustomWinSocket">DoOpen</method> handles those tasks that are common to establishing a connection synchronously or asynchronously.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="scktcomp" class="TCustomWinSocket">DoOpen</method> to open a connection. Instead, call the public Open method, which orchestrates the opening of a connection either synchronously or asynchronously, depending on the socket type.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.DoListen">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens a listening connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The socket uses <method namespace="scktcomp" class="TCustomWinSocket">DoListen</method> internally to open a listening connection with a queue that can hold QueueSize client connection requests. <method namespace="scktcomp" class="TCustomWinSocket">DoListen</method> handles those tasks that are common to opening a listening connection synchronously or asynchronously.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="scktcomp" class="TCustomWinSocket">DoListen</method> to open a listening connection. Instead, call the public Listen method, which orchestrates the opening of a connection either synchronously or asynchronously, depending on the socket type.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Error">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="scktcomp" class="TCustomWinSocket">Error</method>Event event.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Error</method> is called automatically when the Windows socket object receives error notifications. It generates the On<method namespace="scktcomp" class="TCustomWinSocket">Error</method>Event event. When overriding this method, be sure to call the inherited method, because socket components rely on the On<method namespace="scktcomp" class="TCustomWinSocket">Error</method>Event event for their own error handling.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Socket parameter indicates the Windows socket object that encounters the error condition. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="scktcomp" class="TCustomWinSocket">Error</method>Event parameter indicates what the socket was trying to do when the error occurred. It has one of the following values:</para>
<para>The socket received an error message that does not fit into any of the following categories.</para>
</td>
</tr>
<tr>
<td>
<para>eeSend</para>
</td>
<td>
<para>An error occurred when trying to write to the socket connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeReceive</para>
</td>
<td>
<para>An error occurred when trying to read from the socket connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeConnect</para>
</td>
<td>
<para>For client sockets, this indicates that the client socket can't locate the server, or that a problem on the server prevents the opening of a connection. For server sockets, this indicates that a client connection request that has already been accepted could not be completed. </para>
</td>
</tr>
<tr>
<td>
<para>eeDisconnect</para>
</td>
<td>
<para>An error occurred when trying to close a connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeAccept</para>
</td>
<td>
<para>For server sockets only, this indicates that a problem occurred when trying to accept a client connection request.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="scktcomp" class="TCustomWinSocket">Error</method>Code parameter is the error code received by the Windows socket object. Changing this value to 0 in the <method namespace="scktcomp" class="TCustomWinSocket">Error</method> method prevents the socket from raising an exception. For information on possible error codes, see the Microsoft documentation on Windows sockets.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Close">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection if it is open.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">Close</method> to terminate an open socket connection. <method namespace="scktcomp" class="TCustomWinSocket">Close</method> triggers an OnSocketEvent of type seDisconnect before the connection is shut down. If the Windows socket is a listening server socket, <method namespace="scktcomp" class="TCustomWinSocket">Close</method> shuts down all open connections to client sockets before shutting down the listening connection.</para>
<method namespace="scktcomp" class="TCustomWinSocket">DefaultHandler</method> overrides the inherited method in order to process all messages that are sent to the Windows socket object. <method namespace="scktcomp" class="TCustomWinSocket">DefaultHandler</method> passes the messages to the Windows CallWindowProc function.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Lock">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Starts a critical section, blocking all other execution threads until the Unlock method is called.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">Lock</method> before beginning a section of code that is not thread-safe. Call Unlock when the critical section of code is completed. Unless absolutely necessary, do not use <method namespace="scktcomp" class="TCustomWinSocket">Lock</method> to lock lengthy operations such as reading and writing over a blocking connection. <method namespace="scktcomp" class="TCustomWinSocket">Lock</method>ing lengthy operations can severely impact performance, because all execution threads in the application that use the Windows socket object must wait until Unlock is called.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Unlock">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reenables execution in other threads after a critical section begun by the Lock method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TCustomWinSocket">Unlock</method> at the end of a section of code that is not thread-safe. Every call to <method namespace="scktcomp" class="TCustomWinSocket">Unlock</method> should match a call to the Lock method at the beginning of the critical section of code. </para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Listen">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens a listening connection for a server socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Server socket components call <method namespace="scktcomp" class="TCustomWinSocket">Listen</method> to open a listening connection.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Listen</method> creates the Windows socket that will make the listening connection, and binds the Windows Internet socket address derived from the parameters to the socket. <method namespace="scktcomp" class="TCustomWinSocket">Listen</method> then generates an OnSocketEvent of type se<method namespace="scktcomp" class="TCustomWinSocket">Listen</method>. Finally, <method namespace="scktcomp" class="TCustomWinSocket">Listen</method> opens the socket as a listening connection with a queue that can hold QueueSize client requests, setting the Connected property to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name, Address, Service, and Port parameters are taken from the Host, Address, Service and Port properties of the server socket component. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">QueueSize indicates how many client requests the listening connection can hold. TServerSocket sets the QueueSize to 5. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Block indicates whether the socket can look up the information it needs to establish a connection asynchronously. When Block is true, the socket blocks execution for each lookup instead of retrieving information about the connection using asynchronous notifications. </para>
<method namespace="scktcomp" class="TCustomWinSocket">Open</method>s a connection to a remote socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Client socket components call <method namespace="scktcomp" class="TCustomWinSocket">Open</method> to open a connection to a server socket.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Open</method> creates the Windows socket that will connect to the server socket, and generates an OnSocketEvent of type seLookup. After the OnSocketEvent, <method namespace="scktcomp" class="TCustomWinSocket">Open</method> binds the Windows Internet socket address derived from the parameters to the socket, locating the server socket. <method namespace="scktcomp" class="TCustomWinSocket">Open</method> then generates an OnSocketEvent of type seConnecting. When the server socket accepts the connection, <method namespace="scktcomp" class="TCustomWinSocket">Open</method> completes the connection to the server socket. Then it generates an OnSocketEvent of type seConnect. After the OnSocketEvent, the Connected property is set to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name, Address, Service, and Port parameters are taken from the Host, Address, Service and Port properties of the client socket component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Block indicates whether the socket can look up the information it needs to establish a connection asynchronously. When Block is true, the socket blocks execution for each lookup instead of retrieving information about the connection using asynchronous notifications. </para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Accept">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the interface for a method that accepts a connection to a client socket.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Accept</method> is called automatically in response to notifications that a client socket is requesting a connection. The Socket parameter is the Windows socket handle for the socket that receives the notification.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="scktcomp" class="TCustomWinSocket">Accept</method> method for <method namespace="scktcomp" class="TCustomWinSocket">TCustomWinSocket</method> does nothing with the notification. Descendants of <method namespace="scktcomp" class="TCustomWinSocket">TCustomWinSocket</method> that represent listening server sockets override this method to accept the connection to the client socket.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Accept</method> is only called if the ASyncStyles property includes as<method namespace="scktcomp" class="TCustomWinSocket">Accept</method>.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Connect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the interface for a method that responds to connection notifications from client sockets.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Connect</method> is called automatically in response to notifications that the client socket has successfully completed a connection to a server socket. The Socket parameter is the Windows socket handle for the socket that receives the notification.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="scktcomp" class="TCustomWinSocket">Connect</method> method for <method namespace="scktcomp" class="TCustomWinSocket">TCustomWinSocket</method> does nothing with the notification. Descendants of <method namespace="scktcomp" class="TCustomWinSocket">TCustomWinSocket</method> that represent client sockets override this method to respond to connection notifications.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Connect</method> is only called if the ASyncStyles property includes as<method namespace="scktcomp" class="TCustomWinSocket">Connect</method>.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Disconnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection represented by a Windows socket handle.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Disconnect</method> is called by the Close method to terminate an individual socket connection.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Disconnect</method> calls the Lock method to make sure the method is thread-safe. Then, it generates an OnSocketEvent of type se<method namespace="scktcomp" class="TCustomWinSocket">Disconnect</method>. After the OnSocketEvent, <method namespace="scktcomp" class="TCustomWinSocket">Disconnect</method> closes the connection. Finally, it calls Unlock to end the critical section started by Lock.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Read">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an OnSocketEvent of type se<method namespace="scktcomp" class="TCustomWinSocket">Read</method> in response to notifications that the socket connection is ready.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Read</method> is called in response to asynchronous notifications that the socket connection is ready for reading. The Windows socket can then read from the connection in the OnSocketEvent event handler or the socket component can read from the connection in an On<method namespace="scktcomp" class="TCustomWinSocket">Read</method> or OnClient<method namespace="scktcomp" class="TCustomWinSocket">Read</method> event handler. The event handler can use the ReceiveBuf method or the ReceiveText method to read the information from the connection.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Read</method> is only called for asynchronous read notifications in a non-blocking socket. Blocking sockets must use a TWinSocketStream object for reading. The TWinSocketStream object waits for the remote socket to be ready before transferring information.</para>
</note>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Write">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an OnSocketEvent of type se<method namespace="scktcomp" class="TCustomWinSocket">Write</method> in response to notifications that the socket connection is ready.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Write</method> is called in response to asynchronous notifications that the socket connection is ready for the socket to send information. The Windows socket can write to the connection in the OnSocketEvent event handler or the socket component can write to the connection in an On<method namespace="scktcomp" class="TCustomWinSocket">Write</method> or OnClient<method namespace="scktcomp" class="TCustomWinSocket">Write</method> event handler. The event handler can use the SendBuf method, the SendStream method, or the SendText method to write the information to the connection.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Write</method> is only called for asynchronous write notifications in a non-blocking socket. Blocking sockets must use their own mechanisms for determining when the connection is ready for the socket to write.</para>
<method namespace="scktcomp" class="TCustomWinSocket">Destroy</method>s an instance of <method namespace="scktcomp" class="TCustomWinSocket">TCustomWinSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most applications do not need to explicitly free Windows socket objects. They are freed by the socket components that use them.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.LocalHost">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the local system.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">LocalHost</property> to get the name of the system that is running the application that uses the Windows socket. <property namespace="scktcomp" class="TCustomWinSocket">LocalHost</property> is a string containing the domain name and service of the local socket endpoint, such as </para>
<property namespace="scktcomp" class="TCustomWinSocket">LocalHost</property> provides an alias for the local IP address given in the LocalAddress property. Most Intranets provide host names for the IP addresses of systems on the net. On Windows 95 and NT machines, if a host name is not available, create one for the local IP address by entering the name into the HOSTS file. See the Microsoft documentation on Windows sockets for more information on the HOSTS file.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.LocalAddress">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the IP address of the local system that was bound to the socket connection.</para>
<property namespace="scktcomp" class="TCustomWinSocket">LocalAddress</property> is a string of four numeric (byte) values in the standard Internet dot notation, such as</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each address identifies the system and indicates the types of interfaces supported by the socket. A single system (machine) can support multiple addresses. <property namespace="scktcomp" class="TCustomWinSocket">LocalAddress</property> is the address from among the possible addresses supported by the local system that is bound to the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A single <property namespace="scktcomp" class="TCustomWinSocket">LocalAddress</property> can be used simultaneously by multiple socket connections. Each of those connections must have a unique LocalPort number to distinguish it from other connections to the same <property namespace="scktcomp" class="TCustomWinSocket">LocalAddress</property>.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.LocalPort">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the ID number of the port used by the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">LocalPort</property> to determine the port number that is bound to the socket connection. For server endpoints of listening connections, <property namespace="scktcomp" class="TCustomWinSocket">LocalPort</property> is the ID associated with the service the server socket provides. For client or server endpoints of connections to another socket, <property namespace="scktcomp" class="TCustomWinSocket">LocalPort</property> is usually an arbitrary value picked when the connection was made.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Port numbers allow a single system, identified by the LocalAddress property, to host multiple connections simultaneously. Each combination of <property namespace="scktcomp" class="TCustomWinSocket">LocalPort</property> and LocalAddress can only be bound to a single socket connection. This combination is represented by the Addr property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Many values of <property namespace="scktcomp" class="TCustomWinSocket">LocalPort</property> are associated by convention with a particular service such as ftp or http. To determine whether the value of <property namespace="scktcomp" class="TCustomWinSocket">LocalPort</property> is associated with a specific service, use the LookupService method.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.RemoteHost">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the remote system.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">RemoteHost</property> to get the name of the system on the other end of the socket connection. <property namespace="scktcomp" class="TCustomWinSocket">RemoteHost</property> is a string containing the domain name and service of the remote endpoint of the socket connection, such as </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">LocalHost provides an alias for the local IP address given in the RemoteAddress property.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.RemoteAddress">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the IP address of the remote system that was bound to the socket connection.</para>
<property namespace="scktcomp" class="TCustomWinSocket">RemoteAddress</property> is a string of four numeric (byte) values in the standard Internet dot notation, such as</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each address identifies the system on the other end of the socket connection and indicates the types of interfaces supported by the remote socket. A single system can support multiple addresses. <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddress</property> is the address from among the possible addresses supported by the remote system that is bound to the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A single <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddress</property> may be participating in multiple socket connections. Each of those connections has a unique RemotePort number to distinguish it from other connections to the same <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddress</property>. The RemoteAddr property uniquely identifies the <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddress</property> and RemotePort combination used by the socket connection.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.RemotePort">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the ID number of the port used by the RemoteHost to form the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">RemotePort</property> to determine the port number used by the socket on the other end of the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Port numbers allow a single system, identified by the RemoteAddress or RemoteHost property, to host multiple connections simultaneously. Each combination of <property namespace="scktcomp" class="TCustomWinSocket">RemotePort</property> and RemoteAddress can only be bound to a single socket connection. This combination is represented by the RemoteAddr property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Many port numbers are associated by convention with a particular service such as ftp or http. To determine whether the value of <property namespace="scktcomp" class="TCustomWinSocket">RemotePort</property> is associated with a specific service, use the LookupService method.</para>
<para>If a client socket requests a specific port to indicate a desired service, the value of <property namespace="scktcomp" class="TCustomWinSocket">RemotePort</property> for the actual connection may differ from the requested port number. Most server sockets listen on the port associated with a service, but switch to an arbitrary available port number for forming connections.</para>
</note>
</comments>
</member>
<member name="P:ScktComp.ScktComp.RemoteAddr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the Internet socket address structure used in Windows socket API calls to represent the full specification of the remote socket port.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When working directly with Windows socket API calls, use <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddr</property> to represent the port used by the socket on the other end of the connection. The value of <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddr</property> is determined by the values of the <property namespace="scktcomp" class="TCustomWinSocket">RemoteAddr</property>ess and RemotePort properties.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Connected">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the socket connection is open and available for communication with other machines.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="scktcomp" class="TCustomWinSocket">Connected</property> before trying to use or change the Windows socket connection. <property namespace="scktcomp" class="TCustomWinSocket">Connected</property> indicates whether the socket connection has been established. When <property namespace="scktcomp" class="TCustomWinSocket">Connected</property> is true, the Windows socket is open and available for use. When <property namespace="scktcomp" class="TCustomWinSocket">Connected</property> is false, the Windows socket is closed and can be changed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To open a client Windows socket, use the Open method. To open a server Windows socket, use the Listen method. The Windows socket that represents the server endpoint of a connection to a client socket is opened in its constructor.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To close a Windows socket, use the Close method.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Addr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the Internet socket address structure used in Windows socket API calls to represent the full specification of the socket port.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">Addr</property> to represent the port used by the socket when working directly with Windows socket API calls. For client sockets, the value of <property namespace="scktcomp" class="TCustomWinSocket">Addr</property> represents the target remote port. For server sockets, <property namespace="scktcomp" class="TCustomWinSocket">Addr</property> is determined by the values of the Local<property namespace="scktcomp" class="TCustomWinSocket">Addr</property>ess and LocalPort properties.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ASyncStyles">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines which asynchronous events the socket can receive.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">ASyncStyles</property> to determine what sorts of notifications the socket needs to respond to. Set <property namespace="scktcomp" class="TCustomWinSocket">ASyncStyles</property> to change the notifications that the socket receives from the socket connection. <property namespace="scktcomp" class="TCustomWinSocket">ASyncStyles</property> is a set drawn from the following values:</para>
<para>The socket receives notification that the connection is ready for reading.</para>
</td>
</tr>
<tr>
<td>
<para>asWrite</para>
</td>
<td>
<para>The socket receives notification that the connection is ready for writing.</para>
</td>
</tr>
<tr>
<td>
<para>asOOB</para>
</td>
<td>
<para>The socket receives notification when out-of-band data arrives.</para>
</td>
</tr>
<tr>
<td>
<para>asAccept</para>
</td>
<td>
<para>The socket receives notification when another socket requests a connection.</para>
</td>
</tr>
<tr>
<td>
<para>asConnect</para>
</td>
<td>
<para>The socket receives notification when a communication link to another socket is opened.</para>
</td>
</tr>
<tr>
<td>
<para>asClose</para>
</td>
<td>
<para>The socket receives notification when a communication link to another socket is terminated.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Any notification specified by <property namespace="scktcomp" class="TCustomWinSocket">ASyncStyles</property> arrives as a window message to the Handle property.</para>
<para>If the socket is a non-blocking socket, then <property namespace="scktcomp" class="TCustomWinSocket">ASyncStyles</property> should include asRead and asWrite so that the socket will be informed of asynchronous reading and writing events.</para>
</note>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Handle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the handle of the window that receives notifications from the Windows socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">Handle</property> to send messages to the Windows socket or to subclass the Window procedure that receives messages of asynchronous events from the socket connection.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.SocketHandle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the Windows handle for the socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">SocketHandle</property> for Windows socket API calls that require the handle to the socket. When the Connected property is false, <property namespace="scktcomp" class="TCustomWinSocket">SocketHandle</property> is INVALID_SOCKET.</para>
<property namespace="scktcomp" class="TCustomWinSocket">SocketHandle</property> is set to a valid Windows socket handle by the Listen or Open method.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.LookupState">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates any asynchronous activities occurring while opening a connection.</para>
<property namespace="scktcomp" class="TCustomWinSocket">LookupState</property> is used internally to coordinate asynchronous activities while opening a connection. The AsyncInitSocket method sets the value of <property namespace="scktcomp" class="TCustomWinSocket">LookupState</property> to indicate when it is looking up various types of information. The following table lists the possible values:</para>
<para>The socket is not currently looking up any information asynchronously.</para>
</td>
</tr>
<tr>
<td>
<para>lsLookupAddress</para>
</td>
<td>
<para>The socket is looking up an IP address asynchronously and has not yet received the result.</para>
</td>
</tr>
<tr>
<td>
<para>lsLookupService</para>
</td>
<td>
<para>The socket is looking up a Service asynchronously and has not yet received the result.</para>
</td>
</tr>
</table>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Data">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Points to application-specific data associated with the socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TCustomWinSocket">Data</property> to associate information specific to the socket connection with the Windows socket object. For example, <property namespace="scktcomp" class="TCustomWinSocket">Data</property> can be used to store access and authentication information used by a server socket to evaluate client connection requests. </para>
<property namespace="scktcomp" class="TCustomWinSocket">Data</property> can store information in a thread-safe manner that would otherwise require the use of global variables. This is useful given the multi-threaded nature of many client-server applications.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnSocketEvent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the Windows socket receives notification of asynchronous events.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Socket components provide an <event namespace="scktcomp" class="TCustomWinSocket">OnSocketEvent</event> event handler that converts Windows socket notifications into events on the socket component. Most applications will therefore not provide an event handler for <event namespace="scktcomp" class="TCustomWinSocket">OnSocketEvent</event>. Replacing this event handler can prevent some expected events from occurring.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the Windows socket object that owns the event handler. Usually, this is the same as the Socket parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Socket parameter indicates the Windows socket that generates or receives notification of the event. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The SocketEvent parameter indicates the event that occurred.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnErrorEvent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the socket fails in making, using, or shutting down a connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Socket components provide an <event namespace="scktcomp" class="TCustomWinSocket">OnErrorEvent</event> event handler that converts error notifications into error events on the socket component. Most applications will therefore not provide an event handler for <event namespace="scktcomp" class="TCustomWinSocket">OnErrorEvent</event>.</para>
<class namespace="scktcomp">TClientWinSocket</class> describes the client endpoint of a Windows socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Client socket components use <class namespace="scktcomp">TClientWinSocket</class> to manage the Windows socket API calls for a TCP/IP client application. <class namespace="scktcomp">TClientWinSocket</class> differs from its immediate ancestor TCustomWinSocket only in that it introduces a ClientType property to distinguish blocking from non-blocking client sockets.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Connect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds to connection notifications.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can not call this protected method. <method namespace="scktcomp" class="TClientWinSocket">Connect</method> is called in response to notifications that the client socket has successfully completed a connection to a server socket. The Socket parameter is the Windows socket handle for the socket that receives the notification.</para>
<method namespace="scktcomp" class="TClientWinSocket">Connect</method> generates an OnSocketEvent event with the SocketEvent parameter set to se<method namespace="scktcomp" class="TClientWinSocket">Connect</method>. Socket components assign an OnSocketEvent event handler that responds to this event by generating an On<method namespace="scktcomp" class="TClientWinSocket">Connect</method> event on the socket component.</para>
<method namespace="scktcomp" class="TClientWinSocket">Connect</method> is only called if the ASyncStyles property includes as<method namespace="scktcomp" class="TClientWinSocket">Connect</method>.</para>
</note>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ClientType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether the client Windows socket reads and writes information asynchronously over the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Client socket components set <property namespace="scktcomp" class="TClientWinSocket">ClientType</property> to reflect their own <property namespace="scktcomp" class="TClientWinSocket">ClientType</property> property. When <property namespace="scktcomp" class="TClientWinSocket">ClientType</property> is ctNonBlocking, the client Windows socket responds to asynchronous reading and writing events, and execution is not blocked by reading and writing over the connection. OnSocketEvent events occur when the socket needs to read or write over the connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="scktcomp" class="TClientWinSocket">ClientType</property> is ctBlocking, all reading and writing occur synchronously. It is a good idea to perform all reading and writing in a separate thread if <property namespace="scktcomp" class="TClientWinSocket">ClientType</property> is ctBlocking. Reading and writing in a separate thread ensures that these operations do not block all execution within the client application. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="scktcomp" class="TClientWinSocket">ClientType</property> is ctBlocking, use a TWinSocketStream object for reading and writing. TWinSocketStream times out so that the application does not hang when a problem occurs while reading or writing. TWinSocketStream also provides a method to wait, before reading, until the socket connection is ready to send information.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a non-blocking socket when the socket needs to synchronize reading and writing with server sockets.</para>
<class namespace="ScktComp">TServerClientWinSocket</class> is used by server socket components to manage the Windows socket API calls for the socket connection to an individual client socket. <class namespace="ScktComp">TServerClientWinSocket</class> objects are created when a client socket connection is accepted by a listening server socket. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can create and customize the properties of a <class namespace="ScktComp">TServerClientWinSocket</class> object in an OnGetSocket event handler for a server socket component. Component writers can create descendants of <class namespace="ScktComp">TServerClientWinSocket</class> that may be substituted for <class namespace="ScktComp">TServerClientWinSocket</class> in the OnGetSocket event handler.</para>
<method namespace="ScktComp" class="TServerClientWinSocket">Create</method>s and initializes an instance of <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="ScktComp" class="TServerClientWinSocket">Create</method> to create an instance of <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method> in the OnGetSocket event handler of a server socket component. The Socket parameter is the Windows socket handle for the accepted socket connection to a client socket. The ServerWinSocket parameter is the Windows socket object for the listening connection that accepted the connection to the client socket.</para>
<method namespace="ScktComp" class="TServerClientWinSocket">Create</method> adds the new <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method> object to the list of connections maintained by the listening server socket. It then sets the OnSocketEvent event handler so that notifications from the connection to the client can be passed on to the server socket. After setting up the connection to the server socket, <method namespace="ScktComp" class="TServerClientWinSocket">Create</method> calls the inherited constructor.</para>
<method namespace="ScktComp" class="TServerClientWinSocket">Destroy</method>s an instance of <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="ScktComp" class="TServerClientWinSocket">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method> reference is not nil, and only then calls <method namespace="ScktComp" class="TServerClientWinSocket">Destroy</method>. Instances of <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method> are freed automatically when the connection is closed.</para>
<method namespace="ScktComp" class="TServerClientWinSocket">Destroy</method> removes the <method namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</method> from the list of connections maintained by the listening windows socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the endpoint of the listening connection that accepted the connection to the client socket which is managed by this <property namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</property>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="ScktComp" class="TServerClientWinSocket">ServerWinSocket</property> to gain access to the Windows socket object for the listening connection that spawned this <property namespace="ScktComp" class="TServerClientWinSocket">TServerClientWinSocket</property>. Use the <property namespace="ScktComp" class="TServerClientWinSocket">ServerWinSocket</property> to trigger events that can be handled by the event handlers of the server socket, to get execution threads from the cache maintained by the Windows server socket, or to get information about the other active connections accepted by the server socket.</para>
<class namespace="scktcomp">TServerWinSocket</class> is used by server socket components to manage the Windows socket API calls for a TCP/IP listening connection. <class namespace="scktcomp">TServerWinSocket</class> introduces new properties, events, and methods to manage multiple socket connections to different client sockets, and to generate or reuse TServerClientThread objects that allow each client connection to have its own execution thread.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the execution thread used by the client connection managed by the ClientSocket parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TServerWinSocket">GetClientThread</method> to obtain access to the TServerClientThread for a particular client connection. <method namespace="scktcomp" class="TServerWinSocket">GetClientThread</method> allows an OnClient<condition language="Delphi">...</condition> event handler to access thread-global information saved in the Data property of the thread.</para>
<method namespace="scktcomp" class="TServerWinSocket">Create</method>s an instance of <method namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</method> from a Windows socket handle.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TServerWinSocket">Create</method> to create a Windows listening socket object. Windows listening socket objects are created automatically by the server socket component that uses them.</para>
<method namespace="scktcomp" class="TServerWinSocket">Create</method> allocates the helper objects that manage the list of active client connections and the thread cache before calling the inherited constructor. <method namespace="scktcomp" class="TServerWinSocket">Create</method> also initializes the ASyncStyles property to [asAccept].</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Listen">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens a listening connection for a server socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Server socket components call <method namespace="scktcomp" class="TServerWinSocket">Listen</method> to open a listening connection.</para>
<method namespace="scktcomp" class="TServerWinSocket">Listen</method> creates the Windows socket that will make the listening connection, and binds the Windows Internet socket address derived from the parameters to the socket. <method namespace="scktcomp" class="TServerWinSocket">Listen</method> then generates an OnSocketEvent of type se<method namespace="scktcomp" class="TServerWinSocket">Listen</method>. Finally, <method namespace="scktcomp" class="TServerWinSocket">Listen</method> opens the socket as a listening connection with a queue that can hold QueueSize client requests, setting the Connected property to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name, Address, Service, and Port parameters are taken from the Host, Address, Service and Port properties of the server socket component. The QueueSize is set to 5 by TServerSocket.</para>
<method namespace="scktcomp" class="TServerWinSocket">Accept</method> is called automatically in response to notifications that a client socket is requesting a connection. The Socket parameter is the Windows socket handle for the listening connection.</para>
<method namespace="scktcomp" class="TServerWinSocket">Accept</method> accepts the client connection request, obtaining the Windows socket handle for the client connection. It then generates an OnGetSocket event, passing this socket handle as an argument to any event handler. If a TServerClientWinSocket is not created by an OnGetSocket event handler, <method namespace="scktcomp" class="TServerWinSocket">Accept</method> creates a TServerClientWinSocket to represent the server endpoint of the accepted connection. Next, <method namespace="scktcomp" class="TServerWinSocket">Accept</method> obtains a running TServerClientThread, either by restarting a thread in the cache, obtaining one from an OnGetThread event, or creating a new TServerClientThread object. This new thread handles the connection to the client socket.</para>
<method namespace="scktcomp" class="TServerWinSocket">Accept</method> is only called if the ASyncStyles property includes as<method namespace="scktcomp" class="TServerWinSocket">Accept</method>.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Disconnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection represented by a Windows socket handle.</para>
<method namespace="scktcomp" class="TServerWinSocket">Disconnect</method> calls the Lock method to make sure the method is thread-safe. Then, it terminates all open connections to client sockets. Next it generates an OnSocketEvent of type se<method namespace="scktcomp" class="TServerWinSocket">Disconnect</method>. Finally, it closes the listening connection and calls Unlock to end the critical section started by Lock.</para>
<method namespace="scktcomp" class="TServerWinSocket">Destroy</method>s an instance of <method namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="scktcomp" class="TServerWinSocket">Destroy</method> directly in an application. Instead, call Free. Free verifies that the Windows listening socket object is not nil, and only then calls <method namespace="scktcomp" class="TServerWinSocket">Destroy</method>. Unless the Windows socket object is not used by a server socket component, it is freed automatically by the socket component.</para>
<method namespace="scktcomp" class="TServerWinSocket">Destroy</method> frees the helper objects that manage the list of active client connections and the thread cache.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of connections to client sockets accepted by this listening socket that are currently open.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerWinSocket">ActiveConnections</property> to monitor the use of the server socket. <property namespace="scktcomp" class="TServerWinSocket">ActiveConnections</property> is the number of entries in the Connections array. </para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ActiveThreads">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of TServerClientThread objects currently in use by the socket connections listed in the Connections array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerWinSocket">ActiveThreads</property> to monitor thread usage by the listening socket. If <property namespace="scktcomp" class="TServerWinSocket">ActiveThreads</property> is usually much higher than ThreadCacheSize, increasing ThreadCacheSize should improve performance. To determine whether ThreadCacheSize is too high, use the IdleThreads property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the ServerType property is stThreadBlocking, each client connection automatically spawns a thread which is added to the cache and counted by <property namespace="scktcomp" class="TServerWinSocket">ActiveThreads</property>.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Connections">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists all TServerClientWinSocket objects that represent open socket connections to client sockets that were accepted by this listening socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerWinSocket">Connections</property> with the Active<property namespace="scktcomp" class="TServerWinSocket">Connections</property> property to iterate over all open socket connections accepted by the listening socket. Each entry in the <property namespace="scktcomp" class="TServerWinSocket">Connections</property> array is a TServerClientWinSocket object, where an Index of 0 gives the first TServerClientWinSocket, an Index of 1 returns the second TServerClientWinSocket, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If ServerType is stThreadBlocking, the thread associated with each of the TServerClientWinSocket objects in the <property namespace="scktcomp" class="TServerWinSocket">Connections</property> array can be obtained using the GetClientThread method.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.IdleThreads">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of unused TServerClientThread objects available in the cache.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerWinSocket">IdleThreads</property> to monitor thread cache usage by the listening socket. If <property namespace="scktcomp" class="TServerWinSocket">IdleThreads</property> often very high, the thread cache is tying up a lot of unused memory storing extra threads. Monitor the ActiveThreads property to determine an appropriate value for ThreadCacheSize.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the ServerType property is stThreadBlocking, each client connection automatically spawns a thread which is added to the cache. As the threads in the cache complete their execution, they become available for reuse, and are counted by <property namespace="scktcomp" class="TServerWinSocket">IdleThreads</property>. When there are more active threads than ThreadCacheSize, the extra threads are freed when they finish execution instead.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ServerType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether each connection accepted by the server socket is non-blocking, or if it is automatically given a separate execution thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="scktcomp" class="TServerWinSocket">ServerType</property> to stThreadBlocking to automatically spawn a new thread for each socket connection accepted by the listening socket connection. When <property namespace="scktcomp" class="TServerWinSocket">ServerType</property> is stThreadBlocking, the TServerClientThread object for a connection generates OnClientRead or OnClientWrite events when the server socket needs to read or write. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="scktcomp" class="TServerWinSocket">ServerType</property> to stNonBlocking to handle all reading and writing over socket connections accepted by the listening socket asynchronously. When <property namespace="scktcomp" class="TServerWinSocket">ServerType</property> is stNonBlocking, all client connections are handled in a single execution thread by default. OnClientRead or OnClientWrite events occur when the server socket needs to attend to I/O over one of the connections.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a non-blocking socket when reading and writing must be synchronized with client sockets.</para>
<para>When <property namespace="scktcomp" class="TServerWinSocket">ServerType</property> is stThreadBlocking, it is important that the OnClient<condition language="Delphi">...</condition> event handlers contain thread-safe code.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of TServerClientThread objects cached for reuse by new connections to client sockets.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When ServerType is stThreadBlocking, each new connection that is accepted by the server socket is given a separate execution thread. In order to improve performance, server sockets store these threads in a cache rather than freeing them when the connection is closed. New connections can then reuse threads from the cache, rather than requiring the socket server to create a new thread every time a connection is accepted.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="scktcomp" class="TServerWinSocket">ThreadCacheSize</property> to specify the number of threads that are cached for reuse. The ideal value for <property namespace="scktcomp" class="TServerWinSocket">ThreadCacheSize</property> depends on the number and frequency of client socket requests received by the server socket. If <property namespace="scktcomp" class="TServerWinSocket">ThreadCacheSize</property> is too low, the server socket will spend more time freeing and creating threads when client connections are accepted. If <property namespace="scktcomp" class="TServerWinSocket">ThreadCacheSize</property> is too high, the server socket may unnecessarily lock up the memory for threads that are never reused.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnGetSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket needs to create a new TServerClientWinSocket object to form the connection to a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnGetSocket</event> event handler to create a specialized TServerClientWinSocket object to use in the connection represented by the Socket parameter. Return the new TServerClientWinSocket object in the ClientSocket parameter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> object that received the client request. The Socket parameter is the Windows socket handle for the socket connection to the client socket.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnGetSocket</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnGetSocket</event> event handler of the associated TServerSocket.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnGetThread">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket needs to create a new execution thread for a connection to a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnGetThread</event> event handler to create a specialized descendant of TServerClientThread for the connection to the client socket. Create the new thread with the CreateSuspended parameter set to false, and return it in the SocketThread parameter. <event namespace="scktcomp" class="TServerWinSocket">OnGetThread</event> only occurs if there are no idle threads in the cache.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most applications that use thread-blocking connections will want to create a new descendant of TServerClientThread in an <event namespace="scktcomp" class="TServerWinSocket">OnGetThread</event> event handler. This is because the default behavior of TServerClientThread uses the OnClientRead and OnClientWrite event handlers for reading and writing. These events occur on the server socket, which is not thread-local.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> object that received the client request. The ClientSocket parameter is the TServerClientWinSocket object that will communicate with the client socket.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnGetThread</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnGetThread</event> event handler of the associated TServerSocket.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnThreadStart">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the execution thread for a connection to a client socket starts up.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnThreadStart</event> to initialize the TServerClientThread for the connection to a single client socket. The Sender parameter is the <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> that received the client request. The Thread parameter is the thread that is about to start execution.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnThreadStart</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnThreadStart</event> event handler of the associated TServerSocket.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnThreadEnd">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket connection is terminated and the associated thread finishes execution.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnThreadEnd</event> to take specific action when the thread for a client connection finishes execution. <event namespace="scktcomp" class="TServerWinSocket">OnThreadEnd</event> occurs after the OnClientDisconnect event.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> that received the client request. The Thread parameter is the thread that is finishing up.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnThreadEnd</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnThreadEnd</event> event handler of the associated TServerSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket completes a connection accepted by the listening socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnClientConnect</event> event handler to take specific action when a client socket completes the socket connection to a TServerClientWinSocket object. Depending on the service, this is the point when the socket should begin reading or writing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The order of Windows server socket events leading up to <event namespace="scktcomp" class="TServerWinSocket">OnClientConnect</event> is as follows:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1An OnSocketEvent event of type seListen occurs just before the Windows socket is opened for listening.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2The listening Windows socket receives client requests in a listening queue. The listening socket accepts one of those requests, and receives a Windows socket handle for the new socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3The listening socket generates an OnGetSocket event, passing in the Windows socket handle. If a TServerClientWinSocket object for the Windows socket handle was not created in the OnGetSocket event handler, the Windows socket creates one. The Windows socket continues to listen for other clients.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">4An OnSocketEvent event of type seAccept occurs, using the new TServerClientWinSocket object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5If ServerType is stThreadBlocking and no thread is available in the cache, an OnGetThread event occurs. If the OnGetThread event handler does not create a thread, the Windows socket object creates a TServerClientThread.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">6If ServerType is stThreadBlocking, an OnThreadStart event occurs as the thread begins execution.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">7The client completes the connection to the TServerClientWinSocket object and an <event namespace="scktcomp" class="TServerWinSocket">OnClientConnect</event> event occurs.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinClient object that listens for client requests. The Socket parameter is the TServerClientWinSocket object that forms a connection to the client socket.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="scktcomp" class="TServerWinSocket">OnClientConnect</event> event handler is thread-safe. Use the GetClientThread method to access thread-specific information.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnClientConnect</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnClientConnect</event> event handler of the associated TServerSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when one of the connections to a client socket is closed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnClientDisconnect</event> event handler to take specific action when the connection to a client socket is ending. The termination of a client request does not close the listening socket. The listening connection remains open for accepting new client connection requests.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TServerClientWinSocket object associated with the client connection is freed after <event namespace="scktcomp" class="TServerWinSocket">OnClientDisconnect</event>. If ServerType is stThreadBlocking, OnThreadEnd occurs after <event namespace="scktcomp" class="TServerWinSocket">OnClientDisconnect</event>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinClient object that received the client request. The Socket parameter is the TServerClientWinSocket object that is ending a connection with the client socket.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="scktcomp" class="TServerWinSocket">OnClientDisconnect</event> event handler is thread-safe.Use the GetClientThread method to access thread-specific information.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <event namespace="scktcomp" class="TServerWinSocket">OnClientDisconnect</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnClientDisconnect</event> event handler of the associated TServerSocket.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnClientRead">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket should read information from a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnClientRead</event> event handler to read from the socket connection. Use a TWinSocketStream object or the methods of the Socket parameter to do the reading.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinClient object that received the client request. The Socket parameter is the TServerClientWinSocket object that encapsulates the Windows socket connection. </para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="scktcomp" class="TServerWinSocket">OnClientRead</event> event handler is thread-safe. Use the GetClientThread method to access thread-specific information.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnClientRead</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnClientRead</event> event handler of the associated TServerSocket.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnClientWrite">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket should write information to a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnClientWrite</event> event handler to write to the socket connection. Use a TWinSocketStream object or the methods of the Socket parameter to do the actual writing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinClient object that received the client request. The Socket parameter is the TServerClientWinSocket object that encapsulates the Windows socket connection.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="scktcomp" class="TServerWinSocket">OnClientWrite</event> event handler is thread-safe. Use the GetClientThread method to access thread-specific information.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnClientWrite</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnClientWrite</event> event handler of the associated TServerSocket.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnClientError">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a failure is encountered when establishing, using, or terminating the socket connection to an individual client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="scktcomp" class="TServerWinSocket">OnClientError</event> event handler to respond to errors that arise with the connection to a client socket. Set the ErrorCode parameter to 0 if the <event namespace="scktcomp" class="TServerWinSocket">OnClientError</event> event handler successfully deals with the error condition, to prevent an ESocketError from being raised.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinClient object that received the client request. The Socket parameter is the TServerClientWinSocket object that manages the connection to the client. The ErrorEvent parameter indicates what Socket was attempting to do when the error occurred. The ErrorCode parameter is the error code returned by the Windows socket API call.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="scktcomp" class="TServerWinSocket">OnClientError</event> event handler is thread-safe. Use the GetClientThread method to access thread-specific information.</para>
<para>The <event namespace="scktcomp" class="TServerWinSocket">OnClientError</event> event handler for <event namespace="scktcomp" class="TServerWinSocket">TServerWinSocket</event> is also set when setting the <event namespace="scktcomp" class="TServerWinSocket">OnClientError</event> event handler of the associated TServerSocket.</para>
<class namespace="scktcomp">TServerClientThread</class> is an execution thread used for a single connection to a client socket accepted by a Windows server socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TServerWinSocket objects spawn <class namespace="scktcomp">TServerClientThread</class> objects to handle separate client connections in separate execution threads. This allows server sockets to perform slow reading and writing operations with client sockets without adversely affecting the performance on other connections.</para>
<class namespace="scktcomp">TServerClientThread</class> introduces new properties to</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Access the TServerWinSocket object that spawned the thread and the TServerClientWinSocket that is connected to the client socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Store and access thread-specific data.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determine if the thread is stored in a thread cache maintained by the TServerWinSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications that receive frequent client requests will want to derive a descendant class from <class namespace="scktcomp">TServerClientThread</class> to handle reading and writing to separate clients. This is because <class namespace="scktcomp">TServerClientThread</class> objects use the OnClientRead and OnClientWrite events of the associated server socket. These events are not thread-local.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.StartConnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates when the thread is ready to execute.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Execute method calls <method namespace="scktcomp" class="TServerClientThread">StartConnect</method> to determine when to call ClientExecute. <method namespace="scktcomp" class="TServerClientThread">StartConnect</method> waits until the Reactivate method has signaled that the thread is properly initialized, and then returns true if the thread is ready to run. If the thread is terminated for any reason before it is fully initialized, <method namespace="scktcomp" class="TServerClientThread">StartConnect</method> returns false.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.EndConnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the thread should execute again for another client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Execute method calls <method namespace="scktcomp" class="TServerClientThread">EndConnect</method> when the ClientExecute method finishes. It frees all memory associated with the current client connection and checks whether the Thread is being reused for another client connection. If the thread should be reused, <method namespace="scktcomp" class="TServerClientThread">EndConnect</method> returns true to indicate that the ClientExecute method should be called again.</para>
<method namespace="scktcomp" class="TServerClientThread">Create</method>s an instance of <method namespace="scktcomp" class="TServerClientThread">TServerClientThread</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TServerClientThread">Create</method> to create an instance of <method namespace="scktcomp" class="TServerClientThread">TServerClientThread</method> for a connection to a client socket, and add the thread to the cache maintained by the associated listening socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes FreeOnTerminate to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes Priority to tpHigher.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes ClientSocket to the ASocket parameter and ServerSocket to ASocket.ServerWinSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Starts the thread executing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds the thread to the cache maintained by ServerSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the OnErrorEvent and OnSocketEvent event handlers of ClientSocket so that events are sent to ServerSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Signals when initialization is complete and the thread is ready for reading from or writing to the client connection.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.DoTerminate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Removes the thread from the list of active threads maintained by the associated server socket.</para>
<method namespace="scktcomp" class="TServerClientThread">DoTerminate</method> overrides the inherited method to suppress the OnTerminate event. Instead, it removes the thread from the Connections property of the associated TServerWinSocket. The thread is then either added to the server socket's thread cache or destroyed.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Execute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Manages the caching of server client threads and calls the Client<method namespace="scktcomp" class="TServerClientThread">Execute</method> method to run the thread for individual client connections. </para>
<method namespace="scktcomp" class="TServerClientThread">Execute</method> is called automatically when the thread runs. A thread runs when Create is called if CreateSuspended set to false, or when Resume is first called after the thread is created if CreateSuspended set to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not override the <method namespace="scktcomp" class="TServerClientThread">Execute</method> method to implement the thread function of a <method namespace="scktcomp" class="TServerClientThread">TServerClientThread</method> descendant. Instead, override the Client<method namespace="scktcomp" class="TServerClientThread">Execute</method> method, which is run after the thread is initialized for a particular client connection.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.ClientExecute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Simulates OnClientRead and OnClientWrite events for the associated server socket.</para>
<method namespace="scktcomp" class="TServerClientThread">TServerClientThread</method> calls <method namespace="scktcomp" class="TServerClientThread">ClientExecute</method> from its Execute method. <method namespace="scktcomp" class="TServerClientThread">ClientExecute</method> checks whether there is any information to read from the associated socket connection, and if so, simulates an OnClientRead event on the associated server socket. If there is no information sent from the client, <method namespace="scktcomp" class="TServerClientThread">ClientExecute</method> simulates an OnClientWrite event.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Because the server socket that receives these events is not local to the thread, the events occur within the main VCL thread using the Synchronize method. This method can be too slow if the server socket has many client connections, because each thread must wait for any other thread to finish reading or writing. When a server socket receives many client connection requests, override <method namespace="scktcomp" class="TServerClientThread">ClientExecute</method> to handle the reading or writing using a thread-local instance of TWinSocketStream. In the <method namespace="scktcomp" class="TServerClientThread">ClientExecute</method> method, be sure to check the Terminated property periodically.</para>
<para>Do not use the properties and methods of global objects directly in the <method namespace="scktcomp" class="TServerClientThread">ClientExecute</method> method. Instead, separate the use of objects that are not thread-local into a separate procedure call, and call that procedure by passing it as a parameter to the Synchronize method.</para>
</note>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Error">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an OnClient<method namespace="scktcomp" class="TServerClientThread">Error</method> event for the associated server socket.</para>
<method namespace="scktcomp" class="TServerClientThread">TServerClientThread</method> assigns the <method namespace="scktcomp" class="TServerClientThread">Error</method> method as an event handler for the On<method namespace="scktcomp" class="TServerClientThread">Error</method>Event method of the associated TClientWinSocket object. This allows errors received from the client to generate OnClient<method namespace="scktcomp" class="TServerClientThread">Error</method> events on the server socket.</para>
<method namespace="scktcomp" class="TServerClientThread">Error</method> is not thread-safe. It should not be called from the server client thread. It is only intended for use by the associated client socket, which is not local to the server client thread.</para>
<method namespace="scktcomp" class="TServerClientThread">HandleException</method> obtains the current exception object and calls TApplication.ShowException (for descendants of Exception) or the global ShowException procedure (for other objects) to display an error message. <method namespace="scktcomp" class="TServerClientThread">HandleException</method> wraps the call to ShowException in the Synchronize method to ensure that the call is thread-safe.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.ReActivate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the thread for a particular client connection. </para>
<method namespace="scktcomp" class="TServerClientThread">Reactivate</method> is called when the thread is created or reactivated from the server socket's cache of threads. It assigns the Error and Event methods as event handlers for the associated TServerWinSocket, and informs the server socket that the thread is now active.</para>
<method namespace="scktcomp" class="TServerClientThread">Destroy</method>s the server client thread object and releases the memory allocated to it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="scktcomp" class="TServerClientThread">Destroy</method> directly in an application. ServerClientThread objects are freed by the TServerWinSocket object that manages them.</para>
<method namespace="scktcomp" class="TServerClientThread">Destroy</method> frees the TServerClientWinSocket object that encapsulates the connection to the client socket before calling the inherited destructor.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ClientSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the TServerClientWinSocket object that uses the thread for all reading and writing over the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerClientThread">ClientSocket</property> to gain direct access to the Windows socket component that uses the thread. If <property namespace="scktcomp" class="TServerClientThread">ClientSocket</property> is nil (Delphi) or NULL (C++), the thread is idle and available for reuse by another TServerClientWinSocket object. <property namespace="scktcomp" class="TServerClientThread">TServerClientThread</property> uses <property namespace="scktcomp" class="TServerClientThread">ClientSocket</property> to read from or write to the socket connection.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ServerSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the TServerWinSocket object that manages all the <property namespace="scktcomp" class="TServerClientThread">TServerClientThread</property> objects for its client connections.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerClientThread">ServerSocket</property> to get direct access to the listening Windows socket object that spawned the thread for a client connection it accepted. <property namespace="scktcomp" class="TServerClientThread">TServerClientThread</property> passes events and errors to the appropriate event handlers assigned to <property namespace="scktcomp" class="TServerClientThread">ServerSocket</property>. <property namespace="scktcomp" class="TServerClientThread">TServerClientThread</property> adds itself to the cache of threads maintained by <property namespace="scktcomp" class="TServerClientThread">ServerSocket</property> from its constructor, and removes itself when the thread terminates.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.KeepInCache">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the thread should be kept in the thread cache maintained by ServerSocket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TServerWinSocket that spawns server client threads for its connections to client sockets maintains a cache of server client threads for reuse. As server client threads are activated, the TServerWinSocket object sets the <property namespace="scktcomp" class="TServerClientThread">KeepInCache</property> property to indicate whether the thread will fit in the thread cache.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="scktcomp" class="TServerClientThread">KeepInCache</property> is true, FreeOnTerminate is set to false before the thread terminates, and the thread is left in the thread cache. When <property namespace="scktcomp" class="TServerClientThread">KeepInCache</property> is false, the thread is freed when execution terminates.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Data">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Points to application-specific data associated with the thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="scktcomp" class="TServerClientThread">Data</property> to associate information with the thread object. <property namespace="scktcomp" class="TServerClientThread">Data</property> can store information in a thread-safe manner that would otherwise require the use of global variables.</para>
<class namespace="Scktcomp">TAbstractSocket</class> introduces properties and methods to enable an application to work with sockets. A socket encapsulates a set of communication protocols to allow the application to connect to other machines for reading or writing information. Sockets provide connections based on the TCP/IP protocol. They also allow connections that use the Xerox Network System (XNS), Digital's DECnet protocol, or Novell's IPX/SPX family. Sockets allow an application to form connections to other machines without being concerned with the details of the actual networking software.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The properties of <class namespace="Scktcomp">TAbstractSocket</class> describe the IP address of the socket and service it provides or seeks. Not all descendants of <class namespace="Scktcomp">TAbstractSocket</class> use all of these properties. For example, server sockets do not surface the IP address because it is read implicitly from the system running the application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Scktcomp">TAbstractSocket</class>. Use a descendant of <class namespace="Scktcomp">TAbstractSocket</class> to add the ability to communicate with other machines to an application. To create a socket that initiates the connection with another machine, use TClientSocket. To create a socket that responds to requests for connections from other machines, use TServerSocket.</para>
<condition os="Windows">Descendants of <method namespace="Scktcomp" class="TAbstractSocket">TAbstractSocket</method> must override the abstract or, in C++ terminology, pure virtual <method namespace="Scktcomp" class="TAbstractSocket">Event</method> method to provide a response to calls that arise during the normal functioning of the socket. Applications cannot call <method namespace="Scktcomp" class="TAbstractSocket">Event</method>. The Windows socket object calls <method namespace="Scktcomp" class="TAbstractSocket">Event</method> at appropriate times.</condition>
<condition os="Windows">The Socket parameter indicates the Windows socket object that calls <method namespace="Scktcomp" class="TAbstractSocket">Event</method> to indicate when specific events occur. </condition>
<condition os="Windows">The Socket<method namespace="Scktcomp" class="TAbstractSocket">Event</method> parameter indicates the event that occurred. It has one of the following values:</condition>
<para>(client sockets only) The Windows socket object is about to locate the server socket. Changing the properties of the client socket has no effect at this point, but changes to the Windows socket object specified by the Socket parameter will affect the attempted connection.</para>
</td>
</tr>
<tr>
<td>
<para>seConnecting</para>
</td>
<td>
<para>(client sockets only) The server socket has been located but the connection isn't completed. This is the first opportunity to obtain the actual server port and IP address used for the connection, which may differ from those of the listening socket contacted initially.</para>
</td>
</tr>
<tr>
<td>
<para>seConnect</para>
</td>
<td>
<para>The socket connection has just been established. This is the point when a socket starts reading or writing over the connection.</para>
</td>
</tr>
<tr>
<td>
<para>seListen</para>
</td>
<td>
<para>(server sockets only) The Windows socket object has been initialized and is about to open a listening connection. Changing the properties of the server socket has no effect at this point, but changes to the Windows socket object specified by the Socket parameter will the listening connection.</para>
</td>
</tr>
<tr>
<td>
<para>seAccept</para>
</td>
<td>
<para>(server sockets only) A client connection request has just been accepted. This is the first opportunity to obtain the port and IP address of the individual client connection.</para>
</td>
</tr>
<tr>
<td>
<para>seWrite</para>
</td>
<td>
<para>The socket is ready for information to be written.</para>
</td>
</tr>
<tr>
<td>
<para>seRead</para>
</td>
<td>
<para>The socket is receiving information from a socket on the other end of the connection.</para>
<condition os="Windows">Descendants of <method namespace="Scktcomp" class="TAbstractSocket">TAbstractSocket</method> must override the abstract or, in C++ terminology, pure virtual <method namespace="Scktcomp" class="TAbstractSocket">Error</method> method to provide a response when socket errors occur. Applications cannot call <method namespace="Scktcomp" class="TAbstractSocket">Error</method>. The Windows socket object that encounters the error condition calls <method namespace="Scktcomp" class="TAbstractSocket">Error</method> automatically.</condition>
<condition os="Windows">The <method namespace="Scktcomp" class="TAbstractSocket">Error</method>Event parameter indicates what the socket was trying to do when the error occurred. It has one of the following values:</condition>
<para>The socket received an error message that does not fit into any of the following categories.</para>
</td>
</tr>
<tr>
<td>
<para>eeSend</para>
</td>
<td>
<para>An error occurred when trying to write to the socket connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeReceive</para>
</td>
<td>
<para>An error occurred when trying to read from the socket connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeConnect</para>
</td>
<td>
<para>For client sockets, this indicates that the client socket can't locate the server, or that a problem on the server prevents the opening of a connection. For server sockets, this indicates that a client connection request that has already been accepted could not be completed. </para>
</td>
</tr>
<tr>
<td>
<para>eeDisconnect</para>
</td>
<td>
<para>An error occurred when trying to close a connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeAccept</para>
</td>
<td>
<para>For server sockets only, this indicates that a problem occurred when trying to accept a client connection request.</para>
<condition os="Windows">The <method namespace="Scktcomp" class="TAbstractSocket">Error</method>Code parameter is the error code received by the Windows socket object. Setting this value to 0 in the <method namespace="Scktcomp" class="TAbstractSocket">Error</method> method prevents the socket from raising an exception. For information on possible error codes, see the Microsoft documentation on Windows sockets.</condition>
</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.DoActivate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the prototype of a method to open or close the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="Scktcomp" class="TAbstractSocket">TAbstractSocket</method> override <method namespace="Scktcomp" class="TAbstractSocket">DoActivate</method> to provide a method that initiates or terminates the socket connection. The steps that need to be taken to open or close a connection depend on whether the socket is a client socket or a server socket.</para>
<condition os="Windows">Applications cannot call this protected method. <method namespace="Scktcomp" class="TAbstractSocket">InitSocket</method> is called automatically by the socket's constructor, immediately after the Windows socket object is created. It allows the socket component to respond to events on the Windows socket object by assigning an OnErrorEvent handler that calls Error and an OnSocketEvent handler that calls Event.</condition>
<condition os="Windows">The Socket parameter specifies the Windows socket object that passes events on to the socket component.</condition>
</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Loaded">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens or closes the socket connection when the socket is loaded from a file, depending on the saved value of the Active property. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications cannot call this protected method. <method namespace="Scktcomp" class="TAbstractSocket">Loaded</method> is called automatically after the socket component has been loaded from a stream. <method namespace="Scktcomp" class="TAbstractSocket">Loaded</method> overrides the default method to implement the value of the Active property that was saved with the socket component.</para>
<method namespace="Scktcomp" class="TAbstractSocket">Open</method>s the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Scktcomp" class="TAbstractSocket">Open</method> to initiate the socket connection. <method namespace="Scktcomp" class="TAbstractSocket">Open</method> sets the Active property to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Scktcomp" class="TAbstractSocket">Open</method> locates and connects to a server. For server sockets, <method namespace="Scktcomp" class="TAbstractSocket">Open</method> opens the socket connection in a listening mode, but does not complete the connection to a client socket.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.Close">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shuts down the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Scktcomp" class="TAbstractSocket">Close</method> to shut down the socket connection. <method namespace="Scktcomp" class="TAbstractSocket">Close</method> sets the Active property to false.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <method namespace="Scktcomp" class="TAbstractSocket">Close</method> terminates the connection to the server. For server sockets, <method namespace="Scktcomp" class="TAbstractSocket">Close</method> shuts down the connection so that the server socket is no longer listening for client requests.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Active">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the socket connection is open and available for communication with other machines.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Before attempting to use or change the socket connection, read <property namespace="Scktcomp" class="TAbstractSocket">Active</property> to determine whether the connection is open and ready. For client sockets, setting <property namespace="Scktcomp" class="TAbstractSocket">Active</property> opens or shuts down a socket connection to another machine. For server sockets, setting <property namespace="Scktcomp" class="TAbstractSocket">Active</property> opens or shuts down a listening connection that makes the socket available for client requests.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time, set <property namespace="Scktcomp" class="TAbstractSocket">Active</property> to true to make the socket open a connection when the application starts running. At runtime, use the Open or Close method to open or close the connection.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Address">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the IP address of the server system.</para>
<property namespace="Scktcomp" class="TAbstractSocket">Address</property> is a string of four numeric (byte) values in the standard Internet dot notation, such as</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, set <property namespace="Scktcomp" class="TAbstractSocket">Address</property> to the IP address of the server to which the socket should connect. When the connection is opened, the value of <property namespace="Scktcomp" class="TAbstractSocket">Address</property> is bound to the connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the socket specifies the Host property, the address for the connection is taken from the IP address associated with Host, rather than the value of <property namespace="Scktcomp" class="TAbstractSocket">Address</property>. Specifying the server system by giving the IP address is faster, because the socket doesn't need to search for the IP address associated with the host name before it can locate the server system.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A single system may support more than one IP address.</para>
<para>Trying to change <property namespace="Scktcomp" class="TAbstractSocket">Address</property> when the connection is open will raise an ESocketError exception.</para>
</note>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Host">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies an alias for the IP address of the server system.</para>
<property namespace="Scktcomp" class="TAbstractSocket">Host</property> is a string containing the domain name and service of a particular system, such as </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, set <property namespace="Scktcomp" class="TAbstractSocket">Host</property> to the system with which the client socket should form a connection. When the socket opens a connection, it looks up the IP address for the server socket using the value of <property namespace="Scktcomp" class="TAbstractSocket">Host</property>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Some servers change the system or IP address that is associated with a particular host name. Using a host name allows the client socket to find the abstract site represented by the host name, even when it has moved to a new IP address.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="Scktcomp" class="TAbstractSocket">Host</property> is set, it takes precedence over the Address property when looking up the address of the server.</para>
<para>Trying to change <property namespace="Scktcomp" class="TAbstractSocket">Host</property> when the connection is open will raise an ESocketError exception.</para>
</note>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Port">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the ID number that identifies the server socket connection.</para>
<property namespace="Scktcomp" class="TAbstractSocket">Port</property> numbers allow a single system, identified by the Host or Address property, to host multiple connections simultaneously. Many values of <property namespace="Scktcomp" class="TAbstractSocket">Port</property> are associated by convention with a particular service such as ftp or http.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For server sockets, <property namespace="Scktcomp" class="TAbstractSocket">Port</property> is the ID of the connection on which the server socket listens for client requests. Server sockets generally set <property namespace="Scktcomp" class="TAbstractSocket">Port</property> to a predefined value which clients can use to initiate connections.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For client sockets, <property namespace="Scktcomp" class="TAbstractSocket">Port</property> is the ID of the desired server connection. The value of <property namespace="Scktcomp" class="TAbstractSocket">Port</property> is usually associated with the service the client wishes to use on the server application.</para>
<para>Trying to change <property namespace="Scktcomp" class="TAbstractSocket">Port</property> when the connection is open will raise an ESocketError exception.</para>
</note>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Service">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the service for which the socket connection is used.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Scktcomp" class="TAbstractSocket">Service</property> to identify the use of the connection. <condition os="Windows">Windows provides</condition>
<condition os="Linux">There are</condition> a number of standard service names such as ftp, http, finger, and time. Servers can specify additional services and their associated ports<condition os="Windows"> in a SERVICES file</condition>.<condition os="Windows"> For more information, see the Microsoft documentation for Windows sockets.</condition>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Certain port numbers are reserved for specific values of service. Thus, <property namespace="Scktcomp" class="TAbstractSocket">Service</property> provides a more meaningful way to specify the server Port to use for the socket connection. For server sockets, using <property namespace="Scktcomp" class="TAbstractSocket">Service</property> rather than Port ensures that the server will listen for TCP/IP requests on the appropriate port.</para>
<para>Trying to change <property namespace="Scktcomp" class="TAbstractSocket">Service</property> when the connection is open will raise an ESocketError exception.</para>
<class namespace="Scktcomp">TCustomSocket</class> is the base class for socket components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Override <class namespace="Scktcomp">TCustomSocket</class> to create a socket component that can be assigned event handlers for the events and error conditions that occur. In addition to the properties and methods introduced by TAbstractSocket that enable an application to work with <condition os="Windows">Windows </condition>sockets, <class namespace="Scktcomp">TCustomSocket</class> introduces several events that can be used by applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Scktcomp">TCustomSocket</class>. Use a descendant of <class namespace="Scktcomp">TCustomSocket</class> to add the ability to communicate with other machines using TCP/IP. To create a socket that initiates the connection with another machine, use TClientSocket. To create a socket that responds to requests for connections from other machines, use TServerSocket.</para>
<condition os="Windows">Applications cannot call <method namespace="Scktcomp" class="TCustomSocket">Event</method>. It is called automatically when various events occur. Override <method namespace="Scktcomp" class="TCustomSocket">Event</method> to introduce class-specific responses when certain events occur or to prevent the socket from calling the associated event handler.</condition>
<condition os="Windows">The Socket parameter indicates the Windows socket object that calls <method namespace="Scktcomp" class="TCustomSocket">Event</method> to indicate when specific events occur. </condition>
<condition os="Windows">Applications cannot call <method namespace="Scktcomp" class="TCustomSocket">Error</method>. It responds to error conditions by calling the On<method namespace="Scktcomp" class="TCustomSocket">Error</method> event handler if it is assigned. Override <method namespace="Scktcomp" class="TCustomSocket">Error</method> to add class-specific error processing or to block the On<method namespace="Scktcomp" class="TCustomSocket">Error</method> event.</condition>
<condition os="Windows">The <method namespace="Scktcomp" class="TCustomSocket">Error</method>Event parameter indicates what the socket was trying to do when the error occurred. It has one of the following values:</condition>
<para>The socket received an error message that does not fit into any of the following categories.</para>
</td>
</tr>
<tr>
<td>
<para>eeSend</para>
</td>
<td>
<para>An error occurred when trying to write to the socket connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeReceive</para>
</td>
<td>
<para>An error occurred when trying to read from the socket connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeConnect</para>
</td>
<td>
<para>For client sockets, this indicates that the client socket can't locate the server, or that a problem on the server prevents the opening of a connection. For server sockets, this indicates that a client connection request that has already been accepted could not be completed. </para>
</td>
</tr>
<tr>
<td>
<para>eeDisconnect</para>
</td>
<td>
<para>An error occurred when trying to close a connection.</para>
</td>
</tr>
<tr>
<td>
<para>eeAccept</para>
</td>
<td>
<para>For server sockets only, this indicates that a problem occurred when trying to accept a client connection request.</para>
<condition os="Windows">The <method namespace="Scktcomp" class="TCustomSocket">Error</method>Code parameter is the error code received by the Windows socket object. Setting this value to 0 in the <method namespace="Scktcomp" class="TCustomSocket">Error</method> method prevents the socket from raising an exception. For information on possible error codes, see the Microsoft documentation on Windows sockets.</condition>
</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnLookup">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket is about to look up the server socket with which it wants to connect.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnLookup</event> event handler for a client socket to take specific action just before attempting to locate a server socket.<condition os="Windows"> This is the first opportunity to make Windows API calls that affect the client properties of the socket, such as specifying a particular port number. Use the SocketHandle property of the Socket parameter for Windows API calls.</condition>
<condition os="Windows">1An <event namespace="Scktcomp" class="TCustomSocket">OnLookup</event> event occurs prior to an attempt to locate the server socket.</condition>
<para>Changing the Address, Host, Port, or Service properties of socket component in an <event namespace="Scktcomp" class="TCustomSocket">OnLookup</event> event handler has no effect on the address or port used to locate a server socket. These properties must be correct before the Open method is called.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnConnecting">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs for a client socket after the server socket has been located, but before the connection is established.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnConnecting</event> event handler for a client socket to take specific action just before the connection to a server socket is established. This is the first opportunity to obtain the actual port and IP address of the server endpoint of the connection that is about to form.</para>
<condition os="Windows">3An <event namespace="Scktcomp" class="TCustomSocket">OnConnecting</event> event occurs after the server socket is located.</condition>
<condition os="Windows">5An OnConnect event occurs after the connection is established.</condition>
</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnConnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs on client sockets just after the connection to the server is opened.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnConnect</event> event handler for a client socket to take specific action after the connection to a server socket has been established. Depending on the service, this may be the point when the socket should start reading or writing over the connection.</para>
<condition os="Windows">3An <event namespace="Scktcomp" class="TCustomSocket">OnConnect</event>ing event occurs after the server socket is located.</condition>
<condition os="Windows">5An <event namespace="Scktcomp" class="TCustomSocket">OnConnect</event> event occurs after the connection is established.</condition>
</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnDisconnect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs just before a client socket closes the connection to a server socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnDisconnect</event> event handler to take specific action when the connection to a server socket is about to be terminated. <event namespace="Scktcomp" class="TCustomSocket">OnDisconnect</event> occurs after the value of the Active property is set to false, but before the actual connection is closed.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnListen">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs just before a server socket is opened for listening.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnListen</event> event handler for a server socket to take specific action just before the socket is opened for listening. <event namespace="Scktcomp" class="TCustomSocket">OnListen</event> occurs after Address and Port have been bound to the socket connection, but before it is opened. This is the last opportunity to make changes to the socket endpoint before it is opened for listening.<condition os="Windows"> Use the SocketHandle property of the Socket parameter for Windows API calls that change the socket.</condition>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Server sockets open a socket connection for listening to establish a queue to hold client requests. The connection to a client socket is completed when a request from the queue is accepted.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnAccept">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs on server sockets just after the connection to a client socket is accepted.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnAccept</event> event handler for a server socket to take specific action after the connection to a client socket has been accepted. This is the first point when information is available about the local port and IP address that will be used in the server endpoint of the connection. The port number, and possibly the IP address, will differ from those of the listening socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Server sockets open a socket connection for listening to establish a queue to hold client requests. After a request from the queue is accepted by the server socket, an <event namespace="Scktcomp" class="TCustomSocket">OnAccept</event> event occurs. After the server socket accepts the connection, the client socket completes the connection, and an OnConnect event occurs for the client socket.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnRead">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket should read information from the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnRead</event> event handler to read from the socket connection. <condition os="Windows">If the socket is a blocking socket, use a TWinSocketStream object to read from the connection. Otherwise, u</condition>
<condition os="Linux">U</condition>se the methods of the Socket parameter to perform the actual reading.</para>
<para>Non-blocking sockets do not always receive an <event namespace="Scktcomp" class="TCustomSocket">OnRead</event> event for the last bit of data passed over the connection. When using a non-blocking socket, check for any unread data in the OnDisconnect event to make sure that everything is handled.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnWrite">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket should write information to the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnWrite</event> to write from the socket connection. <condition os="Windows">If the socket is a blocking socket, use a TWinSocketStream object to write to the connection. Otherwise, u</condition>
<condition os="Linux">U</condition>se the methods of the Socket parameter to perform the actual writing.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnError">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the socket fails in making, using, or shutting down a connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Scktcomp" class="TCustomSocket">OnError</event> event handler to respond to errors that arise with the socket connection. Set the ErrorCode parameter to 0 if the <event namespace="Scktcomp" class="TCustomSocket">OnError</event> event handler successfully deals with the error condition, to prevent an ESocketError from being raised.</para>
<class namespace="scktcomp">TWinSocketStream</class> is a stream that provides services which allow applications to read from or write to socket connections.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="scktcomp">TWinSocketStream</class> to read or write information over a blocking socket connection. Windows socket objects include methods to read from or write to the socket connection they represent. However, these methods do not provide a mechanism for timing out when the socket connection is dropped or for waiting until the socket connection is ready before reading. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the socket is a non-blocking socket, this lack of a time-out or waiting mechanism is not a problem, because reading and writing occur asynchronously in response to notifications from the socket connection. For blocking sockets, however, these mechanisms provided by <class namespace="scktcomp">TWinSocketStream</class> are necessary so that the application using the socket does not hang indefinitely.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To use a Windows socket stream, create an instance of <class namespace="scktcomp">TWinSocketStream</class>, use the methods of the stream to read or write the data, and then free the Windows socket stream.</para>
<class namespace="scktcomp">TWinSocketStream</class> does not work with non-blocking sockets.</para>
</note>
</comments>
</member>
<member name="M:ScktComp.ScktComp.WaitForData">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Waits up to TimeOut milliseconds for the socket connection to be ready to transfer data.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TWinSocketStream">WaitForData</method> to ensure that the socket connection is ready to read or write information. <method namespace="scktcomp" class="TWinSocketStream">WaitForData</method> returns true if the socket connection is ready. <method namespace="scktcomp" class="TWinSocketStream">WaitForData</method> returns false if the socket connection is not ready after TimeOut milliseconds elapse.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TWinSocketStream">WaitForData</method> before reading or writing information over the socket connection. Otherwise, Read or Write method calls may time out before any data is transferred.</para>
<method namespace="scktcomp" class="TWinSocketStream">Read</method>s up to Count bytes from the socket connection into Buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TWinSocketStream">Read</method> to read data from the socket connection when the number of bytes to be transferred is unknown. Buffer must have at least Count bytes allocated to hold the data that is read from the connection. <method namespace="scktcomp" class="TWinSocketStream">Read</method> returns the number of bytes actually transferred (which may be less than the number requested in Count.) </para>
<method namespace="scktcomp" class="TWinSocketStream">Read</method> may return 0 if the socket connection is extremely slow and the read operation has not completed after TimeOut milliseconds. This ensures that the <method namespace="scktcomp" class="TWinSocketStream">Read</method> method does not hang indefinitely when a problem occurs with the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To guard against the <method namespace="scktcomp" class="TWinSocketStream">Read</method> method timing out because of a slow connection, set Count fairly low, and make several calls to <method namespace="scktcomp" class="TWinSocketStream">Read</method>, rather than fewer calls with a large value of Count.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To ensure that the socket connection is ready to send data before calling <method namespace="scktcomp" class="TWinSocketStream">Read</method>, use the WaitForData method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unlike the <method namespace="scktcomp" class="TWinSocketStream">Read</method>Buffer method, <method namespace="scktcomp" class="TWinSocketStream">Read</method> does not raise an exception if Count bytes are not read from the socket connection.</para>
<method namespace="scktcomp" class="TWinSocketStream">Write</method>s Count bytes from Buffer to the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="scktcomp" class="TWinSocketStream">Write</method> to write data from a Buffer to the socket connection. <method namespace="scktcomp" class="TWinSocketStream">Write</method> returns the number of bytes transferred.</para>
<method namespace="scktcomp" class="TWinSocketStream">Write</method> may return 0 if the socket connection is extremely slow and the write operation has not completed after TimeOut milliseconds. This ensures that the <method namespace="scktcomp" class="TWinSocketStream">Write</method> method does not hang indefinitely when a problem occurs with the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To guard against the <method namespace="scktcomp" class="TWinSocketStream">Write</method> method timing out because of a slow connection, set Count fairly low, and make several calls to <method namespace="scktcomp" class="TWinSocketStream">Write</method>, rather than fewer calls with a large value of Count.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unlike the <method namespace="scktcomp" class="TWinSocketStream">Write</method>Buffer method, <method namespace="scktcomp" class="TWinSocketStream">Write</method> does not raise an exception if Count bytes are not written. For example, if the connection is too slow to transfer all the data, <method namespace="scktcomp" class="TWinSocketStream">Write</method> will return 0, where <method namespace="scktcomp" class="TWinSocketStream">Write</method>Buffer will raise an exception.</para>
<method namespace="scktcomp" class="TWinSocketStream">Seek</method> overrides the inherited method to always set the Position property of the <method namespace="scktcomp" class="TWinSocketStream">TWinSocketStream</method> object to 0. Socket connections do not support random access. The Position property of a Windows socket stream can only reflect the position at the beginning of all remaining data.</para>
<method namespace="scktcomp" class="TWinSocketStream">Create</method>s an instance of <method namespace="scktcomp" class="TWinSocketStream">TWinSocketStream</method> for a Windows socket object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="scktcomp" class="TWinSocketStream">Create</method> to obtain an instance of <method namespace="scktcomp" class="TWinSocketStream">TWinSocketStream</method> for reading from or writing to the socket connection represented by the ASocket parameter. ASocket should be the endpoint of an open blocking socket connection to another Windows socket.</para>
<method namespace="scktcomp" class="TWinSocketStream">Create</method> associates the stream with the socket connection, and allocates helper objects to allow it to determine when the socket connection is ready for reading or writing. The TimeOut property (the number of milliseconds before a read or write operation aborts) is initialized to the value of the TimeOut parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If ASocket represents a non-blocking socket connection, <method namespace="scktcomp" class="TWinSocketStream">Create</method> raises an ESocketError exception.</para>
<method namespace="scktcomp" class="TWinSocketStream">Destroy</method>s an instance of <method namespace="scktcomp" class="TWinSocketStream">TWinSocketStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="scktcomp" class="TWinSocketStream">Destroy</method> directly in an application. Instead call Free. Free verifies that the <method namespace="scktcomp" class="TWinSocketStream">TWinSocketStream</method> reference is not nil and only then calls <method namespace="scktcomp" class="TWinSocketStream">Destroy</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Free the <method namespace="scktcomp" class="TWinSocketStream">TWinSocketStream</method> object when it is no longer needed for reading from or writing to the socket connection.</para>
<method namespace="scktcomp" class="TWinSocketStream">Destroy</method> frees the helper objects allocated in the Create method before calling the default destructor.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.TimeOut">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the time, in milliseconds, that the socket stream should wait before timing out on a read or write call.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="scktcomp" class="TWinSocketStream">TimeOut</property> to the amount of time that should elapse before a read or write operation aborts under the assumption that the socket connection has failed.</para>
<class namespace="ScktComp">TClientSocket</class> manages socket connections for a TCP/IP client.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add a <class namespace="ScktComp">TClientSocket</class> object to a form or data module to turn an application into a TCP/IP client. <class namespace="ScktComp">TClientSocket</class> specifies a desired connection to a TCP/IP server, manages the connection when it is open, and terminates the connection when the application is through.</para>
<method namespace="ScktComp" class="TClientSocket">Create</method>s an instance of <method namespace="ScktComp" class="TClientSocket">TClientSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="ScktComp" class="TClientSocket">Create</method> to create and initialize a client socket component at runtime. <method namespace="ScktComp" class="TClientSocket">TClientSocket</method> objects placed at design time are created automatically.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="ScktComp" class="TClientSocket">Create</method>
<method namespace="ScktComp" class="TClientSocket">Destroy</method>s an instance of <method namespace="ScktComp" class="TClientSocket">TClientSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="ScktComp" class="TClientSocket">Destroy</method> directly in an application. Instead, call Free. Free verifies that the client socket is not nil, and only then calls <method namespace="ScktComp" class="TClientSocket">Destroy</method>.</para>
<method namespace="ScktComp" class="TClientSocket">Destroy</method> frees the TClientWinSocket object that describes the client endpoint of the Windows socket connection.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Socket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the client endpoint of the Windows client socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="ScktComp" class="TClientSocket">Socket</property> to </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determine the address and port of both the client and server sockets that are bound to the connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read or write information through the socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determine what server notifications the client will respond to.</para>
<condition os="Windows">Obtain the Windows socket handle for making Windows socket API calls.</condition>
</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ClientType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether the client socket reads and writes information asynchronously over the socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="ScktComp" class="TClientSocket">ClientType</property> to ctNonBlocking to enable the client socket to respond to asynchronous reading and writing events. When <property namespace="ScktComp" class="TClientSocket">ClientType</property> is ctNonBlocking, execution is not blocked by reading and writing over the socket connection. OnRead or OnWrite events occur when the socket needs to read or write over the connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="ScktComp" class="TClientSocket">ClientType</property> to ctBlocking to force all reading and writing to occur synchronously. It is a good idea to include the client socket object in a thread if the <property namespace="ScktComp" class="TClientSocket">ClientType</property> is ctBlocking, so that I/O does not block all execution within the client application. </para>
<condition os="Windows">When <property namespace="ScktComp" class="TClientSocket">ClientType</property> is ctBlocking, use a TWinSocketStream object for reading and writing. TWinSocketStream prevents the application from hanging indefinitely if a problem occurs while reading or writing. It also can wait for the socket connection to indicate its readiness for reading.</condition>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a non-blocking socket when the socket needs to synchronize reading and writing with server sockets.</para>
<class namespace="ScktComp">TCustomServerSocket</class> introduces new properties and events specific to the functions of a TCP/IP server. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="ScktComp">TCustomServerSocket</class>. Use <class namespace="ScktComp">TCustomServerSocket</class> as a base class when declaring server socket objects that listen for connection requests from other machines.</para>
</comments>
</member>
<member name="M:ScktComp.ScktComp.DoActivate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens or Closes the socket connection.</para>
<method namespace="ScktComp" class="TCustomServerSocket">DoActivate</method> provides the underlying implementation of the Open and Close methods. When Value is true, <method namespace="ScktComp" class="TCustomServerSocket">DoActivate</method> opens a listening connection to accept connection requests. When Value is false, <method namespace="ScktComp" class="TCustomServerSocket">DoActivate</method> terminates the current listening connection and any connections to client sockets.</para>
<method namespace="ScktComp" class="TCustomServerSocket">Destroy</method>s an instance of <method namespace="ScktComp" class="TCustomServerSocket">TCustomServerSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="ScktComp" class="TCustomServerSocket">Destroy</method> directly in an application. Instead, call Free. Free checks that the server socket is not nil, and only then calls <method namespace="ScktComp" class="TCustomServerSocket">Destroy</method>.</para>
<method namespace="ScktComp" class="TCustomServerSocket">Destroy</method> frees the TServerWinSocket object that describes the server endpoint of the listening connection.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.ServerType">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether each connection accepted by the server socket is non-blocking, or if it is automatically given a separate execution thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="ScktComp" class="TCustomServerSocket">ServerType</property> to stThreadBlocking to automatically spawn a new thread for each socket connection accepted by the server socket. When <property namespace="ScktComp" class="TCustomServerSocket">ServerType</property> is stThreadBlocking, the execution of the connection thread is suspended while reading or writing until all information has been transferred over the connection. The thread for each connection generates OnClientRead or OnClientWrite events when the server socket needs to read or write.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="ScktComp" class="TCustomServerSocket">ServerType</property> to stNonBlocking to handle all reading and writing over the socket connections asynchronously. When <property namespace="ScktComp" class="TCustomServerSocket">ServerType</property> is stNonBlocking, all client connections are handled in a single execution thread by default. OnClientRead or OnClientWrite events occur when the client socket on the other end of one of the connections tries to send or receive information over the connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a non-blocking socket when the socket needs to synchronize reading and writing with client sockets.</para>
<para>When <property namespace="ScktComp" class="TCustomServerSocket">ServerType</property> is stThreadBlocking, it is important that the OnClient... event handlers contain thread-safe code. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the maximum number of threads that can be reused for new client connections.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When ServerType is stThreadBlocking, each new connection that is accepted by the server socket is given a separate execution thread. In order to improve performance, server sockets store these threads in a cache rather than freeing them when the connection is closed. New connections can then reuse threads from the cache, rather than requiring the socket server to create a new thread every time a connection is accepted.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="ScktComp" class="TCustomServerSocket">ThreadCacheSize</property> to specify the number of threads that are cached for reuse. The ideal value for <property namespace="ScktComp" class="TCustomServerSocket">ThreadCacheSize</property> depends on the number and frequency of client socket requests received by the server socket. If <property namespace="ScktComp" class="TCustomServerSocket">ThreadCacheSize</property> is too low, the server socket will spend more time freeing and creating threads when client connections are accepted. If <property namespace="ScktComp" class="TCustomServerSocket">ThreadCacheSize</property> is too high, the server socket may unnecessarily lock up the memory for threads that are never reused.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnGetThread">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket needs to create a new execution thread for a connection to a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnGetThread</event> event handler to create a specialized descendant of TServerClientThread for the connection to the client socket. Return the new TServerClientThread object in the SocketThread parameter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most applications that use thread-blocking server components will want to provide an <event namespace="ScktComp" class="TCustomServerSocket">OnGetThread</event> event handler and implement a TServerClientThread that handles its own reading and writing in a thread-safe manner rather than relying on the default TServerClientThread which triggers OnClientRead and OnClientWrite events. This is because the OnClientRead and OnClientWrite event handlers reside on the server socket, which is in global memory.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinSocket object that describes the server endpoint of the listening connection. The ClientSocket parameter is the TServerClientWinSocket object that describes the server endpoint of the connection to the client socket that is about to be formed.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnGetSocket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket needs to create a new TServerClientWinSocket object to represent the server endpoint of a connection to a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnGetSocket</event> event handler to create a specialized descendant of TServerClientWinSocket for the server socket component to use. Return the new TServerClientWinSocket object in the ClientSocket parameter. The Sender parameter is the TServerWinSocket object that describes the server endpoint of the listening connection.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnThreadStart">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the execution thread for a connection to a client socket starts up.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnThreadStart</event> to initialize the TServerClientThread for the connection to a single client socket. The Sender parameter is the TServerWinSocket that describes the server endpoint of the listening connection. The Thread parameter is the thread that is about to start execution.</para>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnThreadEnd">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket connection is terminated and the associated thread finishes execution.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnThreadEnd</event> to take specific action when the thread for a client connection finishes execution. <event namespace="ScktComp" class="TCustomServerSocket">OnThreadEnd</event> occurs after the OnClientDisconnect event.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the TServerWinSocket that describes the server endpoint of the listening connection. The Thread parameter is the thread that is finishing up.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a client socket completes a connection accepted by the server socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> event handler to take specific action when a client socket completes the socket connection to the server socket. For example, the socket may start reading or writing over the connection in an <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> event handler.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The order of server socket events leading up to <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> is as follows:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1An OnListen event occurs just before the server socket is opened for listening.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2The server socket receives client requests in a listening queue. The server socket accepts one of those requests, and receives a Windows socket handle for the new socket connection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3The server socket generates an OnGetSocket event, passing in the Windows socket handle. If a TServerClientWinSocket object for the server endpoint of the new connection is not created in an OnGetSocket event handler, the server socket creates one. The TServerWinSocket object continues to listen for other clients.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">4An OnAccept event occurs, using the new TServerClientWinSocket object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5If ServerType is stThreadBlocking and no thread is available in the cache, an OnGetThread event occurs. If the OnGetThread event handler does not create a thread, the server socket creates a TServerClientThread.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">6If ServerType is stThreadBlocking, an OnThreadStart event occurs as the thread begins execution.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">7The client completes the connection to the TServerClientWinSocket object and an <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> event occurs.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> event handler is thread-safe. Use the GetClientThread method of the Sender parameter to access thread-specific information.</para>
<para>The <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> event handler for TServerSocket is also set when setting the <event namespace="ScktComp" class="TCustomServerSocket">OnClientConnect</event> event handler of the associated TServerWinSocket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when one of the connections to a client socket is closed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnClientDisconnect</event> event handler to take specific action when the connection to a client socket is ending. The termination of a client connection does not close the server socket. The server socket remains open and listening for client requests on its listening connection. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TServerClientWinSocket that describes the server endpoint of the client connection is freed after <event namespace="ScktComp" class="TCustomServerSocket">OnClientDisconnect</event>. If ServerType is stThreadBlocking, OnThreadEnd occurs after <event namespace="ScktComp" class="TCustomServerSocket">OnClientDisconnect</event>.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="ScktComp" class="TCustomServerSocket">OnClientDisconnect</event> event handler is thread-safe. Use the GetClientThread method of the Sender parameter to access thread-specific information.</para>
<para>The <event namespace="ScktComp" class="TCustomServerSocket">OnClientDisconnect</event> event handler for TServerSocket is also set when setting the <event namespace="ScktComp" class="TCustomServerSocket">OnClientDisconnect</event> event handler of the associated TServerWinSocket.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnClientRead">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket should read information from a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an OnClientWrite event handler to write to the socket connection. If the ServerType property is stThreadBlocking, use a TWinSocketStream object to prevent problems that arise while writing from causing the execution thread to hang indefinitely. Otherwise, uUse the methods of the Socket parameter to perform the actual writing.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="ScktComp" class="TCustomServerSocket">OnClientRead</event> event handler is thread-safe. Use the GetClientThread method of the Sender parameter to access thread-specific information.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnClientWrite">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the server socket should write information to a client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnClientWrite</event> event handler to write to the socket connection. If the ServerType property is stThreadBlocking, use a TWinSocketStream object to prevent problems that arise while writing from causing the execution thread to hang indefinitely. Otherwise, uUse the methods of the Socket parameter to perform the actual writing.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="ScktComp" class="TCustomServerSocket">OnClientWrite</event> event handler is thread-safe. Use the GetClientThread method of the Sender parameter to access thread-specific information.</para>
</note>
</comments>
</member>
<member name="E:ScktComp.ScktComp.OnClientError">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when there is a failure in establishing, using, or terminating the socket connection to an individual client socket.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="ScktComp" class="TCustomServerSocket">OnClientError</event> event handler to respond to errors that arise with a connection to an individual client. Set the ErrorCode parameter to 0 if the <event namespace="ScktComp" class="TCustomServerSocket">OnClientError</event> event handler successfully deals with the error condition to prevent an ESocketError from being raised.</para>
<para>If ServerType is stThreadBlocking, make sure that all code in an <event namespace="ScktComp" class="TCustomServerSocket">OnClientError</event> event handler is thread-safe. Use the GetClientThread method of the Sender parameter to access thread-specific information.</para>
<para>The <event namespace="ScktComp" class="TCustomServerSocket">OnClientError</event> event handler for TServerSocket is also set when setting the <event namespace="ScktComp" class="TCustomServerSocket">OnClientError</event> event handler of the associated TServerWinSocket.</para>
<class namespace="ScktComp">TServerSocket</class> manages server socket connections for a TCP/IP server.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add a <class namespace="ScktComp">TServerSocket</class> object to a form or data module to turn an application into a TCP/IP server. <class namespace="ScktComp">TServerSocket</class> listens for requests for TCP/IP connections from other machines, and establishes connections when requests are received.</para>
<method namespace="ScktComp" class="TServerSocket">Create</method>s an instance of <method namespace="ScktComp" class="TServerSocket">TServerSocket</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="ScktComp" class="TServerSocket">Create</method> to create and initialize a server socket component at runtime. <method namespace="ScktComp" class="TServerSocket">TServerSocket</method> objects placed at design time are created automatically.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="ScktComp" class="TServerSocket">Create</method>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Allocates the TServerWinSocket object that encapsulates the Windows socket connection for the server socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the event and error dispatchers for the server socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes ThreadCacheSize to 10.</para>
</comments>
</member>
<member name="P:ScktComp.ScktComp.Socket">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the TServerWin<property namespace="ScktComp" class="TServerSocket">Socket</property> object that describes the endpoint of the listening connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="ScktComp" class="TServerSocket">Socket</property> to obtain</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Information about the connections currently active on the server socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Information about the connection threads that are cached for use by the server socket.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Access to the Windows socket handle for the listening connection that is needed for Windows socket API calls.</para>
</comments>
</member>
<member name="M:ScktComp.SetErrorProc">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Replaces the exception handler for error messages that are received from a Windows socket connection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="ScktComp">SetErrorProc</routine> to assign an exception handler for error messages from Windows socket API calls. By default, socket components have no special error handler and simply raise an ESocketError exception when they receive error messages. If an exception handler is assigned using <routine namespace="ScktComp">SetErrorProc</routine>, the socket component does not raise this exception.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ErrorProc parameter specifies the exception handler. It is passed the Windows socket error code. Inside this exception handler an application can compensate for the error or raise an exception. Passing a value of nil (Delphi) or NULL (C++) for the ErrorProc parameter restores the default behavior, where the socket component raises an ESocketError exception.</para>
<routine namespace="ScktComp">SetErrorProc</routine> returns the current exception handler. This value is nil (Delphi) or NULL (C++) when <routine namespace="ScktComp">SetErrorProc</routine> is called for the first time, and is the value of the ErrorProc parameter from the previous invocation of <routine namespace="ScktComp">SetErrorProc</routine> thereafter.</para>
</comments>
</member>
<member name="T:HelpIntfs.IHelpSelector">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Interface for Help Selector object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When an application uses more than one Help Viewer, there may be multiple responses to a Help request. By default, the Help System polls the Viewers in the order they were registered, and gives the request to the first viewer that claims to be able to handle it.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An application can optionally provide a Help Selector, which determines the Viewer for keyword-based Help requests and for requests to display a Table of Contents. To define a Help Selector, create an object that implements <class namespace="HelpIntfs">IHelpSelector</class> and pass it to the Help System, using AssignHelpSelector.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help Selector cannot affect context-based or topic-based Help requests, which always go to the first Viewer that claims to be able to handle the request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Keyword-based Help support for multiple Viewers.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="IHelpSelector">SelectKeyword</method> when more than one Help Viewer has topics that match a keyword-based Help request. The Keywords parameter contains a merged list of Help Strings, obtained by calling GetHelpStrings for each Viewer. <method namespace="HelpIntfs" class="IHelpSelector">SelectKeyword</method> indicates a specific topic by returning the index of a specific Help String. The Help System then passes this Help String to the ShowHelp method of the appropriate Viewer. If the return value is negative, the Help System assumes that the Help request has been aborted and does nothing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Typically, <method namespace="HelpIntfs" class="IHelpSelector">SelectKeyword</method> displays a dialog box so the user can choose one of the Help Strings, and returns the index of the user's choice, or a negative value if the user cancels the dialog. This duplicates a feature of most Viewers, but allows the user to see all matching topics in a single list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Choose Viewer to display Table of Contents.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="IHelpSelector">TableOfContents</method> when more than one Help Viewer responds to a request to show a Help Table of Contents. The Help System passes a list of Viewer names in the Contents parameter. <method namespace="HelpIntfs" class="IHelpSelector">TableOfContents</method> should return the index of the chosen Viewer's name.</para>
<method namespace="HelpIntfs" class="IHelpSelector">TableOfContents</method> must not modify or rearrange the Viewer names list.</para>
</note>
</comments>
</member>
<member name="T:HelpIntfs.IHelpSystem">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Application Help System that supports multiple Help Viewers.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Run-Time Library Help System allows an application to access one or more Help Viewers through a uniform interface, <class namespace="HelpIntfs">IHelpSystem</class>. To obtain an object that implements <class namespace="HelpIntfs">IHelpSystem</class>, use the HelpSystem property of the Application global variable, or call the global GetHelpSystem function.</para>
</comments>
</member>
<member name="M:HelpIntfs.HelpIntfs.Hook">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do a WinHelp-style Help request.</para>
<method namespace="HelpIntfs" class="IHelpSystem">Hook</method> accepts Help requests that uses the same conventions as the Microsoft Windows WinHelp API. <method namespace="HelpIntfs" class="IHelpSystem">Hook</method> should only be called for requests that cannot be translated into calls to ShowContextHelp, ShowHelp, ShowTableOfContents, or ShowTopicHelp.</para>
<para>If the Help System is unable to decipher the Help request, it looks for a Viewer that implements ISpecialWinHelpViewer. If the application has registered such a viewer, the request succeeds if the Viewer is able to handle it. Otherwise the request fails.</para>
</note>
</comments>
</member>
<member name="M:HelpIntfs.HelpIntfs.ShowHelp">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do Keyword-based Help request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HelpIntfs" class="IHelpSystem">ShowHelp</method> to submit a keyword-based Help request. By default, the RTL Help System gives the request to the first Help Viewer that claims to be able to handle it. Typically, the Viewer passes the Help request to an external Help engine, which displays a list of matching topics (if more than one topic matches) or goes directly to a specific topic (if a single topic matches).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To support keyword-based Help requests using multiple Help Viewers, assign a Help Selector, using the AssignHelpSelector method. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do Context-based Help request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HelpIntfs" class="IHelpSystem">ShowContextHelp</method> to display a single Help topic, identified by ContextID and HelpFileName. For context-based Help requests to work, the application must have previously registered at least one Help Viewer that implements IExtendedHelpViewer. If no such Viewer is found, an EHelpSystemException is raised.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Show Table of Contents.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HelpIntfs" class="IHelpSystem">ShowTableOfContents</method> to request that the Help System display a Table of Contents.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Show Help topic.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HelpIntfs" class="IHelpSystem">ShowTopicHelp</method> to request that the Help System display a specific Help topic. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Topic parameter is a short string identifying the specific topic.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HelpFileName parameter is the name of the file containing the topic. If this parameter is a zero-length string, the HelpFile property of the global Application variable is used.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Assign a Help Selector object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="HelpIntfs" class="IHelpSystem">AssignHelpSelector</method> to provide a Help Selector object. Use of a Help Selector allows an application to define the way a Help Viewer is chosen to handle keyword-based Help requests and requests to display a Table of Contents.</para>
</comments>
</member>
<member name="T:HelpIntfs.ICustomHelpViewer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Help Viewer access for Help System..</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Help Viewer is an object which handles application Help requests passed to it by the Help System on behalf of an application. A Help Viewer is typically a wrapper for an external application, such as a help engine or web browser.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help Viewer class must implement the <class namespace="HelpIntfs">ICustomHelpViewer</class> interface, or one of its descendant interfaces, IExtendedHelpViewer and ISpecialWinHelpViewer. The Help System uses methods from these interfaces to pass Help requests to the Help Viewer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To use a Help Viewer, an application must call the global RegisterViewer function. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Return string identifying Help Viewer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">GetViewerName</method> to obtain a string identifying the Help Viewer. Every Help Viewer within an application must return a unique Viewer Name.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Would respond to a keyword-based Help request.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">UnderstandsKeyword</method> to determine to determine if the Help Viewer can provide topics for a keyword-based Help request based on HelpString. <method namespace="HelpIntfs" class="ICustomHelpViewer">UnderstandsKeyword</method> should return the number of Help topics that would match such a request.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Return Help Strings that match a keyword.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">GetHelpStrings</method> to obtain a list of Help Strings for topics that match a keyword-based Help request. <method namespace="HelpIntfs" class="ICustomHelpViewer">GetHelpStrings</method> should expect the keyword in the parameter and return the Help Strings in a TStringList object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Help String is an identifying string associated with a specific topic. The Help System requires that each of the topics provided by a given Viewer have a different Help String. The Help System does not require that two Viewers never use the same Help String, but an application should still avoid doing this. One strategy is to include the Viewer Name in the Help String.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System uses Help Strings to provide the Help Selector with a merged list of Help topics that match a request. Typically, Help Strings are human-readable topic descriptions, and the Help Selector simply displays them to the user so the user can choose which topic will be displayed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Query support for Table of Contents.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System uses <method namespace="HelpIntfs" class="ICustomHelpViewer">CanShowTableOfContents</method> to determine which Help Viewers know how to display a Table of Contents. <method namespace="HelpIntfs" class="ICustomHelpViewer">CanShowTableOfContents</method> should return true if the Viewer is ready for a subsequent call to ShowTableOfContents. The Help System should not call ShowTableOfContents for a Viewer after <method namespace="HelpIntfs" class="ICustomHelpViewer">CanShowTableOfContents</method> returns false; if this occurs, the Viewer should raise an EHelpSystemException.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Show a Table of Contents.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">ShowTableOfContents</method> when it needs the Help Viewer to display a Table of Contents. The Help System does not call <method namespace="HelpIntfs" class="ICustomHelpViewer">ShowTableOfContents</method> for a Viewer unless that Viewer has previously returned true for a call to Can<method namespace="HelpIntfs" class="ICustomHelpViewer">ShowTableOfContents</method>.</para>
</comments>
</member>
<member name="M:HelpIntfs.HelpIntfs.ShowHelp">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Show a specific Help topic.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">ShowHelp</method> when it needs the Help Viewer to display the Help Topic identified by HelpString. The HelpString parameter is a value previously provided by the Help Viewer in response to a GetHelpStrings call.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">NotifyID</method> to pass the application a unique numeric ID associated with a Viewer. The application uses this ID to identify a specific viewer in calls to Release (IHelpManager).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">SoftShutDown</method> when it is notified that the application want to close all open Help Topics. A Viewer should respond to this call by terminating any external applications used to display Help topics, but should be prepared to restart them as needed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Help System calls <method namespace="HelpIntfs" class="ICustomHelpViewer">ShutDown</method> when it is notified that the application is shutting down. A Viewer should respond to this call by terminating any external applications used to display Help topics. After a call to <method namespace="HelpIntfs" class="ICustomHelpViewer">ShutDown</method>, a Viewer can assume that no more Help requests will arrive.</para>
</comments>
</member>
<member name="T:HelpIntfs.IExtendedHelpViewer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Help Viewer with context help support.</para>
<class namespace="HelpIntfs">IExtendedHelpViewer</class> extends ICustomHelpViewer by adding support for Topic IDs and Context IDs.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A topic ID is a short string that uniquely identifies each topic provided by a Help Viewer. A topic ID provides a simple way for an application to display a specific Help topic without searching for it.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A context ID is an integer value that uniquely identifies each Help topic. Context IDs support context-sensitive Help by providing a value that associates forms and controls with their help topics. A form or control can be associated a topic simply by setting its HelpContext property.</para>
<method namespace="HelpIntfs" class="IExtendedHelpViewer">UnderstandsTopic</method> should return true if the Viewer is able to display the topic identified by the Topic parameter. When the RTL Help System receives a Topic-based Help request, it calls <method namespace="HelpIntfs" class="IExtendedHelpViewer">UnderstandsTopic</method> for each Viewer that implements it until the method returns true. (Viewers are polled in the order they were registered.) The Help System than calls that Viewer's DisplayTopic method.</para>
<method namespace="HelpIntfs" class="IExtendedHelpViewer">UnderstandsContext</method> should return true if the Viewer is able to display the topic identified by ContextID in the file HelpFileName. When the RTL Help System receives a Context-based Help request, it calls <method namespace="HelpIntfs" class="IExtendedHelpViewer">UnderstandsContext</method> for each Viewer that implements it until the method returns true. (Viewers are polled in the order they were registered.) The Help System than calls that Viewer's DisplayHelpByContext method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Topic ID to display topic.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The RTL Help System calls <method namespace="HelpIntfs" class="IExtendedHelpViewer">DisplayTopic</method> to have the Viewer handle a topic-based Help request. Topic is the Topic ID, a short string that must be unique for all the topics maintained by a particular Viewer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Context ID to display topic.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The RTL Help System calls <method namespace="HelpIntfs" class="IExtendedHelpViewer">DisplayHelpByContext</method> to have the Viewer handle a context-based Help request. ContextID is the topic's Context ID. HelpFileName is the name of the file containing the topic. Note that some Help engines require the file name to be fully qualified.</para>
</comments>
</member>
<member name="T:HelpIntfs.ISpecialWinHelpViewer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Help Viewer that supports special Windows Help requests.</para>
<class namespace="HelpIntfs">ISpecialWinHelpViewer</class> supports Help requests that cannot be easily generalized, and should only be handled by the Microsoft Windows Help engine or a closely compatible application.</para>
<class namespace="HelpIntfs">ISpecialWinHelpViewer</class> consists of a single method, CallWinHelp, which should pass the Help request to the Help engine with as little manipulation as possible. An application needs to provide only one Viewer that implements <class namespace="HelpIntfs">ISpecialWinHelpViewer</class>. If more than one Viewer is registered that implements <class namespace="HelpIntfs">ISpecialWinHelpViewer</class>, only the first Viewer ever receives calls to CallWinHelp.</para>
</comments>
</member>
<member name="M:HelpIntfs.HelpIntfs.CallWinHelp">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pass Help request directly to engine.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The RTL Help System calls <method namespace="HelpIntfs" class="ISpecialWinHelpViewer">CallWinHelp</method> when it receives a Windows-style Help request that cannot be generalized as a Topic-based or Context-based request. <method namespace="HelpIntfs" class="ISpecialWinHelpViewer">CallWinHelp</method> should pass the request directly to the Windows winhelp() API or to a functional equivalent. </para>
<class namespace="HelpIntfs">IHelpManager</class> defines methods that a Help Viewer uses to interact with the Help System. A Viewer accesses these methods using the object that the global RegisterViewer function returns.</para>
<method namespace="HelpIntfs" class="IHelpManager">GetHandle</method> returns the main window handle of the application responsible for the current Help request.</para>
</comments>
</member>
<member name="M:HelpIntfs.HelpIntfs.GetHelpFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Get Help File name.</para>
<method namespace="HelpIntfs" class="IHelpManager">GetHelpFile</method> returns the name of the Help File associated with the current Help request.</para>
</comments>
</member>
<member name="M:HelpIntfs.HelpIntfs.Release">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Notify Help System of Help Viewer shutdown.</para>
<method namespace="HelpIntfs" class="IHelpManager">Release</method> disconnects the Help Viewer from the RTL Help System. The ViewerID parameter is the value the Help System previously passed to the Viewer by calling NotifyID.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Help Viewer should call <method namespace="HelpIntfs" class="IHelpManager">Release</method> when it is about to shut down, unless the Viewer is shutting down in response to a call to ShutDown.</para>
<class namespace="HelpIntfs">EHelpSystemException</class> is the class for errors raised by the RTL Help System.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Run-Time Library Help System raises <class namespace="HelpIntfs">EHelpSystemException</class> when an error occurs while registering or invoking a help viewer.</para>
</comments>
</member>
<member name="M:HelpIntfs.RegisterViewer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Register Help Viewer to receive requests.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="HelpIntfs">RegisterViewer</routine> to register a Help Viewer with the Help System. An application can register any number of Viewers. The order in which Help Viewers are registered is significant, because each Help request causes the RTL Help System to poll the Viewers in the order they were registered, and give the Help request to the first viewer that claims to be able to handle it. An application can override this behavior for keyword-based Help requests and for requests to display a Table of Contents by providing a Help Selector object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pass the Viewer object in the newViewer parameter.</para>
<routine namespace="HelpIntfs">RegisterViewer</routine> returns a Help Manager object in the Manager parameter; the Viewer uses this object to interact with the Help System.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The return value of <routine namespace="HelpIntfs">RegisterViewer</routine> is 1 is the Viewer was successfully registered, 0 otherwise.</para>
</comments>
</member>
<member name="M:HelpIntfs.GetHelpSystem">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns Help System object.</para>
<routine namespace="HelpIntfs">GetHelpSystem</routine> returns an object that implements IHelpSystem. An application calls IHelpSystem methods to interact with the Help System.</para>
<type namespace="Qt">TEditMask</type> is a string that consists of three fields with semicolons separating them. The first part of the mask is the mask itself. The second part is the character that determines whether the literal characters of a mask are saved as part of the data. The third part of the mask is the character used to represent unentered characters in the mask.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">These are the special characters used in the first field of the mask:</para>
<para>If a ! character appears in the mask, optional characters are represented in the text as leading blanks. If a ! character is not present, optional characters are represented in the text as trailing blanks.</para>
</td>
</tr>
<tr>
<td>
<para> ></para>
</td>
<td>
<para>If a > character appears in the mask, all characters that follow are in uppercase until the end of the mask or until a < character is encountered.</para>
</td>
</tr>
<tr>
<td>
<para> <</para>
</td>
<td>
<para>If a < character appears in the mask, all characters that follow are in lowercase until the end of the mask or until a > character is encountered.</para>
</td>
</tr>
<tr>
<td>
<para> <></para>
</td>
<td>
<para>If these two characters appear together in a mask, no case checking is done and the data is formatted with the case the user uses to enter the data.</para>
</td>
</tr>
<tr>
<td>
<para>\</para>
</td>
<td>
<para>The character that follows a \ character is a literal character. Use this character to use any of the mask special characters as a literal in the data.</para>
</td>
</tr>
<tr>
<td>
<para> L</para>
</td>
<td>
<para>The L character requires an alphabetic character only in this position. For the US, this is A-Z, a-z.</para>
</td>
</tr>
<tr>
<td>
<para> l</para>
</td>
<td>
<para>The l character permits only an alphabetic character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>A</para>
</td>
<td>
<para>The A character requires an alphanumeric character only in this position. For the US, this is A-Z, a-z, 0-9.</para>
</td>
</tr>
<tr>
<td>
<para> a</para>
</td>
<td>
<para>The a character permits an alphanumeric character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>C</para>
</td>
<td>
<para>The C character requires an arbitrary character in this position.</para>
</td>
</tr>
<tr>
<td>
<para> c</para>
</td>
<td>
<para>The c character permits an arbitrary character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para> 0</para>
</td>
<td>
<para>The 0 character requires a numeric character only in this position.</para>
</td>
</tr>
<tr>
<td>
<para> 9</para>
</td>
<td>
<para>The 9 character permits a numeric character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>#</para>
</td>
<td>
<para>The # character permits a numeric character or a plus or minus sign in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>:</para>
</td>
<td>
<para>The : character is used to separate hours, minutes, and seconds in times. If the character that separates hours, minutes, and seconds is different in the regional settings of the Control Panel utility on your computer system, that character is used instead.</para>
</td>
</tr>
<tr>
<td>
<para> /</para>
</td>
<td>
<para>The / character is used to separate months, days, and years in dates. If the character that separates months, days, and years is different in the regional settings of the Control Panel utility on your computer system, that character is used instead.</para>
</td>
</tr>
<tr>
<td>
<para> ;</para>
</td>
<td>
<para>The ; character is used to separate the three fields of the mask.</para>
</td>
</tr>
<tr>
<td>
<para> _</para>
</td>
<td>
<para>The _ character automatically inserts spaces into the text. When the user enters characters in the field, the cursor skips the _ character.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Any character that does not appear in the preceding table can appear in the first part of the mask as a literal character. Literal characters must be matched exactly in the edit control. They are inserted automatically, and the cursor skips over them during editing. The special mask characters can also appear as literal characters if preceded by a backslash character (\).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The second field of the mask is a single character that indicates whether literal characters from the mask should be included as part of the text for the edit control. For example, the mask for a telephone number with area code could be the following string:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The 0 in the second field indicates that the Text property for the edit control would consist of the 10 digits that were entered, rather than the 14 characters that make up the telephone number as it appears in the edit control.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A 0 in the second field indicates that literals should not be included, any other character indicates that they should be included. The character that indicates whether literals should be included can be changed in the Edit Mask property editor, or programmatically by changing the MaskNoSave typed constant.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The third field of the mask is the character that appears in the edit control for blanks (characters that have not been entered). By default, this is the same as the character that stands for literal spaces. The two characters appear the same in an edit window. However, when a user edits the text in a masked edit control, the cursor selects each blank character in turn, and skips over the space character.</para>
<para>When working with multibyte character sets, each special mask character represents a single byte. To specify multi-byte characters using the L, l, A, a, C, or c specifiers, the mask characters must be duplicated as well. For example, LL would represent two single-byte alphabetic characters or a one double-byte character. Only single-byte literal characters are supported.</para>
</note>
</comments>
</member>
<member name="M:MaskUtils.FormatMaskText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a string formatted using an edit mask.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="MaskUtils">FormatMaskText</routine> to apply the mask specified by the EditMask parameter to the text string specified by the Value parameter. The edit mask string consists of three fields with semicolons separating them. The first part of the mask is the mask itself. The second part is the character that determines whether the literal characters of the mask are matched to characters in the Value parameter or are inserted into the Value string. The third part of the mask is the character used to represent missing characters in the mask.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">These are the special characters used in the first field of the mask:</para>
<para>If a ! character appears in the mask, optional characters are represented in the returned string as leading blanks. If a ! character is not present, optional characters are represented in the returned string as trailing blanks.</para>
</td>
</tr>
<tr>
<td>
<para>></para>
</td>
<td>
<para>If a > character appears in the mask, all characters that follow are in uppercase until the end of the mask or until a < character is encountered.</para>
</td>
</tr>
<tr>
<td>
<para><</para>
</td>
<td>
<para>If a < character appears in the mask, all characters that follow are in lowercase until the end of the mask or until a > character is encountered.</para>
</td>
</tr>
<tr>
<td>
<para><></para>
</td>
<td>
<para>If these two characters appear together in a mask, no case checking is done and the data is formatted with the case present in the Value parameter.</para>
</td>
</tr>
<tr>
<td>
<para>\</para>
</td>
<td>
<para>The character that follows a \ character is a literal character. Use this character to use any of the mask special characters as a literal.</para>
</td>
</tr>
<tr>
<td>
<para>L</para>
</td>
<td>
<para>The L character requires an alphabetic character only in this position. For the US, this is A-Z, a-z.</para>
</td>
</tr>
<tr>
<td>
<para>l</para>
</td>
<td>
<para>The l character permits only an alphabetic character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>A</para>
</td>
<td>
<para>The A character requires an alphanumeric character only in this position. For the US, this is A-Z, a-z, 0-9.</para>
</td>
</tr>
<tr>
<td>
<para>a</para>
</td>
<td>
<para>The a character permits an alphanumeric character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>C</para>
</td>
<td>
<para>The C character requires an arbitrary character in this position.</para>
</td>
</tr>
<tr>
<td>
<para>c</para>
</td>
<td>
<para>The c character permits an arbitrary character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>0</para>
</td>
<td>
<para>The 0 character requires a numeric character only in this position.</para>
</td>
</tr>
<tr>
<td>
<para>9</para>
</td>
<td>
<para>The 9 character permits a numeric character in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>#</para>
</td>
<td>
<para>The # character permits a numeric character or a plus or minus sign in this position, but doesn't require it.</para>
</td>
</tr>
<tr>
<td>
<para>:</para>
</td>
<td>
<para>The : character is used to separate hours, minutes, and seconds in times. If the character that separates hours, minutes, and seconds is different in the regional settings of the Control Panel, that character is substituted in the returned string.</para>
</td>
</tr>
<tr>
<td>
<para>/</para>
</td>
<td>
<para>The / character is used to separate months, days, and years in dates. If the character that separates months, days, and years is different in the regional settings of the Control Panel, that character is substituted in the returned string.</para>
</td>
</tr>
<tr>
<td>
<para>;</para>
</td>
<td>
<para>The ; character is used to separate the three fields of the mask.</para>
</td>
</tr>
<tr>
<td>
<para>_</para>
</td>
<td>
<para>The _ character automatically inserts spaces into the returned string.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Any character that does not appear in the preceding table can appear in the first part of the mask as a literal character. Literal characters are inserted automatically if the second field of the mask is 0, or matched to characters in the Value parameter if the second field is any other value. The special mask characters can also appear as literal characters if preceded by a backslash character (\).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The second field of the mask is a single character that indicates whether literal characters from the mask are included in the Value parameter. For example, the mask for a telephone number with area code could be the following string:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The 0 in the second field indicates that the Value parameter should consist of the 10 digits of the phone number, rather than the 14 characters that make up the final formatted string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A 0 in the second field indicates that literals are inserted into the Value string, any other character indicates that they should be included. The character to indicate whether literals should be included can be changed by changing the MaskNoSave constant that is declared in the MaskUtils unit.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The third field of the mask is the character that appears in the returned string for blanks (characters that do not appear in Value). By default, this is the same as the character that stands for literal spaces. The two characters appear the same in the returned string.</para>
<para>When working with multibyte character sets, each special mask character represents a single byte. To specify double-byte characters using the L, l, A, a, C, or c specifiers, the mask characters must be doubled as well. For example, LL would represent two single-byte alphabetic characters or a one double-byte character. Only single-byte literal characters are supported.</para>
<type namespace="Qt">TSeekOrigin</type> indicates where to start a seek operation.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <type namespace="Qt">TSeekOrigin</type> type indicates where to start a seek origin and the direction in which to seek. The following table lists the possible values:</para>
<para>Seek from the beginning of the resource. The seek operation moves to a specified position (offset), which must be greater than or equal to zero.</para>
</td>
</tr>
<tr>
<td>
<para>soFromCurrent</para>
</td>
<td>
<para>Seek from the current position in the resource. The seek operation moves to an offset from the current position (position + offset). The offset is positive to move forward, negative to move backward.</para>
</td>
</tr>
<tr>
<td>
<para>soFromEnd</para>
</td>
<td>
<para>Seek from the end of the resource. The seek operation moves to an offset from the end of the resource, where the offset is expressed as a negative value because it is moving toward the beginning of the resource.</para>
<type namespace="Qt">TLeftRight</type> is a subset of the TAlignment type that allows left or right justification, but no center justification. The following table lists the possible values.</para>
<type namespace="OleAuto">TBiDiMode</type> determines the reading order of the text, placement of the vertical scrollbar, and any alignment modifications. It is used to tailor the user interface for locales where text is bi-directional.</condition>
<type namespace="Qt">TShiftState</type> indicates the state of the Alt, Ctrl, and Shift keys and the mouse buttons.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <type namespace="Qt">TShiftState</type> type is used by key-event and mouse-event handlers to determine the state of the Alt, Ctrl, and Shift keys and the state of the mouse buttons when the event occurs. It is a set of flags that indicate the following:</para>
<para>Help topics are identified by a string. The HelpKeyword property is used to identify help topics. This mechanism is available for all help systems.</para>
</td>
</tr>
<tr>
<td>
<para>htContext</para>
</td>
<td>
<para>Help topics are identified by a context ID. The HelpContext property is used to identify help topics. This mechanism is not available for all help systems, but is typically faster for those systems that support it.</para>
<class namespace="Classes">EStreamError</class> is the ancestor from which all streaming exception classes descend. <class namespace="Classes">EStreamError</class> is itself raised when resources cannot be allocated for a memory stream.</para>
<class namespace="Classes">EFileStreamError</class> is raised when an error occurs while streaming data. Some, but not all, data streaming errors raise descendants of <class namespace="Classes">EFileStreamError</class>, as follows.</para>
<class namespace="Classes">EFCreateError</class> is raised when an application unsuccessfully attempts to create a file. This can occur, for example, if a user specifies an invalid file name, or specifies the name of an existing file that cannot be overwritten because the user lacks appropriate access permission.</para>
<class namespace="classes">EFOpenError</class> is raised when an application cannot open a specified file. This can occur, for example, because the file doesn't exist or is not in the directory where the application is searching for it.</para>
<class namespace="Classes">EFilerError</class> is raised when an error occurs while streaming a component. Some, but not all, component streaming errors raise descendants of <class namespace="Classes">EFilerError</class>, as follows.</para>
<class namespace="Classes">EReadError</class> is raised when an application attempts to read data from a stream but cannot read the specified number of bytes.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An <class namespace="Classes">EReadError</class> exception may also be raised if a property cant be read while creating a form. This can occur because a component reads the form resource incorrectly, or because the resource is corrupt.</para>
<class namespace="Classes">EWriteError</class> is raised when:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The WriteBuffer method of a stream object is unable to write the specified number of bytes.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The IDE is unable to write one of a component's properties to a stream. This can occur when you try to save a form at design time.</para>
<class namespace="Classes">EClassNotFound</class> is the exception class for the failure to find a specified component when reading from a stream.</para>
<class namespace="Classes">EClassNotFound</class> is raised if a class name that has not been linked into the current application is encountered when reading a component from a stream. This can happen when a component exists on a form, but has been removed from the type declaration.</para>
<class namespace="Classes">EInvalidImage</class> is raised when an application cannot read a resource. This occurs most often because the specified file is not a resource file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">This error can occur if the TStream object's read and write methods are used inconsistently. Always use ReadComponentRes to read components written with WriteComponentRes, and ReadComponent to read components written with WriteComponent. Failure to use the corresponding read and write methods can result in <class namespace="Classes">EInvalidImage</class> exceptions.</para>
<class namespace="Classes">EResNotFound</class> is raised when a specified resource (such as a form or bitmap) can't be found in a form file or a resource file, or when the resource is not linked into the application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If you receive this exception on startup of an application, or when you create a form, check the form's unit file for the compiler directive that links in the form file.</para>
<para>In C++, this directive #pragma resource "*.xfm" (for CLX forms) or #pragma resource "*.dfm" (for VCL forms)</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If this directive is missing or commented out, the form file is not included in the executable and an <class namespace="Classes">EResNotFound</class> exception is generated.</para>
<class namespace="Classes">EListError</class> is raised when an error is made in a list, TStrings, or TStringList object. This exception commonly occurs when an application refers to an item that is out of the list's range.</para>
<class namespace="Classes">EListError</class> also occurs if an application tries to add a duplicate string to a TStringList object when the value of the Duplicates property is dupError.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An <class namespace="Classes">EListError</class> exception is raised when an application attempts to insert a string into a sorted string list, since the insertion of a string at a specified position may put the list out of order.</para>
<class namespace="classes">EBitsError</class> is raised when an application attempts to access a boolean array (an instance of the TBits class) using an index value that is too large or too small. This can occur when the value of the Index parameter of the Bits property is</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Less than zero.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Equal to or greater than the Size property.</para>
<class namespace="Classes">EStringListError</class> is raised when an application attempts to access a list box (for example, to add an item) using an invalid index.</para>
<class namespace="Classes">EComponentError</class> is raised when:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An attempt to register a component fails.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An application cannot rename a component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">(Windows-only) A request is made to retrieve the COM interface of a component that doesn't support COM.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To register a component, write a procedure called "Register", declared in the interface section (Delphi) or namespace (C++) of the component's unit file. Note that unlike most Delphi procedure names, the name of the Register procedure is case-sensitive. Register must call RegisterComponents for each component you want to register.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Failure to rename a component occurs when an application tries to rename the component at runtime, and the new name is the same as the name of another component with the same Owner or is not a valid identifier.</para>
<class namespace="Classes">EParserError</class> is raised when an error occurs during text-to-binary conversion, usually due to a syntax error in the source text.</para>
<class namespace="Classes">EOutOfResources</class> is raised when an application attempts to create a Windows or widget handle and there are no more handles to allocate.</para>
<class namespace="Classes">EInvalidOperation</class> is raised when an application attempts an operation that requires a window or widget handle on a component that does not have a parent (The Parent property is Nil in Delphi or NULL in C++). This exception can also occur if a drag-and-drop operation is attempted from a form (for example, when calling the BeginDrag method of a form).</para>
<para>Removes all elements from the destination list that do not appear in the source list. The destination list ends up containing the intersection of the two lists.</para>
</td>
</tr>
<tr>
<td>
<para>laCopy</para>
</td>
<td>
<para>Overwrites the destination list with the source list.</para>
</td>
</tr>
<tr>
<td>
<para>laDestUnique</para>
</td>
<td>
<para>Removes all elements from the destination list that appear in the source list. The destination list ends up containing the elements unique to the original destination list. (same as laOr followed by laXor)</para>
</td>
</tr>
<tr>
<td>
<para>laOr</para>
</td>
<td>
<para>Adds any elements from the source list that do not already appear in the destination list. The destination list ends up containing the union of the two lists.</para>
</td>
</tr>
<tr>
<td>
<para>laSrcUnique</para>
</td>
<td>
<para>Replaces the destination list with those elements of the source list that do not appear in the destination list. (same as laAnd followed by laXor)</para>
</td>
</tr>
<tr>
<td>
<para>laXor</para>
</td>
<td>
<para>Removes all elements from the destination list that appear in the source list and adds any elements from the source list that do not appear in the original destination list. The destination list ends up with the elements unique to both the source and destination lists.</para>
<class namespace="Classes">TList</class>, which stores an array of pointers, is often used to maintain lists of objects. <class namespace="Classes">TList</class> introduces properties and methods to </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add or delete the objects in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Rearrange the objects in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Locate and access objects in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sort the objects in the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.Add">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Inserts a new item at the end of the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Add</method> to insert a new object at the end of the Items array. <method namespace="Classes" class="TList">Add</method> returns the index of the new item, where the first item in the list has an index of 0.</para>
<method namespace="Classes" class="TList">Add</method> increments Count and, if necessary, allocates memory by increasing the value of Capacity.</para>
<method namespace="Classes" class="TList">Add</method> always inserts the Item pointer at the end of the Items array, even if the Items array contains nil (Delphi) or NULL (C++) pointers.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Expand">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Increases the Capacity of the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Expand</method> to create more space for adding new items to the list. <method namespace="Classes" class="TList">Expand</method> does nothing if the list is not already filled to Capacity.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Count = Capacity, <method namespace="Classes" class="TList">Expand</method> increases the Capacity of the list as follows. If the value of Capacity is greater than 8, <method namespace="Classes" class="TList">Expand</method> increases the Capacity of the list by 16. If the value of Capacity is greater than 4, but less than 9, the Capacity of the list increases by 8. If the value of Capacity is less than 4, the Capacity of the list grows by 4.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The returned value is the expanded list object.</para>
</comments>
</member>
<member name="M:Classes.Classes.Extract">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Removes a specified item from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Extract</method> to remove an item from the list. After the item is removed, all the objects that follow it are moved up in index position and Count is decremented.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To remove the reference to an item without deleting the entry from the Items array and changing the Count, set the Items property for Index to nil (Delphi) or NULL (C++).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">First</method> to get the first pointer in the Items array.</para>
</comments>
</member>
<member name="M:Classes.Classes.IndexOf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of the first entry in the Items array with a specified value.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">IndexOf</method> to get the index for a pointer in the Items array. Specify the pointer as the Item parameter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The first item in the array has index 0, the second item has index 1, and so on. If an item is not in the list, <method namespace="Classes" class="TList">IndexOf</method> returns -1. If a pointer appears more than once in the array, <method namespace="Classes" class="TList">IndexOf</method> returns the index of the first appearance.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Last</method> to retrieve the last pointer in the Items array.</para>
</comments>
</member>
<member name="M:Classes.Classes.Remove">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Deletes the first reference to the Item parameter from the Items array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Remove</method> to remove a specific item from the Items array when its index is unknown. The value returned is the index of the item in the Items array before it was removed. After an item is removed, all the items that follow it are moved up in index position and the Count is reduced by one.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the Items array contains more than one copy of the pointer, only the first copy is deleted.</para>
<condition status="hold">As implemented in <method namespace="Classes" class="TList">TList</method>, <method namespace="Classes" class="TList">Notify</method> does nothing. Descendant classes can override <method namespace="Classes" class="TList">Notify</method> in order to implement an appropriate response to the change notification.</condition>
</para>
</comments>
</member>
<member name="M:Classes.Classes.Clear">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Deletes all items from the list. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Clear</method> to empty the Items array and set the Count to 0. <method namespace="Classes" class="TList">Clear</method> also frees the memory used to store the Items array and sets the Capacity to 0.</para>
</comments>
</member>
<member name="M:Classes.Classes.Delete">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Removes the item at the position given by the Index parameter. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Delete</method> to remove the item at a specific position from the list. The index is zero-based, so the first item has an Index value of 0, the second item has an Index value of 1, and so on. Calling <method namespace="Classes" class="TList">Delete</method> moves up all items in the Items array that follow the deleted item, and reduces the Count.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To remove the reference to an item without deleting the entry from the Items array and changing the Count, set the Items property for Index to nil (Delphi) or NULL (C++).</para>
<method namespace="Classes" class="TList">Delete</method> does not free any memory associated with the item. To free the memory that was used to store a deleted item, set the Capacity property.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Error">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Raises an EList<method namespace="Classes" class="TList">Error</method> exception.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Error</method> to raise an exception when an error occurs working with a <method namespace="Classes" class="TList">TList</method> object. <method namespace="Classes" class="TList">Error</method> assembles an error message from the format string (or resource string) passed as the Msg parameter and the data value passed as the Data parameter, and then raises an EList<method namespace="Classes" class="TList">Error</method> exception.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Error</method> rather than adding a line such as</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">to reduce the code size of an application.</para>
</comments>
</member>
<member name="M:Classes.Classes.Exchange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Swaps the position of two items in the Items array. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Exchange</method> to swap the positions of the items at positions Index1 and Index2 of the Items array. The indexes are zero-based, so the first item in the list has an index value of 0, the second item has an index value of 1, and so on.</para>
</comments>
</member>
<member name="M:Classes.Classes.Insert">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds an object to the Items array at the position specified by Index. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Insert</method> to add Item to the middle of the Items array. The Index parameter is a zero-based index, so the first position in the array has an index of 0. <method namespace="Classes" class="TList">Insert</method> adds the item at the indicated position, shifting the item that previously occupied that position, and all subsequent items, up. <method namespace="Classes" class="TList">Insert</method> increments Count and, if necessary, allocates memory by increasing the value of Capacity.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To replace a nil (Delphi) or NULL (C++) pointer in the array with a new item, without growing the Items array, set the Items property.</para>
</comments>
</member>
<member name="M:Classes.Classes.Move">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes the position of an item in the Items array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Move</method> to move the item at the position CurIndex so that it occupies the position NewIndex. CurIndex and NewIndex are zero-based indexes into the Items array.</para>
</comments>
</member>
<member name="M:Classes.Classes.Pack">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Deletes all nil (Delphi) or NULL (C++) items from the Items array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Pack</method> to move all non-nil (Delphi) or non-NULL (C++) items to the front of the Items array and reduce the Count property to the number of items actually used. <method namespace="Classes" class="TList">Pack</method> does not free up the memory used to store the nil (Delphi) or NULL (C++) pointers. To free up the memory for the unused entries removed by <method namespace="Classes" class="TList">Pack</method>, set the Capacity property to the new value of Count.</para>
</comments>
</member>
<member name="M:Classes.Classes.Sort">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Performs a Quick<method namespace="Classes" class="TList">Sort</method> on the list based on the comparison function Compare. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Sort</method> to sort the items in the Items array. Compare is a comparison function that indicates how the items are to be ordered. </para>
</comments>
</member>
<member name="M:Classes.Classes.Assign">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies elements of one list to another. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TList">Assign</method> to assign the elements of another list to this one. <method namespace="Classes" class="TList">Assign</method> combines the source list with this one using the logical operator specified by the AOperator parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the ListB parameter is specified (Delphi) or not NULL (C++), then <method namespace="Classes" class="TList">Assign</method> first replaces all the elements of this list with those in ListA, and then merges ListB into this list using the operator specified by AOperator.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the ListB parameter is not specified (Delphi) or NULL (C++), then <method namespace="Classes" class="TList">Assign</method> merges ListA into this list using the operator specified by AOperator.</para>
<method namespace="Classes" class="TList">Destroy</method>s an instance of <method namespace="Classes" class="TList">TList</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TList">Destroy</method> directly. Instead, call Free. Free verifies that the <method namespace="Classes" class="TList">TList</method> reference is not nil, and only then calls <method namespace="Classes" class="TList">Destroy</method>.</para>
<method namespace="Classes" class="TList">Destroy</method> does not free the memory pointed to by the elements of the list.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.Capacity">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the allocated size of the array of pointers maintained by the <property namespace="Classes" class="TList">TList</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TList">Capacity</property> to the number of pointers the list will need to contain. When setting the <property namespace="Classes" class="TList">Capacity</property> property, an EOutOfMemory exception occurs if there is not enough memory to expand the list to its new size.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Classes" class="TList">Capacity</property> to learn number of objects the list can hold without reallocating memory. Do not confuse <property namespace="Classes" class="TList">Capacity</property> with the Count property, which is the number of entries in the list that are in use. The value of <property namespace="Classes" class="TList">Capacity</property> is always greater than or equal to the value of Count. When <property namespace="Classes" class="TList">Capacity</property> is greater than Count, the unused memory can be reclaimed by setting <property namespace="Classes" class="TList">Capacity</property> to Count.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When an object is added to a list that is already filled to capacity, the <property namespace="Classes" class="TList">Capacity</property> property is automatically increased. Setting <property namespace="Classes" class="TList">Capacity</property> before adding objects can reduce the number of memory reallocations and thereby improve performance. For example,</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The assignment to <property namespace="Classes" class="TList">Capacity</property> before the for loop ensures that each of the following Add operations doesn't cause the list to be reallocated. Avoiding reallocations on the calls to Add improves performance and ensures that the Add operations never raise an exception.</para>
</comments>
</member>
<member name="P:Classes.Classes.Count">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of entries in the list that are in use.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Classes" class="TList">Count</property> to determine the number of entries in the Items array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Increasing the size of <property namespace="Classes" class="TList">Count</property> will add the necessary number of nil (Delphi) or NULL (C++) pointers to the end of the Items array. Decreasing the size of <property namespace="Classes" class="TList">Count</property> will remove the necessary number of entries from the end of the Items array.</para>
<property namespace="Classes" class="TList">Count</property> is not always the same as the number of objects referenced in the list. Some of the entries in the Items array may contain nil (Delphi) or NULL (C++) pointers. To remove the nil (Delphi) or NULL (C++) pointers and set <property namespace="Classes" class="TList">Count</property> to the number of entries that contain references to objects, call the Pack method.</para>
</comments>
</member>
<member name="P:Classes.Classes.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the object references.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TList">Items</property> to obtain a pointer to a specific object in the array. The Index parameter indicates the index of the object, where 0 is the index of the first object, 1 is the index of the second object, and so on. Set <property namespace="Classes" class="TList">Items</property> to change the reference at a specific location.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TList">Items</property> with the Count property to iterate through all of the objects in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Not all of the entries in the <property namespace="Classes" class="TList">Items</property> array need to contain references to objects. Some of the entries may be nil (Delphi) or NULL (C++) pointers. To remove the nil (Delphi) or NULL (C++) pointers and reduce the size of the <property namespace="Classes" class="TList">Items</property> array to the number of objects, call the Pack method.</para>
<property namespace="Classes" class="TList">Items</property> is the default property for <property namespace="Classes" class="TList">TList</property>. This means you can omit the property name. Thus, instead of </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the array of pointers that make up the Items array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TList">List</property> to gain direct access to the Items array.</para>
<class namespace="Classes">TThreadList</class> represents a thread-safe list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A <class namespace="Classes">TThreadList</class> object is a thread-safe list. Each <class namespace="Classes">TThreadList</class> maintains a private TList (a list of pointers to objects). You can add or remove items in a <class namespace="Classes">TThreadList</class> from multiple threads without explicit locks.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To access the actual TList object managed by the thread list, first lock the list by calling the LockList method. Unlock the list by calling the Unlock method when done.</para>
<para>By default, <class namespace="Classes">TThreadList</class> ignores attempts to add duplicate entries to the list. If the list is large, this default is computationally expensive. For better performance, you may want to change the Duplicates property to dupAccept where possible. </para>
</tip>
</comments>
</member>
<member name="M:Classes.Classes.LockList">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Locks the thread-safe list and returns a TList object.</para>
<para>In Windows, <method namespace="Classes" class="TThreadList">LockList</method> calls the Windows EnterCriticalSection function to lock the thread-safe list. It then returns the TList object that contains the list.</para>
<para>In Linux, <method namespace="Classes" class="TThreadList">LockList</method> returns the TList object that contains the list, after locking out all other threads.</para>
<method namespace="Classes" class="TThreadList">Create</method>s and initializes a <method namespace="Classes" class="TThreadList">TThreadList</method> instance.</para>
<method namespace="Classes" class="TThreadList">Add</method>s an item to the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TThreadList">Add</method> to insert a new object at the end of the thread-safe list.</para>
</comments>
</member>
<member name="M:Classes.Classes.Clear">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Deletes all items from the list.</para>
<method namespace="Classes" class="TThreadList">Clear</method> locks the list, calls the <method namespace="Classes" class="TThreadList">Clear</method> method in TList, then unlocks the list.</para>
<method namespace="Classes" class="TThreadList">Remove</method>s an item from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TThreadList">Remove</method> to remove a specific item from the list without having to determine its index. <method namespace="Classes" class="TThreadList">Remove</method> locks the list, calls the <method namespace="Classes" class="TThreadList">Remove</method> method in TList, then unlocks the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.UnlockList">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unlocks the thread-safe list.</para>
<method namespace="Classes" class="TThreadList">Destroy</method>s the <method namespace="Classes" class="TThreadList">TThreadList</method> and frees its memory.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TThreadList">Destroy</method> directly in an application. Instead, call Free. Free verifies that the thread list is not nil, and only then calls <method namespace="Classes" class="TThreadList">Destroy</method>.</para>
</comments>
</member>
<member name="P:Classes.Classes.Duplicates">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the thread list allows duplicate entries.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TThreadList">Duplicates</property> to specify what should happen when an attempt is made to add a duplicate item to the list. The value of <property namespace="Classes" class="TThreadList">Duplicates</property> should be one of the following.</para>
<para>Ignore attempts to add duplicate items to the list.</para>
</td>
</tr>
<tr>
<td>
<para>dupError</para>
</td>
<td>
<para>raise an EListError exception when an attempt is made to add duplicate items to the list.</para>
</td>
</tr>
<tr>
<td>
<para>dupAccept</para>
</td>
<td>
<para>Permit duplicate items in the list.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TThreadList">Duplicates</property> before adding any items to the list. Setting <property namespace="Classes" class="TThreadList">Duplicates</property> to dupIgnore or dupError does nothing about duplicates that are already in the list.</para>
<class namespace="Classes">IInterfaceList</class> provides access to a list of interfaces.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">IInterfaceList</class> to manage a list of interfaces. Typically, <class namespace="Classes">IInterfaceList</class> is implemented by the TInterfaceList class.</para>
<para>C++ method declarations that use <class namespace="Classes">IInterfaceList</class> use the _di_<class namespace="Classes">IInterfaceList</class> type instead. This type is a DelphiInterface wrapper around the <class namespace="Classes">IInterfaceList</class> interface:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the first interface in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">First</method> to obtain the first interface in the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.IndexOf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of an interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">IndexOf</method> to obtain the index of an interface.</para>
<method namespace="Classes" class="IInterfaceList">Add</method>s an interface to the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Add</method> to add an interface to the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.Last">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the last interface in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Last</method> to obtain the last interface in the list.</para>
<method namespace="Classes" class="IInterfaceList">Remove</method>s an interface from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Remove</method> to remove an interface from the list.</para>
<method namespace="Classes" class="IInterfaceList">Remove</method> returns the index of the removed interface, or ΓÇô1 if the interface was not found.</para>
<method namespace="Classes" class="IInterfaceList">Clear</method>s the interface list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Clear</method> to remove all interfaces from the list.</para>
<method namespace="Classes" class="IInterfaceList">Delete</method>s an interface from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Delete</method> to delete an interface from the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.Exchange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Swaps the position of two interfaces in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Exchange</method> to move the interface at position Index1 so that it appears at position Index2 and move the interface at position Index2 so that it appears at position Index1. Index1 and Index2 identify two positions (zero offset) in the Items property array.</para>
<method namespace="Classes" class="IInterfaceList">Insert</method>s an interface into the list at a specified position.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Insert</method> to insert an interface into the list. Item is the interface to insert, and Index indicates the position (zero-offset) where the interface should be added.</para>
</comments>
</member>
<member name="M:Classes.Classes.Lock">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Prevents other threads from accessing the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Lock</method> to lock the list, preventing other threads from accessing the list.</para>
<method namespace="Classes" class="IInterfaceList">Unlock</method>s the list, allowing other threads to access it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="IInterfaceList">Unlock</method> to unlock the list so that other threads can have access to the interfaces it contains.</para>
</comments>
</member>
<member name="P:Classes.Classes.Capacity">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the list capacity.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="IInterfaceList">Capacity</property> to determine the list capacity. Before adding many interfaces to the list, you can improve performance by setting <property namespace="Classes" class="IInterfaceList">Capacity</property> to the final number of interfaces. This prevents the interface list from having to reallocate the list every time an interface is added.</para>
</comments>
</member>
<member name="P:Classes.Classes.Count">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the number of interfaces in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="IInterfaceList">Count</property> to determine the number of interfaces in the list.</para>
</comments>
</member>
<member name="P:Classes.Classes.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides direct access to an interface in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="IInterfaceList">Items</property> to directly access an interface in the list. Index identifies each interface by its position in the list, where 0 is the first item, 1 is the second item, and so on.</para>
<para>In Delphi, <property namespace="Classes" class="IInterfaceList">Items</property> is the default property of <property namespace="Classes" class="IInterfaceList">IInterfaceList</property>. This means that the name of the property can be omitted in code, and the subscript applied directly to the interface.</para>
<class namespace="Classes">TInterfaceList</class> represents a list of interfaces.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">TInterfaceList</class> to manage a list of interfaces.</para>
</comments>
</member>
<member name="M:Classes.Classes.Expand">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Increases the capacity of the interface list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Capacity is greater than 64, then Capacity is increased by Capacity / 4. If Capacity is between eight and 64, Capacity is increased by 16. If Capacity is less than eight, Capacity is increased by four.</para>
</comments>
</member>
<member name="M:Classes.Classes.First">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the first interface in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">First</method> to obtain the first interface in the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.IndexOf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of an interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">IndexOf</method> to obtain the index of an interface.</para>
<method namespace="Classes" class="TInterfaceList">Add</method>s an interface to the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Add</method> to add an interface to the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.Last">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the last interface in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Last</method> to obtain the last interface in the list.</para>
<method namespace="Classes" class="TInterfaceList">Remove</method>s an interface from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Remove</method> to remove an interface from the list.</para>
<method namespace="Classes" class="TInterfaceList">Remove</method> returns the index of the removed interface, or ΓÇô1 if the interface was not found.</para>
<method namespace="Classes" class="TInterfaceList">Create</method>s an interface list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Create</method> to create an interface list.</para>
<method namespace="Classes" class="TInterfaceList">Clear</method>s the interface list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Clear</method> to remove all interfaces from the list.</para>
<method namespace="Classes" class="TInterfaceList">Delete</method>s an interface from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Delete</method> to delete an interface from the list.</para>
</comments>
</member>
<member name="M:Classes.Classes.Exchange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Swaps the position of two interfaces in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Exchange</method> to move the interface at position Index1 so that it appears at position Index2 and move the interface at position Index2 so that it appears at position Index1. Index1 and Index2 identify two positions (zero offset) in the Items property array.</para>
<method namespace="Classes" class="TInterfaceList">Insert</method>s an interface into the list at a specified position.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Insert</method> to insert an interface into the list. Item is the interface to insert, and Index indicates the position (zero-offset) where the interface should be added.</para>
</comments>
</member>
<member name="M:Classes.Classes.Lock">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Prevents other threads from accessing the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Lock</method> to lock the list, preventing other threads from accessing the list.</para>
<method namespace="Classes" class="TInterfaceList">Unlock</method>s the list, allowing other threads to access it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TInterfaceList">Unlock</method> to unlock the list so that other threads can have access to the interfaces it contains.</para>
<method namespace="Classes" class="TInterfaceList">Destroy</method>s the interface list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TInterfaceList">Destroy</method> directly in an application. Instead, call the Free method.</para>
</comments>
</member>
<member name="P:Classes.Classes.Capacity">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the list capacity.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TInterfaceList">Capacity</property> to determine the list capacity. Before adding many interfaces to the list, you can improve performance by setting <property namespace="Classes" class="TInterfaceList">Capacity</property> to the final number of interfaces. This prevents the interface list from having to reallocate the list every time an interface is added.</para>
</comments>
</member>
<member name="P:Classes.Classes.Count">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the number of interfaces in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TInterfaceList">Count</property> to determine the number of interfaces in the list.</para>
</comments>
</member>
<member name="P:Classes.Classes.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides direct access to an interface in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TInterfaceList">Items</property> to directly access an interface in the list. Index identifies each interface by its position in the list.</para>
<para>In Delphi, <property namespace="Classes" class="TInterfaceList">Items</property> is the default property of <property namespace="Classes" class="TInterfaceList">TInterfaceList</property>. That means you can omit the property name. Thus, instead of writing</para>
<class namespace="Classes">TPersistent</class> encapsulates the behavior common to all objects that can be assigned to other objects, and that can read and write their properties to and from a form file (.xfm or .dfm file). For this purpose <class namespace="Classes">TPersistent</class> introduces methods that can be overridden to:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Define the procedure for loading and storing unpublished data to a stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provide the means to assign values to properties.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provide the means to assign the contents of one object to another.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Classes">TPersistent</class>. Use <class namespace="Classes">TPersistent</class> as a base class when declaring objects that are not components, but that need to be saved to a stream or have their properties assigned to other objects.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetOwner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the owner of an object.</para>
<method namespace="Classes" class="TPersistent">GetOwner</method> is used by the GetNamePath method to find the owner of a persistent object. GetNamePath and <method namespace="Classes" class="TPersistent">GetOwner</method> are introduced in <method namespace="Classes" class="TPersistent">TPersistent</method> so descendants such as collections can appear in the Object Inspector. As implemented in <method namespace="Classes" class="TPersistent">TPersistent</method>, <method namespace="Classes" class="TPersistent">GetOwner</method> returns nil (Delphi) or NULL (C++). </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For TCollection, <method namespace="Classes" class="TPersistent">GetOwner</method> returns the owner of the collection. For collection items, it returns the collection object into which the collection item has been inserted. For TComponent it is the value of the Owner property.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetNamePath">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the name of the object as it appears in the Object Inspector.</para>
<method namespace="Classes" class="TPersistent">GetNamePath</method> is for internal use only. It determines the text that the Object Inspector displays for the name of the object being edited. <method namespace="Classes" class="TPersistent">GetNamePath</method> is introduced in <method namespace="Classes" class="TPersistent">TPersistent</method> so descendants such as collections can appear in the Object Inspector. Do not call <method namespace="Classes" class="TPersistent">GetNamePath</method> directly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For components, <method namespace="Classes" class="TPersistent">GetNamePath</method> returns the component name. For TCollectionItem objects it returns the name of the hosting component, the name of the property, and the index into the collection surrounded by brackets.</para>
</comments>
</member>
<member name="M:Classes.Classes.AssignTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the properties of an object to a destination object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Override the <method namespace="Classes" class="TPersistent">AssignTo</method> method to extend the functionality of the Assign method of destination objects so that they handle newly created object classes. When defining a new object class, override the Assign method for every existing object class that should be able to copy its properties to the new class. Override the <method namespace="Classes" class="TPersistent">AssignTo</method> method for every existing class to which the new class can copy.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Assign method of <method namespace="Classes" class="TPersistent">TPersistent</method> calls <method namespace="Classes" class="TPersistent">AssignTo</method> if the descendant object does not succeed in copying the properties of a source object. The <method namespace="Classes" class="TPersistent">AssignTo</method> method defined by <method namespace="Classes" class="TPersistent">TPersistent</method> raises an EConvertError exception. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, given the following code in which A and B are instance variables:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">if A knows how to handle B, then it does so and returns. If A doesn't know how to handle B's type, execution will trickle to the <method namespace="Classes" class="TPersistent">TPersistent</method> version of Assign, which calls:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If B knows how to copy to A, the assignment succeeds. Otherwise, <method namespace="Classes" class="TPersistent">TPersistent</method> raises an exception.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides an interface for a method that reads and writes otherwise unpublished data.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="Classes" class="TPersistent">TPersistent</method> override <method namespace="Classes" class="TPersistent">DefineProperties</method> to designate a method for storing the object's unpublished data to a stream such as a form file. By default, writing an object to a stream writes the values of all its published properties, and reading the object in reads those values and assigns them to the properties. Objects can also specify methods that read and write data other than published properties by overriding the <method namespace="Classes" class="TPersistent">DefineProperties</method> method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When overriding <method namespace="Classes" class="TPersistent">DefineProperties</method>, consider including some or all of the following:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A call to the inherited method</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Calls to the filer object's DefineProperty method</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Calls to the filer object's DefineBinaryProperty method</para>
<method namespace="Classes" class="TPersistent">DefineProperties</method> is virtual, so descendant classes can override it as necessary but are not required to do so.</para>
</comments>
</member>
<member name="M:Classes.Classes.Assign">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the contents of another, similar object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TPersistent">Assign</method> to copy the properties or other attributes of one object from another. The standard form of a call to <method namespace="Classes" class="TPersistent">Assign</method> is</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">which tells the Destination object to copy the contents of the Source object to itself.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most objects override <method namespace="Classes" class="TPersistent">Assign</method> to handle the assignment of properties from similar objects. When overriding <method namespace="Classes" class="TPersistent">Assign</method>, call the inherited method if the destination object can't handle the assignment of properties from the class of the Source parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If no overridden <method namespace="Classes" class="TPersistent">Assign</method> method can handle the assignment of properties from Source, the method implemented in <method namespace="Classes" class="TPersistent">TPersistent</method> calls the source object's <method namespace="Classes" class="TPersistent">Assign</method>To method. This allows the source object to handle the assignment. If the Source object is nil (Delphi) or NULL (C++), <method namespace="Classes" class="TPersistent">Assign</method> raises an EConvertError exception.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In general, the statement </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The assignment operator makes Destination reference the same object as Source, whereas the <method namespace="Classes" class="TPersistent">Assign</method> method copies the contents of the object referenced by Source into the object referenced by Destination.</para>
<para>The types of some properties are also objects. If these properties have write methods that use <method namespace="Classes" class="TPersistent">Assign</method> to set the value of the property, then in these cases the assignment operator does the same thing as the <method namespace="Classes" class="TPersistent">Assign</method> method.</para>
<method namespace="Classes" class="TPersistent">Destroy</method>s the <method namespace="Classes" class="TPersistent">TPersistent</method> instance and frees its memory.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TPersistent">Destroy</method> directly. Call Free instead. Free checks that the object reference is not nil before calling <method namespace="Classes" class="TPersistent">Destroy</method>.</para>
<class namespace="Classes">TInterfacedPersistent</class>, like all persistent objects, supports the ability to read and write its properties to and from a stream. In addition, it supplies a default implementation of the IInterface methods (_AddRef, _Release, and QueryInterface). This default implementation simply passes these calls on to the interface of the persistent object's Owner, if any.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Classes">TInterfacedPersistent</class>. Use <class namespace="Classes">TInterfacedPersistent</class> as a base class when declaring objects that are not components, but that need to be saved to a stream or have their properties assigned to other objects, and that support interfaces.</para>
</comments>
</member>
<member name="M:Classes.Classes._AddRef">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Increments the reference count for the interfaced object's interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">_<method namespace="Classes" class="TInterfacedPersistent">AddRef</method> implements the IInterface method, _<method namespace="Classes" class="TInterfacedPersistent">AddRef</method>, which increments the reference count of an interface and returns the current reference count.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> If the interfaced persistent object has an Owner and that owner supports an interface, then _<method namespace="Classes" class="TInterfacedPersistent">AddRef</method> simply calls the _<method namespace="Classes" class="TInterfacedPersistent">AddRef</method> method of the Owner. Otherwise, it simply returns ΓÇô1.</para>
</comments>
</member>
<member name="M:Classes.Classes._Release">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Decrements the reference count for the interfaced object's interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">__<method namespace="Classes" class="TInterfacedPersistent">Release</method> implements the IInterface method, __<method namespace="Classes" class="TInterfacedPersistent">Release</method>, which decrements the reference count of an interface and returns the current reference count. For some interfaces, when this causes the reference count to drop to zero, the object frees itself.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the interfaced persistent object has an Owner and that owner supports an interface, then __<method namespace="Classes" class="TInterfacedPersistent">Release</method> simply calls the __<method namespace="Classes" class="TInterfacedPersistent">Release</method> method of the Owner. Otherwise, it simply returns ΓÇô1.</para>
</comments>
</member>
<member name="M:Classes.Classes.QueryInterface">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a reference to a specified interface if the object supports that interface.</para>
<method namespace="Classes" class="TInterfacedPersistent">QueryInterface</method> implements the IInterface method, <method namespace="Classes" class="TInterfacedPersistent">QueryInterface</method>. This method checks whether the interfaced persistent object supports the interface identified by IID. If so, it returns a reference as the Obj parameter, automatically incrementing the reference count for the interface. If the object does not support the specified interface, it returns a non-zero value.</para>
<method namespace="Classes" class="TInterfacedPersistent">AfterConstruction</method> is called automatically after the object's last constructor executes. Do not call it explicitly in your applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TInterfacedPersistent">TInterfacedPersistent</method>, <method namespace="Classes" class="TInterfacedPersistent">AfterConstruction</method> calls the GetOwner method to determine whether this object has an Owner. If so, it obtains a reference to the Owner's interface, to which it can delegate IInterface calls.</para>
<class namespace="Classes">TRecall</class> acts as a temporary repository for the properties of a persistent object. To use <class namespace="Classes">TRecall</class>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1. Create an instance of <class namespace="Classes">TRecall</class>, assigning an object to use for storing property values (the storage object), and an object whose property values it represents (the reference object). When you create an instance of <class namespace="Classes">TRecall</class>, it automatically stores the current properties of the reference object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2. Call the Store method at any time to take a snapshot of the reference object's properties. <class namespace="Classes">TRecall</class> updates the storage object so that it reflects only the property settings from the last time you called the Store method (or, if Store was never called, from the point when the <class namespace="Classes">TRecall</class> object was created).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3. Delete the <class namespace="Classes">TRecall</class> object to restore the reference object to the set of properties it had when you last called the Store method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If you do not want the <class namespace="Classes">TRecall</class> object to restore the properties it is saving, call the Forget method. After you call Forget, the <class namespace="Classes">TRecall</class> object can't be used. It does not update the reference object when destroyed and can't save any more properties.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">You can use <class namespace="Classes">TRecall</class> to save the properties of any persistent object, using any explicitly specified storage object. In addition, <class namespace="Classes">TRecall</class> has several descendants with their own built-in storage objects that work only with a specific class of reference object. These include TFontRecall, TPenRecall, and TBrushRecall.</para>
<method namespace="Classes" class="TRecall">Create</method>s an instance of a <method namespace="Classes" class="TRecall">TRecall</method> object.</para>
<para>Call <method namespace="Classes" class="TRecall">Create</method> to instantiate a <method namespace="Classes" class="TRecall">TRecall</method> object to save the properties of a specific reference object.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AStorage is an object that saves the properties of the reference object. Once you create the <method namespace="Classes" class="TRecall">TRecall</method> instance, it is responsible for the memory of AStorage, and frees AStorage when it is destroyed. Do not free AStorage yourself after creating the <method namespace="Classes" class="TRecall">TRecall</method> object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AReference is the object whose properties are saved when you create the <method namespace="Classes" class="TRecall">TRecall</method> object and, subsequently, any time you call the Store method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AStorage and AReference do not need to be the same type of object. However, <method namespace="Classes" class="TRecall">TRecall</method> can only save and restore those properties that can be assigned from the reference object to the storage object and back again. That is, <method namespace="Classes" class="TRecall">TRecall</method> only handles those properties that are copied by the Assign method of AStorage and AReference.</para>
</comments>
</member>
<member name="M:Classes.Classes.Store">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Saves the current property settings of the reference object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TRecall">Store</method> to update the <method namespace="Classes" class="TRecall">TRecall</method> object's saved property values so that they reflect the current property values of the reference object. Each call to <method namespace="Classes" class="TRecall">Store</method> completely supersedes the previously stored property values.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When you destroy the <method namespace="Classes" class="TRecall">TRecall</method> object, it assigns the most recently stored property values to the reference object.</para>
</comments>
</member>
<member name="M:Classes.Classes.Forget">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Discards the saved property values and prevents the <method namespace="Classes" class="TRecall">TRecall</method> object from updating the reference object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, the <method namespace="Classes" class="TRecall">TRecall</method> destructor updates the reference object, assigning the most recently saved property values. To prevent this from happening, call <method namespace="Classes" class="TRecall">Forget</method> before destroying the <method namespace="Classes" class="TRecall">TRecall</method> object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once you have called <method namespace="Classes" class="TRecall">Forget</method>, the <method namespace="Classes" class="TRecall">TRecall</method> instance can not do anything. It ignores any further attempts to store property settings because it can't use them to update the reference object when it is destroyed.</para>
<method namespace="Classes" class="TRecall">Destroy</method>s the <method namespace="Classes" class="TRecall">TRecall</method> instance, assigning the stored properties to the reference object.</para>
<method namespace="Classes" class="TRecall">Destroy</method> a <method namespace="Classes" class="TRecall">TRecall</method> instance to restore the properties of the reference object to the last values saved to the <method namespace="Classes" class="TRecall">TRecall</method> object. The properties of the reference object are saved to the <method namespace="Classes" class="TRecall">TRecall</method> instance when you first create it, and subsequently any time you call the Store method. The <method namespace="Classes" class="TRecall">TRecall</method> destructor assigns the currently saved property values to the reference object by calling the reference object's Assign method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If you do not want to restore the currently saved property values, call the Forget method before freeing the <method namespace="Classes" class="TRecall">TRecall</method> object. Once you call Forget, <method namespace="Classes" class="TRecall">TRecall</method> ceases to store any property information, and destroying the <method namespace="Classes" class="TRecall">TRecall</method> leaves the properties of the reference object unchanged.</para>
<para>Do not call <method namespace="Classes" class="TRecall">Destroy</method> directly. Call Free instead. Free checks that the object reference is not nil before calling <method namespace="Classes" class="TRecall">Destroy</method>.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.Reference">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the reference object that is updated when you destroy the <property namespace="Classes" class="TRecall">TRecall</property> instance.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Classes" class="TRecall">Reference</property> to determine the object that <property namespace="Classes" class="TRecall">TRecall</property> updates when it is destroyed. The value of this read-only property is assigned in the constructor.</para>
<class namespace="Classes">TCollectionItem</class> represents an item in a collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A TCollection holds a group of <class namespace="Classes">TCollectionItem</class> objects. <class namespace="Classes">TCollectionItem</class>s are created and destroyed by TCollection's Add and Clear methods. Each <class namespace="Classes">TCollectionItem</class> has a Collection property that points to the TCollection object to which the item belongs.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Objects descended from TCollection can contain objects descended from <class namespace="Classes">TCollectionItem</class>. For example, a TDBGridColumns object contains TColumn objects; these two classes are used by TDBGrid to represent grid columns. </para>
</comments>
</member>
<member name="M:Classes.Classes.GetOwner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the collection to which this item belongs.</para>
<method namespace="Classes" class="TCollectionItem">GetOwner</method> is used by the GetNamePath method to find the collection that owns of the collection item, allowing the collection item to appear in the Object Inspector. It returns the value of the Collection property.</para>
<para>The Owner of a collection item is not synonymous with a component's Owner. It has no implications about the freeing of objects but merely serves to represent relationships to the Object Inspector.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.GetNamePath">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a string used by the Object Inspector.</para>
<method namespace="Classes" class="TCollectionItem">GetNamePath</method> determines the text that represents the collection in the Object Inspector. <method namespace="Classes" class="TCollectionItem">TCollectionItem</method> overrides the inherited method to return the name of the collection followed by the index of the item within that collection.</para>
<method namespace="Classes" class="TCollectionItem">Create</method>s and initializes a <method namespace="Classes" class="TCollectionItem">TCollectionItem</method> instance.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TCollectionItem">Create</method> to instantiate a collection item. Instead, call the Add method of the collection to which the item should belong.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Collection identifies the TCollection instance to which the new item belongs.</para>
</comments>
</member>
<member name="M:Classes.Classes.Changed">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Updates the collection to reflect changes to the collection item.</para>
<method namespace="Classes" class="TCollectionItem">Changed</method> is called automatically when a collection item changes in a way that must be reflected by the collection to which the item belongs. For example, when an item's Index property changes, the collection must update the indexes of all other items. Call this method in the implementation of a descendant class when making changes that require the collection to update.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AllItems parameter indicates whether the change affects just the collection item (such as a change to its DisplayName property) or whether it requires corresponding changes to other items in the collection (such as a change to the Index property).</para>
<method namespace="Classes" class="TCollectionItem">Destroy</method>s the <method namespace="Classes" class="TCollectionItem">TCollectionItem</method> instance and frees its memory.</para>
<method namespace="Classes" class="TCollectionItem">Destroy</method> is called indirectly by TCollection's Clear or Delete method.</para>
</comments>
</member>
<member name="P:Classes.Classes.Collection">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the T<property namespace="Classes" class="TCollectionItem">Collection</property> instance to which the T<property namespace="Classes" class="TCollectionItem">Collection</property>Item belongs.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each T<property namespace="Classes" class="TCollectionItem">Collection</property>Item belongs to the T<property namespace="Classes" class="TCollectionItem">Collection</property> which creates it. The <property namespace="Classes" class="TCollectionItem">Collection</property> property points to the collection object to which the item belongs.</para>
</comments>
</member>
<member name="P:Classes.Classes.ID">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A unique, permanent index for the item.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In most cases, <property namespace="Classes" class="TCollectionItem">ID</property> is the value of the item's Index property when it was first added to the collection. But, unlike Index values, <property namespace="Classes" class="TCollectionItem">ID</property> values are never changed or reassigned. If an item is removed from a collection, its <property namespace="Classes" class="TCollectionItem">ID</property> not used again.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An item's Index may change when other items are deleted from the collection or when items are rearranged. <property namespace="Classes" class="TCollectionItem">ID</property> provides a unique identifier for each item that is unchanged for the life of the collection.</para>
</comments>
</member>
<member name="P:Classes.Classes.Index">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the item's position in the Items array of TCollection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each <property namespace="Classes" class="TCollectionItem">TCollectionItem</property> is indexed in the Items array of the TCollection to which it belongs. The <property namespace="Classes" class="TCollectionItem">Index</property> property of the <property namespace="Classes" class="TCollectionItem">TCollectionItem</property> contains the item's index value in that array. Read the value of <property namespace="Classes" class="TCollectionItem">Index</property> to determine the collection item's position. Set the value of <property namespace="Classes" class="TCollectionItem">Index</property> to move the collection item to a new position.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Items is a zero-based array. The first member of the collection has an index value of 0, the second member has an index value of 1, and so forth.</para>
</comments>
</member>
<member name="P:Classes.Classes.DisplayName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The name displayed in the Collection editor.</para>
<property namespace="Classes" class="TCollectionItem">DisplayName</property> is the string that represents the item in the Collection editor. When the item is selected in the Collection editor, the <property namespace="Classes" class="TCollectionItem">DisplayName</property> can also appear in the Object Inspector as the value of another property (for example, as the Text property of THeaderSection or TStatusPanel). By default, <property namespace="Classes" class="TCollectionItem">DisplayName</property> is the name of the <property namespace="Classes" class="TCollectionItem">TCollectionItem</property> descendant class of which the item is an instance.</para>
<type namespace="Qt">TCollectionItemClass</type> is the metaclass for TCollectionItem. Its value is the class reference for TCollectionItem or for one of its descendants.</para>
<type namespace="Qt">TCollectionNotification</type> indicates the type of change that is made to the items in a collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The following table lists the values for <type namespace="Qt">TCollectionNotification</type>:</para>
<class namespace="Classes">TCollection</class> is a container for <class namespace="Classes">TCollection</class>Item objects.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each <class namespace="Classes">TCollection</class> holds a group of <class namespace="Classes">TCollection</class>Item descendants. <class namespace="Classes">TCollection</class> maintains an index of the collection items in its Items array. The Count property contains the number of items in the collection. Use the Add and Delete methods to add items to the collection and delete items from the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Objects descended from <class namespace="Classes">TCollection</class> can contain objects descended from <class namespace="Classes">TCollection</class>Item. Thus, for each <class namespace="Classes">TCollection</class> descendant, there is a corresponding <class namespace="Classes">TCollection</class>Item descendant. The following table lists some typical descendants of <class namespace="Classes">TCollection</class> with the corresponding <class namespace="Classes">TCollection</class>Item descendant and the component that uses each pair.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The controls that use <class namespace="Classes">TCollection</class> and <class namespace="Classes">TCollection</class>Item descendants have a published property that holds a collection. (For example, the Panels property of TStatusBar holds a TStatusPanels.) A standard property editor, referred to generically as the Collection editor, can be invoked from the Object Inspector to edit the items in the collection. </para>
<para>When writing a <class namespace="Classes">TCollection</class> descendant that is used by another control, be sure to override the protected GetOwner method of the collection so that it can appear in the Object Inspector.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.GetAttrCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the number of custom attributes associated with items in the collection.</para>
<method namespace="Classes" class="TCollection">TCollection</method> descendants can associate user-defined attributes with the items in the collection. Each attribute has a name and, for each item in the collection, a value that is a string. <method namespace="Classes" class="TCollection">GetAttrCount</method> returns the number of distinct attributes assigned to each item in the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TCollection">TCollection</method>, <method namespace="Classes" class="TCollection">GetAttrCount</method> always returns 0, because <method namespace="Classes" class="TCollection">TCollection</method> defines no custom attributes.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetAttr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the name of a custom attribute that can be retrieved using the GetItemAttr method.</para>
<method namespace="Classes" class="TCollection">TCollection</method> descendants can associate user-defined attributes with the items in the collection. Each attribute has a name and, for each item in the collection, a value that is a string. The <method namespace="Classes" class="TCollection">GetAttr</method> method returns the name of an attribute.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index identifies the attribute whose name is requested. This is a value between 0 and n-1, where n is the value returned by <method namespace="Classes" class="TCollection">GetAttr</method>Count.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented by <method namespace="Classes" class="TCollection">TCollection</method>, <method namespace="Classes" class="TCollection">GetAttr</method> always returns an empty string, because <method namespace="Classes" class="TCollection">TCollection</method> defines no custom attributes.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetItemAttr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the value of a custom attribute assigned to one of the collection's items.</para>
<method namespace="Classes" class="TCollection">TCollection</method> descendants can associate user-defined attributes with the items in the collection. Each attribute has a name and, for each item in the collection, a value that is a string. <method namespace="Classes" class="TCollection">GetItemAttr</method> returns the value of one of these attributes for a specified item in the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index identifies which attribute's value is desired. This is a value between 0 and n-1, where n is the value returned by GetAttrCount.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ItemIndex identifies the item whose attribute value is desired. This is an index into the Items property array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TCollection">TCollection</method>, <method namespace="Classes" class="TCollection">GetItemAttr</method> always returns an empty string, because <method namespace="Classes" class="TCollection">TCollection</method> defines no custom attributes.</para>
</comments>
</member>
<member name="M:Classes.Classes.Owner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the <method namespace="Classes" class="TCollection">Owner</method> of the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TCollection">Owner</method> to obtain a reference to the object that owns this collection. Typically, the owner uses the collection to implement one of its properties.</para>
</comments>
</member>
<member name="M:Classes.Classes.Add">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new <method namespace="Classes" class="TCollection">TCollection</method>Item instance and adds it to the Items array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TCollection">Add</method> to create an item in the collection. The new item is placed at the end of the Items array.</para>
<method namespace="Classes" class="TCollection">Add</method> returns the new collection item.</para>
</comments>
</member>
<member name="M:Classes.Classes.FindItemID">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the item with the specified ID.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TCollection">FindItemID</method> method returns the item in the collection whose ID property is passed to it as a parameter. If no item has the specified ID, <method namespace="Classes" class="TCollection">FindItemID</method> returns nil (Delphi) or NULL (C++).</para>
</comments>
</member>
<member name="M:Classes.Classes.GetNamePath">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a string used by the Object Inspector.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the collection has no owner, <method namespace="Classes" class="TCollection">GetNamePath</method> returns the name of the collection's actual (runtime) type. If the collection is owned, <method namespace="Classes" class="TCollection">GetNamePath</method> returns the owner's name followed, if applicable, by a dot and the name of the owner's property that holds the collection. For example, <method namespace="Classes" class="TCollection">GetNamePath</method> might return "TreeView1.Items".</para>
<para>For a collection to have an owner, it must override the GetOwner method.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Insert">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new <method namespace="Classes" class="TCollection">TCollection</method>Item instance and adds it to the Items array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TCollection">Insert</method> to add a new item at a specified position in the collection. Existing items (starting from the specified position) are moved up in the Items array.</para>
<method namespace="Classes" class="TCollection">Create</method>s and initializes a collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TCollection">Create</method> to instantiate a <method namespace="Classes" class="TCollection">TCollection</method> object at runtime. Typically, <method namespace="Classes" class="TCollection">TCollection</method> descendants are created by a component that uses the collection to implement a property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ItemClass identifies <method namespace="Classes" class="TCollection">TCollection</method>Item descendant that must be used to represent the items in the collection. The Add method uses this class to create items of the appropriate type.</para>
</comments>
</member>
<member name="M:Classes.Classes.Added">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when items are added to the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can't call the protected <method namespace="Classes" class="TCollection">Added</method> method. It is called automatically immediately after items are added to the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Item is the item that was just added to the collection.</para>
<method namespace="Classes" class="TCollection">Added</method> is a deprecated method. Descendant classes should override the Notify method instead when responding to changes in the list of items.</para>
</comments>
</member>
<member name="M:Classes.Classes.Deleting">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when items are deleted from the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can't call the protected <method namespace="Classes" class="TCollection">Deleting</method> method. The Delete method calls <method namespace="Classes" class="TCollection">Deleting</method> immediately before it removes an item from the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Item is the item that is about to be removed.</para>
<method namespace="Classes" class="TCollection">Deleting</method> is a deprecated method. Descendant classes should override the Notify method instead when responding to changes in the list of items.</para>
</comments>
</member>
<member name="M:Classes.Classes.Notify">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when items are added to or removed from the collection.</para>
<method namespace="Classes" class="TCollection">Notify</method> is called automatically when the items in the collection change.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Item is the item that was just added to or that is about to be removed from the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Action indicates whether item was added, is about to be removed, or is about to be deleted:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TCollection">TCollection</method>, <method namespace="Classes" class="TCollection">Notify</method> calls Added when Action is cnAdded and calls Deleting when Action is cnDeleting. <method namespace="Classes" class="TCollection">TCollection</method> ignores the cnExtracting action. Descendant classes can override <method namespace="Classes" class="TCollection">Notify</method> to modify this behavior.</para>
</comments>
</member>
<member name="M:Classes.Classes.Changed">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when the collection or any of its items changes.</para>
<method namespace="Classes" class="TCollection">Changed</method> is called automatically when items in the collection change or when the EndUpdate method signals that an update is complete. It checks the value of UpdateCount, and if it is 0, calls the Update method, which performs any necessary updates.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When writing a <method namespace="Classes" class="TCollection">TCollection</method> descendant, there is no need to call <method namespace="Classes" class="TCollection">Changed</method>. Instead, bracket any changes by calls to BeginUpdate and EndUpdate.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetItemName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the name of a newly inserted collection item.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Insert method calls <method namespace="Classes" class="TCollection">SetItemName</method> to initialize the Name property of items when it inserts them into the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TCollection">TCollection</method>, <method namespace="Classes" class="TCollection">SetItemName</method> does nothing. Some <method namespace="Classes" class="TCollection">TCollection</method> descendants override this method to provide collection items with default names.</para>
<method namespace="Classes" class="TCollection">Update</method>s the collection to reflect changes to its items.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Override <method namespace="Classes" class="TCollection">Update</method> in a descendant class to make any necessary changes when the items in the collection change. This method is called automatically when an update is complete.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Item identifies the item that changed. If the Item parameter is nil (Delphi) or NULL (C++), then the change affects more than one item in the collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TCollection">TCollection</method>, <method namespace="Classes" class="TCollection">Update</method> does nothing. Descendant classes override this method to make any necessary adjustments.</para>
</comments>
</member>
<member name="M:Classes.Classes.Assign">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the contents of another collection to the object where the method is executed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TCollection">Assign</method> to copy the contents of one <method namespace="Classes" class="TCollection">TCollection</method> instance to another. The <method namespace="Classes" class="TCollection">Assign</method> method deletes all items from the destination collection (the object where it is executed), then adds a copy of each item in the source collection's Items array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Source is another object (typically another collection) that contains the items that replace this collection's items.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TCollection">BeginUpdate</method> method suspends screen repainting until the EndUpdate method is called. Use <method namespace="Classes" class="TCollection">BeginUpdate</method> to speed processing and avoid flicker while items are added to or deleted from a collection.</para>
</comments>
</member>
<member name="M:Classes.Classes.Clear">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Deletes all items from the collection.</para>
<method namespace="Classes" class="TCollection">Clear</method> empties the Items array and destroys each <method namespace="Classes" class="TCollection">TCollection</method>Item.</para>
<method namespace="Classes" class="TCollection">Delete</method> removes the specified collection item, moving up any items that come after that item in the Items property array.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index identifies the item to delete. This is the index of the item in the Items property array. That is, 0 specifies the first item, 1 specifies the second item, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TCollection">EndUpdate</method> to re-enable screen repainting that was turned off with the BeginUpdate method.</para>
<method namespace="Classes" class="TCollection">Destroy</method> calls the Clear method to free each item referenced in the Items array, then destroys the collection itself.</para>
</comments>
</member>
<member name="P:Classes.Classes.NextID">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a unique ID that can be assigned to the next added collection item.</para>
<property namespace="Classes" class="TCollection">TCollection</property> uses <property namespace="Classes" class="TCollection">NextID</property> internally to assign unique identifiers to collection items. When a new item is added to the collection, it's ID property is given the value of <property namespace="Classes" class="TCollection">NextID</property> and <property namespace="Classes" class="TCollection">NextID</property> is incremented.</para>
</comments>
</member>
<member name="P:Classes.Classes.PropName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the property that the collection implements.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The GetNamePath method uses this protected property to assemble the name of the collection as it appears in the Object Inspector. It identifies the name of the property in the object returned by the protected GetOwner method that is implemented using this collection object.</para>
</comments>
</member>
<member name="P:Classes.Classes.UpdateCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Counts the number of times BeginUpdate was called without a corresponding call to EndUpdate.</para>
<property namespace="Classes" class="TCollection">UpdateCount</property> keeps track of calls to BeginUpdate and EndUpdate so that they can be nested. Every call to BeginUpdate increments <property namespace="Classes" class="TCollection">UpdateCount</property>. Every call to EndUpdate decrements it. When <property namespace="Classes" class="TCollection">UpdateCount</property> returns to 0, the collection updates itself to reflect all changes that occurred since the first call to BeginUpdate.</para>
</comments>
</member>
<member name="P:Classes.Classes.Count">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the number of items in the collection.</para>
<property namespace="Classes" class="TCollection">Count</property> contains the number of items in the Items array. Since Items is indexed starting with 0, the value of <property namespace="Classes" class="TCollection">Count</property> is always one greater than the index of the last member of Items.</para>
</comments>
</member>
<member name="P:Classes.Classes.ItemClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the class to which the collection's items belong.</para>
<property namespace="Classes" class="TCollection">ItemClass</property> is the class (descended from <property namespace="Classes" class="TCollection">TCollection</property>Item) to which the items in the collection belong. For example, in an instance of the <property namespace="Classes" class="TCollection">TCollection</property> descendant THeaderSections, the value of the <property namespace="Classes" class="TCollection">ItemClass</property> property is THeaderSection.</para>
</comments>
</member>
<member name="P:Classes.Classes.Items">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the items in the collection.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TCollection">Items</property> to access individual items in the collection. The value of the Index parameter corresponds to the Index property of <property namespace="Classes" class="TCollection">TCollection</property>Item. It represents the position of the item in the collection.</para>
<class namespace="Classes">TOwnedCollection</class> is a collection that maintains information about its owner.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By maintaining information about its owner, <class namespace="Classes">TOwnedCollection</class> lets the Object Inspector display the collection's name at design time. </para>
<para>This information is not part of <class namespace="Classes">TOwnedCollection</class>'s public interface.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">New collection classes should descend from <class namespace="Classes">TOwnedCollection</class>. By descending from <class namespace="Classes">TOwnedCollection</class>, the derived class does not need to add anything in order to appear in the Object Inspector. Classes that descend directly from TCollection must implement a GetOwner method if they are to appear in the Object Inspector.</para>
<method namespace="Classes" class="TOwnedCollection">Create</method>s and initializes a <method namespace="Classes" class="TOwnedCollection">TOwnedCollection</method> instance.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TOwnedCollection">Create</method> method takes two parameters: the name of an instance object descended from TPersistent and the name of a TCollectionItem descendant class. The first parameter is the owner of the <method namespace="Classes" class="TOwnedCollection">TOwnedCollection</method> instance. The second parameter determines the class of the items created by the Add method.</para>
<class namespace="Classes">TStrings</class> is the base class for objects that represent a list of strings.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Derive a class from <class namespace="Classes">TStrings</class> to store and manipulate a list of strings. <class namespace="Classes">TStrings</class> contains abstract or, in C++ terminology, pure virtual methods and should not be directly instantiated.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <class namespace="Classes">TStrings</class> can represent several individual strings, such as the individual lines that appear in a list box. Some objects use descendants of <class namespace="Classes">TStrings</class> to represent one long body of text so that it can be manipulated in smaller chunks.</para>
<method namespace="Classes" class="TStrings">TStrings</method> calls <method namespace="Classes" class="TStrings">ExtractName</method> internally to parse strings that are name-value pairs and return the name portion.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">S is the string to parse.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If S is a name-value pair, <method namespace="Classes" class="TStrings">ExtractName</method> returns the name portion. Otherwise, <method namespace="Classes" class="TStrings">ExtractName</method> returns an empty string.</para>
</comments>
</member>
<member name="M:Classes.Classes.CompareStrings">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Compares two strings.</para>
<method namespace="Classes" class="TStrings">TStrings</method> uses <method namespace="Classes" class="TStrings">CompareStrings</method> internally to compare the values of strings that appear in the list. For example, the IndexOf and IndexOfName methods use <method namespace="Classes" class="TStrings">CompareStrings</method> to compare a specified string with the strings in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">S1 and S2 are the strings to compare.</para>
<method namespace="Classes" class="TStrings">CompareStrings</method> returns a value less than 0 if S1 < S2, 0 if S1 =<condition language="CBuilder">=</condition> S2, and a value greater than 0 if S1 > S2.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TStrings">TStrings</method>, <method namespace="Classes" class="TStrings">CompareStrings</method> uses the global AnsiCompareText function, which compares strings case insensitively. Some descendant classes override this method to change the way strings are compared (for example, to introduce case sensitivity).</para>
<method namespace="Classes" class="TStrings">Add</method>s a string at the end of the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">Add</method> to add a string to the end of the list. <method namespace="Classes" class="TStrings">Add</method> returns the index of the new string.</para>
</comments>
</member>
<member name="M:Classes.Classes.AddObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a string to the list, and associates an object with the string. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">AddObject</method> to add a string and its associated object to the list. <method namespace="Classes" class="TStrings">AddObject</method> returns the index of the new string and object.</para>
<para>The <method namespace="Classes" class="TStrings">TStrings</method> object does not own the objects you add this way. Objects added to the <method namespace="Classes" class="TStrings">TStrings</method> object still exist even if the <method namespace="Classes" class="TStrings">TStrings</method> instance is destroyed. They must be explicitly destroyed by the application.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Equals">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Compares the list of strings to the list from another <method namespace="Classes" class="TStrings">TStrings</method> object and returns true if the two lists match.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">Equals</method> to compare the lists in two <method namespace="Classes" class="TStrings">TStrings</method> objects. <method namespace="Classes" class="TStrings">Equals</method> compares only the strings, not any references to associated objects. <method namespace="Classes" class="TStrings">Equals</method> returns true if the lists for both <method namespace="Classes" class="TStrings">TStrings</method> objects have the same number of strings and the strings in each list match when compared using the protected CompareStrings method. <method namespace="Classes" class="TStrings">Equals</method> returns false if the lists are different in length, if they contain different strings, or if the order of the strings in the two lists differ.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Allocates a text buffer and fills it with the value of the Text property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">GetText</method> to obtain a dynamically allocated character buffer containing all of the strings in the list. Individual strings are separated by a carriage return and (on Windows) line feed. The caller is responsible for freeing the returned value using the StrDispose procedure.</para>
</comments>
</member>
<member name="M:Classes.Classes.IndexOf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the position of a string in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">IndexOf</method> to obtain the position of the first occurrence of the string S, or of a string that differs from S only by case. <method namespace="Classes" class="TStrings">IndexOf</method> returns the 0-based index of the string. Thus, if S matches the first string in the list, <method namespace="Classes" class="TStrings">IndexOf</method> returns 0, if S is the second string, <method namespace="Classes" class="TStrings">IndexOf</method> returns 1, and so on. If the string is not in the string list, <method namespace="Classes" class="TStrings">IndexOf</method> returns -1.</para>
<para>If the string appears in the list more than once, <method namespace="Classes" class="TStrings">IndexOf</method> returns the position of the first occurrence.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.IndexOfName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the position of the first name-value pair with the specified name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">IndexOfName</method> to locate the first occurrence of a name-value pair where the name part is equal to the Name parameter or differs only in case. <method namespace="Classes" class="TStrings">IndexOfName</method> returns the 0-based index of the string. If no string in the list has the indicated name, <method namespace="Classes" class="TStrings">IndexOfName</method> returns -1.</para>
<para>If there is more than one name-value pair with a name portion matching the Name parameter, <method namespace="Classes" class="TStrings">IndexOfName</method> returns the position of the first such string.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.IndexOfObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of the first string in the list associated with a given object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">IndexOfObject</method> to locate the first string in the list associated with the object AObject. Specify the object you want to locate as the value of the AObject parameter. <method namespace="Classes" class="TStrings">IndexOfObject</method> returns the 0-based index of the string and object. If the object is not associated with any of the strings, <method namespace="Classes" class="TStrings">IndexOfObject</method> returns -1.</para>
<method namespace="Classes" class="TStrings">TStrings</method> overrides <method namespace="Classes" class="TStrings">DefineProperties</method> so that the strings in the list can be loaded and saved with a form file as if the Strings property were published.</para>
</comments>
</member>
<member name="M:Classes.Classes.Error">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">raises an EStringList<method namespace="Classes" class="TStrings">Error</method> exception.</para>
<method namespace="Classes" class="TStrings">TStrings</method> calls <method namespace="Classes" class="TStrings">Error</method> internally to raise an EStringList<method namespace="Classes" class="TStrings">Error</method> exception when it encounters a problem.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Msg specifies the string with a single format specifier for an integer, that appears in the exception message box. It can be either a string, or a pointer to a <condition language="Delphi">record</condition>
<condition language="CBuilder">structure</condition> that indicates the module and resource identifier for a string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Data is an integer value that is inserted into Msg.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetUpdateState">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Performs internal adjustments before or after a series of updates.</para>
<method namespace="Classes" class="TStrings">SetUpdateState</method> is called at the beginning or end of a series of updates. When the BeginUpdate method is first called and the <method namespace="Classes" class="TStrings">TStrings</method> object is not already in the middle of an update, <method namespace="Classes" class="TStrings">TStrings</method> calls <method namespace="Classes" class="TStrings">SetUpdateState</method> internally, with Updating set to true. When the EndUpdate method is called and it cancels out the last unmatched call to BeginUpdate, <method namespace="Classes" class="TStrings">TStrings</method> calls <method namespace="Classes" class="TStrings">SetUpdateState</method> internally, with Updating set to false.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TStrings">TStrings</method>, <method namespace="Classes" class="TStrings">SetUpdateState</method> does nothing. Descendant classes can override this method to optimize the response to updates.</para>
</comments>
</member>
<member name="M:Classes.Classes.Append">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a string to the list.</para>
<method namespace="Classes" class="TStrings">Append</method> is the same as the Add method, except that it does not return a value. Use <method namespace="Classes" class="TStrings">Append</method> when there is no need to know the index of the string after it has been added, or with descendants of <method namespace="Classes" class="TStrings">TStrings</method> for which the index returned is not meaningful. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, the <method namespace="Classes" class="TStrings">TStrings</method> descendant used by memo objects uses an index to determine where to insert a string, but the inserted string does not necessarily end up as a single string in the list. Part of the inserted text may become part of the previous string, and part may be broken off into a subsequent string. The index returned by Add is not meaningful in this case. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStrings">Append</method> rather than Add as a parameter for a function requiring a TGetStrProc.</para>
</comments>
</member>
<member name="M:Classes.Classes.AddStrings">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a group of strings to the list. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">AddStrings</method> to add the strings from another <method namespace="Classes" class="TStrings">TStrings</method> object to the list. If both the source and destination <method namespace="Classes" class="TStrings">TStrings</method> objects support objects associated with their strings, references to the associated objects will be added as well.</para>
</comments>
</member>
<member name="M:Classes.Classes.Assign">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the strings in the list, and possibly associated objects, from a source object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStrings">Assign</method> to set the value of the <method namespace="Classes" class="TStrings">TStrings</method> object from another object. If Source is of type <method namespace="Classes" class="TStrings">TStrings</method>, the list is set to the list of the source <method namespace="Classes" class="TStrings">TStrings</method> object, and if associated objects are supported, any associated objects are copied from the Source as well. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Source is not of type <method namespace="Classes" class="TStrings">TStrings</method>, the inherited <method namespace="Classes" class="TStrings">Assign</method> will set the value of the list from any object that supports <method namespace="Classes" class="TStrings">TStrings</method> in its <method namespace="Classes" class="TStrings">Assign</method>To method.</para>
</comments>
</member>
<member name="M:Classes.Classes.BeginUpdate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enables the <method namespace="Classes" class="TStrings">TStrings</method> object to track when the list of strings is changing.</para>
<method namespace="Classes" class="TStrings">BeginUpdate</method> is called automatically by any property or method that changes the list of strings. Once the changes are complete, the property or method calls EndUpdate. Call <method namespace="Classes" class="TStrings">BeginUpdate</method> before directly modifying the strings in the list, and EndUpdate after. When implementing properties or methods that change the list in descendants of <method namespace="Classes" class="TStrings">TStrings</method>, call <method namespace="Classes" class="TStrings">BeginUpdate</method> before the changes are made, and EndUpdate when the changes are complete.</para>
<method namespace="Classes" class="TStrings">TStrings</method> simply keeps track of when the list of strings is being changed. Some descendants of <method namespace="Classes" class="TStrings">TStrings</method> use this information to perform certain actions, such as telling a control to repaint, when updates are complete.</para>
</comments>
</member>
<member name="M:Classes.Classes.Clear">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract (Delphi) or pure virtual (C++) method to empty the list and any associated objects.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="Classes" class="TStrings">TStrings</method> implement a <method namespace="Classes" class="TStrings">Clear</method> method to delete all the strings in the list, and to remove any references to associated objects.</para>
</comments>
</member>
<member name="M:Classes.Classes.Delete">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract (Delphi) or pure virtual (C++) method to delete a specified string from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="Classes" class="TStrings">TStrings</method> implement a <method namespace="Classes" class="TStrings">Delete</method> method to remove a specified string from the list. If an object is associated with the string, the reference to the object is removed as well. Index gives the position of the string, where 0 is the first string, 1 is the second string, and so on.</para>
</comments>
</member>
<member name="M:Classes.Classes.EndUpdate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enables the <method namespace="Classes" class="TStrings">TStrings</method> object to keep track of when the list of strings has finished changing.</para>
<method namespace="Classes" class="TStrings">EndUpdate</method> is called automatically by any property or method that changes the list of strings. Call BeginUpdate before directly modifying the strings in the list, and <method namespace="Classes" class="TStrings">EndUpdate</method> after. When implementing properties or methods that change the list in descendants of <method namespace="Classes" class="TStrings">TStrings</method>, call BeginUpdate before the changes are made, and <method namespace="Classes" class="TStrings">EndUpdate</method> when the changes are complete.</para>
<method namespace="Classes" class="TStrings">TStrings</method> simply keeps track of when the list of strings is being changed. Some descendants of <method namespace="Classes" class="TStrings">TStrings</method> use this information to perform certain actions, such as telling a control to repaint, when updates are complete.</para>
</comments>
</member>
<member name="M:Classes.Classes.Exchange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Swaps the position of two strings in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">Exchange</method> to rearrange the strings in the list. The strings are specified by their index values in the Index1 and Index2 parameters. Indexes are zero-based, so the first string in the list has an index value of 0, the second has an index value of 1, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If either string has an associated object, <method namespace="Classes" class="TStrings">Exchange</method> changes the position of the object as well.</para>
</comments>
</member>
<member name="M:Classes.Classes.Insert">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces abstract (Delphi) or pure virtual (C++) method to insert a string at a specified position.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="Classes" class="TStrings">TStrings</method> implement an <method namespace="Classes" class="TStrings">Insert</method> method to add the string S to the list at the position specified by Index. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All methods that add strings to the list use the <method namespace="Classes" class="TStrings">Insert</method> method to add the string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the string has an associated object, use the <method namespace="Classes" class="TStrings">Insert</method>Object method instead.</para>
</comments>
</member>
<member name="M:Classes.Classes.InsertObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Inserts a string into the list at the specified position, and associates it with an object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">InsertObject</method> to insert the string S into the list at the position identified by Index, and associate it with the object AObject. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.</para>
</comments>
</member>
<member name="M:Classes.Classes.LoadFromFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Fills the list with the lines of text in a specified file.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">LoadFromFile</method> to fill the list of the <method namespace="Classes" class="TStrings">TStrings</method> object from the file specified by FileName. <method namespace="Classes" class="TStrings">LoadFromFile</method> first clears any strings already in the list. Then, each line in the file, as indicated by carriage return or linefeed characters, is appended as a string in the list.</para>
<method namespace="Classes" class="TStrings">LoadFromFile</method> uses the Add method to add the strings that are read from the file.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.LoadFromStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Fills the list with lines of text read from a stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">LoadFromStream</method> to fill the list of the <method namespace="Classes" class="TStrings">TStrings</method> object from the stream specified by Stream. The text read from the stream is parsed into strings separated by carriage return or linefeed characters. Thus, <method namespace="Classes" class="TStrings">LoadFromStream</method> reads the value of the Text property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the stream is a file stream, <method namespace="Classes" class="TStrings">LoadFromStream</method> does the same thing as LoadFromFile, except the application must create and destroy the file stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.Move">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes the position of a string in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStrings">Move</method> to move the string at position CurIndex so that it occupies the position NewIndex. The positions are specified as 0-based indexes. For example, the following lines of code move the string in the first position to the last position.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the string has an associated object, the object remains associated with the string in its new position.</para>
</comments>
</member>
<member name="M:Classes.Classes.SaveToFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Saves the strings in the list to the specified file.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">SaveToFile</method> to save the strings in the list to the file specified by FileName. Each string in the list is written to a separate line in the file.</para>
<para>In Linux, <method namespace="Classes" class="TStrings">SaveToFile</method> saves the strings as they appear in the list. If the last string does not have an end-of-line marker, the resulting file may be considered incomplete by some editors. </para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.SaveToStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the value of the Text property to a stream object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">SaveToStream</method> to save the strings in the list to the stream specified by the Stream parameter. <method namespace="Classes" class="TStrings">SaveToStream</method> writes the strings delimited by carriage return, line feed pairs. If the stream is a file stream, <method namespace="Classes" class="TStrings">SaveToStream</method> does the same thing as SaveToFile, except the application must create and destroy the file stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the Text property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStrings">SetText</method> to replace the list with the strings specified by the Text parameter. <method namespace="Classes" class="TStrings">SetText</method> adds strings one at a time to the list, using the carriage returns or linefeed characters in Text as delimiters indicating when to add a new string.</para>
</comments>
</member>
<member name="P:Classes.Classes.UpdateCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of calls to BeginUpdate that have not been matched by a call to EndUpdate.</para>
<property namespace="Classes" class="TStrings">TStrings</property> uses <property namespace="Classes" class="TStrings">UpdateCount</property> to keep track of calls to the BeginUpdate and EndUpdate methods. Every time a call is made to BeginUpdate, <property namespace="Classes" class="TStrings">TStrings</property> increments the value of <property namespace="Classes" class="TStrings">UpdateCount</property>. Every call to EndUpdate causes <property namespace="Classes" class="TStrings">TStrings</property> to decrement <property namespace="Classes" class="TStrings">UpdateCount</property>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="Classes" class="TStrings">UpdateCount</property> changes from 0 to 1, <property namespace="Classes" class="TStrings">TStrings</property> calls the SetUpdateState method with a parameter of true. When <property namespace="Classes" class="TStrings">UpdateCount</property> changes from 1 to 0, <property namespace="Classes" class="TStrings">TStrings</property> calls the SetUpdateState method with a parameter of false. This allows descendant classes to perform optimizations when handling multiple updates.</para>
</comments>
</member>
<member name="P:Classes.Classes.Capacity">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of strings the <property namespace="Classes" class="TStrings">TStrings</property> object can hold.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Classes" class="TStrings">Capacity</property> to determine the currently allocated size of the string list. For the <property namespace="Classes" class="TStrings">TStrings</property> object, reading <property namespace="Classes" class="TStrings">Capacity</property> returns the Count property, and setting <property namespace="Classes" class="TStrings">Capacity</property> does nothing. Descendants of <property namespace="Classes" class="TStrings">TStrings</property> can override this property to allow a string list to allocate memory for entries that have not been added to the list.</para>
</comments>
</member>
<member name="P:Classes.Classes.CommaText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object in system data format (SDF).</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStrings">CommaText</property> to get or set all the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object in a single comma-delimited string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When retrieving <property namespace="Classes" class="TStrings">CommaText</property>, any string in the list that include spaces, commas or quotes will be contained in double quotes, and any double quotes in a string will be repeated. For example, if the list contains the following strings:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When assigning <property namespace="Classes" class="TStrings">CommaText</property>, the value is parsed as SDF formatted text. For SDF format, strings are separated by commas or spaces, and optionally enclosed in double quotes. Double quote marks that are part of the string are repeated to distinguish them from the quotes that surround the string. Spaces and commas that are not contained within double quote marks are delimiters. Two commas next to each other will indicate an empty string, but spaces that appear next to another delimiter are ignored. For example, suppose <property namespace="Classes" class="TStrings">CommaText</property> is set to:</para>
<property namespace="Classes" class="TStrings">CommaText</property> is the same as the DelimitedText property with a delimiter of ',' and a quote character of '"'.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Including a trailing comma in the source string causes a blank item to be included in the string list. For example, if <property namespace="Classes" class="TStrings">CommaText</property> is set to</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract property to represent the number of strings in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <property namespace="Classes" class="TStrings">TStrings</property> implement a <property namespace="Classes" class="TStrings">Count</property> property to indicate the number of strings in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="Classes" class="TStrings">Count</property> property when iterating over all the strings in the list, or when trying to locate the position of a string relative to the last string in the list.</para>
</comments>
</member>
<member name="P:Classes.Classes.Delimiter">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the delimiter used by the DelimitedText property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStrings">Delimiter</property> to get or set the delimiter used by the DelimitedText property. DelimitedText represents all of the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object as a single string, with individual strings separated by the character that is the value of <property namespace="Classes" class="TStrings">Delimiter</property>.</para>
</comments>
</member>
<member name="P:Classes.Classes.DelimitedText">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents all the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object as a single delimited string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStrings">DelimitedText</property> to get or set all the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object in a single string. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When reading <property namespace="Classes" class="TStrings">DelimitedText</property>, the resulting value delimits individual strings in two ways: each string is surrounded (before and after) by the quote character specified by the QuoteChar property. In addition, individual strings are separated by the character specified by the Delimiter property. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When writing <property namespace="Classes" class="TStrings">DelimitedText</property>, individual strings must be separated using QuoteChar at both ends, using Delimiter as a separator, or using both these methods.</para>
<para>CommaText is the same as the <property namespace="Classes" class="TStrings">DelimitedText</property> property when Delimiter is ',' and QuoteChar is '"'.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.Names">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the name part of strings that are name-value pairs.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the list of strings for the <property namespace="Classes" class="TStrings">TStrings</property> object includes strings that are name-value pairs, read <property namespace="Classes" class="TStrings">Names</property> to access the name part of a string. <property namespace="Classes" class="TStrings">Names</property> is the name part of the string at Index, where 0 is the first string, 1 is the second string, and so on. If the string is not a name-value pair, <property namespace="Classes" class="TStrings">Names</property> contains an empty string.</para>
</comments>
</member>
<member name="P:Classes.Classes.Objects">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents a set of objects that are associated one with each of the strings in the Strings property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Setting the <property namespace="Classes" class="TStrings">Objects</property> property for <property namespace="Classes" class="TStrings">TStrings</property> does nothing. Reading the <property namespace="Classes" class="TStrings">Objects</property> property for <property namespace="Classes" class="TStrings">TStrings</property> returns nil (Delphi) or NULL (C++). Descendant classes can associate objects with the strings in the set by implementing the <property namespace="Classes" class="TStrings">Objects</property> property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="Classes" class="TStrings">Objects</property> property of a descendant of <property namespace="Classes" class="TStrings">TStrings</property> to get or set the object associated with the string at the position indicated by Index. Index gives the position of the string associated with the object, where 0 is the first string, 1 is the second string, and so on. If a descendant of <property namespace="Classes" class="TStrings">TStrings</property> does not support the <property namespace="Classes" class="TStrings">Objects</property> property, reading this property returns nil (Delphi) or NULL (C++)</para>
<para>The <property namespace="Classes" class="TStrings">TStrings</property> object does not own the objects in the <property namespace="Classes" class="TStrings">Objects</property> array. <property namespace="Classes" class="TStrings">Objects</property> added to the <property namespace="Classes" class="TStrings">Objects</property> array still exist even if the <property namespace="Classes" class="TStrings">TStrings</property> object is destroyed. They must be explicitly destroyed by the application.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.QuoteChar">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the quote character used by the DelimitedText property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStrings">QuoteChar</property> to get or set the quote character that is used to enclose individual strings in the DelimitedText property.</para>
</comments>
</member>
<member name="P:Classes.Classes.Values">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the value part of a string associated with a given name, on strings that are name-value pairs.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the list of strings for the <property namespace="Classes" class="TStrings">TStrings</property> object includes strings that are name-value pairs, use <property namespace="Classes" class="TStrings">Values</property> to get or set the value part of a string associated with a specific name part. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information on name-value pairs, refer to the NameValueSeparator property.</para>
<para>The Name index is case-insensitive. That is, <property namespace="Classes" class="TStrings">Values</property> is the value part for the first occurrence of Name or an equivalent string that differs only in case. </para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.ValueFromIndex">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the value part of a string with a given index, on strings that are name-value pairs.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the list of strings for the <property namespace="Classes" class="TStrings">TStrings</property> object includes strings that are name-value pairs, use <property namespace="Classes" class="TStrings">ValueFromIndex</property> to get or set the value part of a string associated with an index. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For more information on name-value pairs, refer to the NameValueSeparator property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the character used to separate names from values.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Strings that contain the <property namespace="Classes" class="TStrings">NameValueSeparator</property> character are considered name-value pairs. <property namespace="Classes" class="TStrings">NameValueSeparator</property> defaults to the equal sign (=). <property namespace="Classes" class="TStrings">TStrings</property> defines various methods for accessing names and values and for searching for specific names.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Strings that are name-value pairs consist of a name part, the separator character, and a value part. Any spaces around the separator character are part of the name or value. This convention corresponds to the format used in many initialization files. For example:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">References the strings in the list by their positions.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of T<property namespace="Classes" class="TStrings">Strings</property> must implement an accessor function for the <property namespace="Classes" class="TStrings">Strings</property> property to return the string at the position indicated by Index. Index gives the position of the string, where 0 is the first string, 1 is the second string, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the <property namespace="Classes" class="TStrings">Strings</property> property to get or set the string at a particular position.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To store a string as a name-value pair, assign <property namespace="Classes" class="TStrings">Strings</property> a value that includes the NameValueSeparator character. The name and value will then be accessible separately using the Names and Values properties.</para>
<para>In Delphi, <property namespace="Classes" class="TStrings">Strings</property> is the default property of T<property namespace="Classes" class="TStrings">Strings</property> objects. The <property namespace="Classes" class="TStrings">Strings</property> identifier can be omitted when accessing the <property namespace="Classes" class="TStrings">Strings</property> property of a descendant of T<property namespace="Classes" class="TStrings">Strings</property>. For example, the following two lines of code are both acceptable and do the same thing:</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">My<property namespace="Classes" class="TStrings">Strings</property>.<property namespace="Classes" class="TStrings">Strings</property>[0] := 'This is the first string';</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">My<property namespace="Classes" class="TStrings">Strings</property>[0] := 'This is the first string';</para>
</comments>
</member>
<member name="P:Classes.Classes.Text">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object as a single string with the individual strings delimited by carriage returns and line feeds.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStrings">Text</property> to get or set all the strings in the <property namespace="Classes" class="TStrings">TStrings</property> object in a single string delimited by carriage return, line feed pairs.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When reading <property namespace="Classes" class="TStrings">Text</property>, the strings in the list will be separated by carriage return and (on Windows) line feed. If any of the strings in the list contain a carriage return (and line feed), the resulting value of <property namespace="Classes" class="TStrings">Text</property> will appear to contain more strings than is indicated by the Count property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When setting <property namespace="Classes" class="TStrings">Text</property>, the value will be parsed by separating into substrings whenever a carriage return or linefeed is encountered. (The two do not need to form pairs).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the strings in the list contain carriage return or linefeed characters, a less ambiguous format for the strings is available through the Comma<property namespace="Classes" class="TStrings">Text</property> or Delimited<property namespace="Classes" class="TStrings">Text</property> property.</para>
</comments>
</member>
<member name="P:Classes.Classes.StringsAdapter">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements an I<property namespace="Classes" class="TStrings">StringsAdapter</property> interface for the <property namespace="Classes" class="TStrings">TStrings</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not use the <property namespace="Classes" class="TStrings">StringsAdapter</property> property. <property namespace="Classes" class="TStrings">StringsAdapter</property> is used internally.</para>
<class namespace="Classes">TStringList</class> maintains a list of strings. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a string list object to store and manipulate a list of strings. <class namespace="Classes">TStringList</class> implements the abstract properties and methods introduced by TStrings, and introduces new properties, events, and methods to</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sort the strings in the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Prohibit duplicate strings in sorted lists.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Respond to changes in the contents of the list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Control whether strings are located, sorted, and identified as duplicates in a case-sensitive or case-insensitive manner.</para>
<method namespace="Classes" class="TStringList">Add</method>s a new string to the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">Add</method> to add the string S to the list. If the list is sorted, S is added to the appropriate position in the sort order. If the list is not sorted, S is added to the end of the list. <method namespace="Classes" class="TStringList">Add</method> returns the position of the item in the list, where the first item in the list has a value of 0.</para>
<para>For sorted lists, <method namespace="Classes" class="TStringList">Add</method> will raise an EListError exception if the string S already appears in the list and Duplicates is set to dupError. If Duplicates is set to dupIgnore, trying to add a duplicate string causes <method namespace="Classes" class="TStringList">Add</method> to return the index of the existing entry.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.AddObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a string to the list, and associates an object with the string. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">AddObject</method> to add a string and its associated object to the list. <method namespace="Classes" class="TStringList">AddObject</method> returns the index of the new string and object.</para>
<para>The <method namespace="Classes" class="TStringList">TStringList</method> object does not own the objects you add this way. Objects added to the <method namespace="Classes" class="TStringList">TStringList</method> object still exist even if the <method namespace="Classes" class="TStringList">TStringList</method> instance is destroyed. They must be explicitly destroyed by the application.</para>
<para>For sorted lists, <method namespace="Classes" class="TStringList">AddObject</method> raises an EListError exception if the string S already appears in the list and Duplicates is set to dupError. If Duplicates is set to dupIgnore, trying to add a duplicate string causes <method namespace="Classes" class="TStringList">AddObject</method> to return the index of the existing entry.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Find">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Locates the index for a string in a sorted list and indicates whether a string with that value already exists in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStringList">Find</method> to obtain the index in a sorted list where the string S should be added. If the string S, or a string that differs from S only in case when CaseSensitive is false, already exists in the list, <method namespace="Classes" class="TStringList">Find</method> returns true. If the list does not contain a string that matches S, <method namespace="Classes" class="TStringList">Find</method> returns false. The index where S should go is returned in the Index parameter. The value of Index is zero-based, where the first string has the index 0, the second string has the index 1, and so on.</para>
<para>Only use <method namespace="Classes" class="TStringList">Find</method> with sorted lists. For unsorted lists, use the IndexOf method instead.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.IndexOf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the position of a string in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">IndexOf</method> to obtain the position of the first occurrence of a string that matches S. A string matches S if it is identical to S or, if CaseSensitive is false, if it differs only in case. </para>
<method namespace="Classes" class="TStringList">IndexOf</method> returns the 0-based index of the string. Thus, if S matches the first string in the list, <method namespace="Classes" class="TStringList">IndexOf</method> returns 0, if S is the second string, <method namespace="Classes" class="TStringList">IndexOf</method> returns 1, and so on. If the string does not have a match in the string list, <method namespace="Classes" class="TStringList">IndexOf</method> returns -1.</para>
</comments>
</member>
<member name="M:Classes.Classes.Clear">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Deletes all the strings from the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call clear to empty the list of strings. All references to associated objects are also removed. However, the objects themselves are not freed.</para>
</comments>
</member>
<member name="M:Classes.Classes.Delete">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Removes the string specified by the Index parameter.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">Delete</method> to remove a single string from the list. If an object is associated with the string, the reference to the object is removed as well. Index gives the position of the string, where 0 is the first string, 1 is the second string, and so on.</para>
</comments>
</member>
<member name="M:Classes.Classes.Exchange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Swaps the position of two strings in the list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">Exchange</method> to rearrange the strings in the list. The strings are specified by their index values in the Index1 and Index2 parameters. Indexes are zero-based, so the first string in the list has an index value of 0, the second has an index value of 1, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If either string has an associated object, <method namespace="Classes" class="TStringList">Exchange</method> changes the index of the object as well.</para>
<para>Do not call <method namespace="Classes" class="TStringList">Exchange</method> on a sorted list except to swap two identical strings with different associated objects. <method namespace="Classes" class="TStringList">Exchange</method> does not check whether the list is sorted, and can destroy the sort order of a sorted list.</para>
<method namespace="Classes" class="TStringList">Insert</method>s a string to the list at the position specified by Index.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">Insert</method> to add the string S to the list at the position specified by Index. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the string has an associated object, use the <method namespace="Classes" class="TStringList">Insert</method>Object method instead.</para>
<para>If the list is sorted, calling <method namespace="Classes" class="TStringList">Insert</method> or <method namespace="Classes" class="TStringList">Insert</method>Object will raise an EListError exception. Use Add or AddObject with sorted lists.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.InsertObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Inserts a string into the list at the specified position, and associates it with an object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">InsertObject</method> to insert the string S into the list at the position identified by Index, and associate it with the object AObject. If Index is 0, the string is inserted at the beginning of the list. If Index is 1, the string is put in the second position of the list, and so on.</para>
<method namespace="Classes" class="TStringList">Sort</method>s the strings in the list in ascending order.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringList">Sort</method> to sort the strings in a list that has the <method namespace="Classes" class="TStringList">Sort</method>ed property set to false. String lists with the <method namespace="Classes" class="TStringList">Sort</method>ed property set to true are automatically sorted.</para>
<method namespace="Classes" class="TStringList">Sort</method> uses AnsiCompareStr to sort the strings when CaseSensitive is true and AnsiCompareText when CaseSensitive is false. To provide your own comparison operator instead, use the Custom<method namespace="Classes" class="TStringList">Sort</method> method.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.CustomSort">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sorts the strings in the list in a customized order.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStringList">CustomSort</method> to sort the strings in the list, where the sort order is defined by the Compare parameter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Supply a value for the Compare function that compares two strings in the string list. The List parameter provides access to the string list, while the Index1 and Index2 parameters identify the strings to be compared.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not pass nil (Delphi) or NULL (C++) as the value of the Compare parameter.</para>
<para>You must explicitly call the <method namespace="Classes" class="TStringList">CustomSort</method> method. Setting the Sorted property only sorts strings using ANSI (Windows) or UTF-8 (Linux) order, as implemented in the Sort method.</para>
<method namespace="Classes" class="TStringList">Destroy</method>s an instance of <method namespace="Classes" class="TStringList">TStringList</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TStringList">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="Classes" class="TStringList">TStringList</method> reference is not nil and only then calls <method namespace="Classes" class="TStringList">Destroy</method>.</para>
<method namespace="Classes" class="TStringList">Destroy</method> frees the memory allocated to hold the list of strings and object references before calling the inherited destructor.</para>
</comments>
</member>
<member name="P:Classes.Classes.Duplicates">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether duplicate strings can be added to sorted lists.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TStringList">Duplicates</property> to specify what should happen when an attempt is made to add a duplicate string to a sorted list. The CaseSensitive property controls whether two strings are considered duplicates if they are identical except for differences in case.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="Classes" class="TStringList">Duplicates</property> should be one of the following.</para>
<para>Ignore attempts to add duplicate strings to the list.</para>
</td>
</tr>
<tr>
<td>
<para>dupError</para>
</td>
<td>
<para>raise an EStringListError exception when an attempt is made to add duplicate strings to the sorted list.</para>
</td>
</tr>
<tr>
<td>
<para>dupAccept</para>
</td>
<td>
<para>Permit duplicate strings in the sorted list.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TStringList">Duplicates</property> before adding any strings to the list. Setting <property namespace="Classes" class="TStringList">Duplicates</property> to dupIgnore or dupError does nothing about duplicate strings that are already in the list.</para>
<property namespace="Classes" class="TStringList">Duplicates</property> does nothing if the list is not sorted.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.Sorted">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether the strings in the list should be automatically sorted.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TStringList">Sorted</property> to true to cause the strings in the list to be automatically sorted in ascending order. Set <property namespace="Classes" class="TStringList">Sorted</property> to false to allow strings to remain where they are inserted. When <property namespace="Classes" class="TStringList">Sorted</property> is false, the strings in the list can be put in ascending order at any time by calling the Sort method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="Classes" class="TStringList">Sorted</property> is true, do not use Insert to add strings to the list. Instead, use Add, which will insert the new strings in the appropriate position. When <property namespace="Classes" class="TStringList">Sorted</property> is false, use Insert to add strings to an arbitrary position in the list, or Add to add strings to the end of the list.</para>
<para>The CaseSensitive property controls whether the strings in the list are sorted based on a case-sensitive or case-insensitive comparison. The sort order takes into account the locale of the system on which the application is running. </para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.CaseSensitive">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Controls whether strings are located, sorted, and identified as duplicates in a case-sensitive or case-insensitive manner.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStringList">CaseSensitive</property> to indicate whether strings in the list should be compared in a case-sensitive or case-insensitive manner. Set <property namespace="Classes" class="TStringList">CaseSensitive</property> to true to make the string list locate, check for duplicates, and sort its strings in a case-sensitive manner. Set <property namespace="Classes" class="TStringList">CaseSensitive</property> to false to make the string list perform these operations case-insensitively.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnChange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after the list of strings changes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TStringList">OnChange</event> event handler to respond to changes in the list of strings. For example, if the string list is associated with a control, the <event namespace="Classes" class="TStringList">OnChange</event> event handler could tell the control to repaint itself whenever the content of the list changes.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Whenever strings in the list are added, deleted, moved, or modified, the following events take place:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1An OnChanging event occurs before the change.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2The strings are added, deleted, moved, or modified.</para>
<event namespace="Classes" class="TStringList">OnChange</event> occurs for every change made to the list, regardless of whether the application calls BeginUpdate and EndUpdate around a series of changes.</para>
</note>
</comments>
</member>
<member name="E:Classes.Classes.OnChanging">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately before the list of strings changes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TStringList">OnChanging</event> event handler to prepare for changes in the list of strings. For example, if the string list is associated with a control, the <event namespace="Classes" class="TStringList">OnChanging</event> event handler could tell the control to disable repaints until the OnChange event when the list has finished changing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Whenever strings in the list are added, deleted, moved, or modified, the following events take place:</para>
<event namespace="Classes" class="TStringList">OnChanging</event> occurs for every change made to the list, regardless of whether the application calls BeginUpdate and EndUpdate around a series of changes.</para>
<class namespace="Classes">TStream</class> is the base class type for stream objects that can read from or write to various kinds of storage media, such as disk files, dynamic memory, and so on.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use specialized stream objects to read from, write to, or copy information stored in a particular medium. Each descendant of <class namespace="Classes">TStream</class> implements methods for transferring information to and from a particular storage medium, such as a disk file, dynamic memory, and so on. In addition to methods for reading, writing, and copying bytes to and from the stream, stream objects permit applications to seek to an arbitrary position in the stream. Properties of <class namespace="Classes">TStream</class> provide information about the stream, such as its size and the current position in the stream.</para>
<class namespace="Classes">TStream</class> also introduces methods that work in conjunction with components and filers for loading and saving components in simple and inherited forms. These methods are called automatically by global routines that initiate component streaming. They can also be called directly to initiate the streaming process. Note, however, that component streaming always involves two additional objects:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A component object that is passed as a parameter to the stream's methods.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A filer object that is automatically created by the stream, and associated with the stream.</para>
<class namespace="Classes">TStream</class> is an abstract or, in C++ terminology, pure virtual class. It should not be instantiated; it relies on abstract or pure virtual methods that must be overridden in descendant classes. Descendant stream objects, such as memory and file streams used for component streaming, are created automatically by the global functions ReadComponentRes and WriteComponentRes. For streaming other kinds of information, choose a descendant class according to the specific data and storage needs. These include</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TFileStream (for working with files)</para>
<condition os="Windows"> (for using a COM interface to read and write)</condition>
</para>
</comments>
</member>
<member name="M:Classes.Classes.Read">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract or pure virtual method responsible for reading from the stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each descendant stream object defines a <method namespace="Classes" class="TStream">Read</method> method that reads data from its particular storage medium (such as memory or a disk file).</para>
<method namespace="Classes" class="TStream">Read</method> is used in cases where the number of bytes to read from the stream is not necessarily fixed. It attempts to read up to Count bytes into buffer and returns the number of bytes actually read.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All the other data-reading methods of a stream (<method namespace="Classes" class="TStream">Read</method>Buffer, <method namespace="Classes" class="TStream">Read</method>Component) call <method namespace="Classes" class="TStream">Read</method> to do their actual reading.</para>
</comments>
</member>
<member name="M:Classes.Classes.Write">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces a pure virtual method for writing to the stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each descendant stream object defines a <method namespace="Classes" class="TStream">Write</method> method that writes data to its particular storage medium (such as memory or a disk file). <method namespace="Classes" class="TStream">Write</method> attempts to write up to Count bytes from Buffer, and returns the number of bytes actually written.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All the other data-writing methods of a stream (<method namespace="Classes" class="TStream">Write</method>Buffer, <method namespace="Classes" class="TStream">Write</method>Component) call <method namespace="Classes" class="TStream">Write</method> to do their actual writing.</para>
</comments>
</member>
<member name="M:Classes.Classes.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves to a specified position in the streamed resource.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStream">Seek</method> to move the current position of the stream in its particular storage medium (such as memory or a disk file).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:</para>
<para>As implemented in <method namespace="Classes" class="TStream">TStream</method>, the two versions (the 32-bit or 64-bit syntax) call each other. Descendant stream classes must override at least one of these versions, and the override must not call the inherited default implementation.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.CopyFrom">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies a specified number of bytes from one stream to another.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStream">CopyFrom</method> to copy data to the stream from a different stream. Using <method namespace="Classes" class="TStream">CopyFrom</method> eliminates the need for the user to create, read into, write from, and free a buffer when copying data.</para>
<method namespace="Classes" class="TStream">CopyFrom</method> copies Count bytes from the stream specified by Source into the stream. It then moves the current position by Count bytes, and returns the number of bytes copied. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Count is 0, <method namespace="Classes" class="TStream">CopyFrom</method> sets Source position to 0 before reading and then copies the entire contents of Source into the stream. If Count is greater than or less than 0, <method namespace="Classes" class="TStream">CopyFrom</method> reads from the current position in Source.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initiates streaming of components and their properties.</para>
<method namespace="Classes" class="TStream">ReadComponent</method> is called indirectly by the global routine <method namespace="Classes" class="TStream">ReadComponent</method>Res, by the <method namespace="Classes" class="TStream">ReadComponent</method>Res method, or it can be called directly to initiate component streaming.</para>
<method namespace="Classes" class="TStream">ReadComponent</method> reads data values from the stream and assigns them to Instance's properties. It then constructs a reader object and calls the reader's ReadRootComponent method to read Instance's property values and construct child objects defined in the stream as children of the Instance. <method namespace="Classes" class="TStream">ReadComponent</method> returns the component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Instance is nil (Delphi) or NULL (C++), <method namespace="Classes" class="TStream">ReadComponent</method> constructs a component based on the type information in the stream and returns the newly-constructed component.</para>
<method namespace="Classes" class="TStream">ReadComponentRes</method> is called automatically by the global routine <method namespace="Classes" class="TStream">ReadComponentRes</method>File. It can also be called directly if the current position of the stream points to a component written using the WriteComponentRes method.</para>
<method namespace="Classes" class="TStream">ReadComponentRes</method>File creates a file stream object, which then calls its <method namespace="Classes" class="TStream">ReadComponentRes</method> method.</para>
<method namespace="Classes" class="TStream">ReadComponentRes</method> first calls the ReadResHeader method to read a resource header from the stream. If the stream does not contain a resource header at the current position, ReadResHeader will raise an EInvalidImage exception. <method namespace="Classes" class="TStream">ReadComponentRes</method> then calls ReadComponent to read the properties that must be set on Instance.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetSize">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides a placeholder for a method to change the size of the streamed resource.</para>
<method namespace="Classes" class="TStream">SetSize</method> does nothing in <method namespace="Classes" class="TStream">TStream</method>. Descendant stream classes can override this method to set the Size property of their objects. <method namespace="Classes" class="TStream">SetSize</method> is the write procedure for the Size property. </para>
<method namespace="Classes" class="TStream">SetSize</method> is introduced in <method namespace="Classes" class="TStream">TStream</method>, even though it does nothing, because it is not possible to change the definition of a property in a descendant class. <method namespace="Classes" class="TStream">SetSize</method> must therefore be introduced when Size is introduced.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.ReadBuffer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads bytes from the stream into Buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStream">ReadBuffer</method> to read Count bytes from the stream into a buffer in cases where the number of bytes is known and fixed, for example when reading in structures. <method namespace="Classes" class="TStream">ReadBuffer</method> is used internally for loading from a stream and copying from a stream.</para>
<method namespace="Classes" class="TStream">ReadBuffer</method> calls Read to do the actual reading. If Count bytes cannot be read from the stream, an EReadError exception is raised.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteBuffer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes Count bytes from Buffer onto the stream and advances the current position of the stream by Count bytes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStream">WriteBuffer</method> to save data to a stream. <method namespace="Classes" class="TStream">WriteBuffer</method> and ReadBuffer are used in cases where the number of bytes is known and required, for example when reading in structures. Use <method namespace="Classes" class="TStream">WriteBuffer</method> for standard file I/O streaming.</para>
<method namespace="Classes" class="TStream">WriteBuffer</method> is used internally for writing to a stream and copying from a stream. It is used by other objects, such as strings and lists, for writing strings stored in a buffer.</para>
<method namespace="Classes" class="TStream">WriteBuffer</method> calls Write to handle the actual writing. If the stream fails to write all the requested bytes, an EWriteError exception is raised.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initiates the writing of components and their properties to a stream.</para>
<method namespace="Classes" class="TStream">WriteComponent</method> is used internally in the component streaming system, but can also be called directly when writing components to memory streams or database blobs.</para>
<method namespace="Classes" class="TStream">WriteComponent</method> constructs a writer object and calls its WriteRootComponent method to write the component specified by Instance, and its owned objects, to the stream.</para>
<method namespace="Classes" class="TStream">WriteComponentRes</method> is used internally in the streaming system, but can also be called directly when sending data to other applications on disk. <method namespace="Classes" class="TStream">WriteComponentRes</method> is used for streaming components that need data, such as a bitmap or icon to be stored in a resource-file format.</para>
<method namespace="Classes" class="TStream">WriteComponentRes</method> calls WriteDescendentRes, passing in nil (Delphi) or NULL (C++) as the Ancestor. Therefore, WriteDescendentRes initiates the remainder of the streaming process for a component that, in this case, is not a descendant.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To read a component written with <method namespace="Classes" class="TStream">WriteComponentRes</method>, call the ReadComponentRes method.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteDescendent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Streams components and their properties in inherited forms. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TStream">WriteDescendent</method> directly. <method namespace="Classes" class="TStream">WriteDescendent</method> is called automatically by WriteComponent.</para>
<method namespace="Classes" class="TStream">WriteDescendent</method> constructs a writer object, then calls the writer object's <method namespace="Classes" class="TStream">WriteDescendent</method> method to write the component passed in Instance to the stream. Instance is either an inherited form descended from Ancestor or nil (Delphi) or NULL (C++). However, <method namespace="Classes" class="TStream">WriteDescendent</method> is never used to write owned components, only to initiate streaming on the root component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Streams components and their properties in inherited forms. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TStream">WriteDescendentRes</method> directly. <method namespace="Classes" class="TStream">WriteDescendentRes</method> is called automatically by WriteComponentRes.</para>
<method namespace="Classes" class="TStream">WriteDescendentRes</method> writes a resource-file header to the stream, using the resource name passed in ResName as the name of the resource. It then calls WriteDescendent to write Instance to the stream as a descendant of Ancestor.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes a resource-file header to the stream. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TStream">WriteResourceHeader</method>, it is used internally. The WriteDescendentRes method calls <method namespace="Classes" class="TStream">WriteResourceHeader</method> before writing a component to the stream. This method writes the resource-file header, using the value passed as ResName for the name of the resource. It returns a position in FixupInfo that must be used to adjust the header after the size of the resource is known. WriteDescendentRes calls FixupResourceHeader with the value returned as FixupInfo after streaming out the component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Patches the resource header for a resource that has been written to the stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TStream">FixupResourceHeader</method>, it is used internally. The WriteDescendentRes method calls <method namespace="Classes" class="TStream">FixupResourceHeader</method> after writing a component to the stream. This method then uses the current position to determine the size of the resource just written and adjust the resource header accordingly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The FixupInfo parameter is the value returned by WriteResourceHeader when it writes the resource header (before WriteDescendentRes streams out the component).</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadResHeader">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a resource-file header from the stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TStream">ReadResHeader</method> directly. It is called automatically by ReadComponentRes before reading a component from a resource file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After reading the resource-file header, <method namespace="Classes" class="TStream">ReadResHeader</method> moves the current position of the stream to just beyond the header. If the stream does not contain a valid resource-file header, <method namespace="Classes" class="TStream">ReadResHeader</method> raises an EInvalidImage exception.</para>
</comments>
</member>
<member name="P:Classes.Classes.Position">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the current offset into the stream for reading and writing.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStream">Position</property> to obtain the current position of the stream. This is the number of bytes from the beginning of the streamed data.</para>
</comments>
</member>
<member name="P:Classes.Classes.Size">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the size in bytes of the stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStream">Size</property> to find the size of the stream. <property namespace="Classes" class="TStream">Size</property> is used internally in routines that read and write to and from the stream. Setting the <property namespace="Classes" class="TStream">Size</property> property of <property namespace="Classes" class="TStream">TStream</property> does nothing. Some descendants of <property namespace="Classes" class="TStream">TStream</property> override this property to allow applications to change the size of the resource accessed using the stream. </para>
<class namespace="Classes">THandleStream</class> enables applications to read from and write to communications resources identified by a handle.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">THandleStream</class> to access files, sockets, named pipes, mailslots, or other communications resources that provide a handle when opened. For example, the FileOpen function provides a handle for a file on disk. <class namespace="Classes">THandleStream</class> allows applications to use a uniform stream interface when performing I/O using a handle.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To avoid the overhead of managing file handles, use TFileStream to work with disk files.</para>
<method namespace="Classes" class="THandleStream">Read</method>s up to Count bytes of data from the resource associated with the handle stream into Buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="THandleStream">Read</method> to read data from the resource associated with the handle stream when the number of bytes in the file is not known. <method namespace="Classes" class="THandleStream">Read</method> transfers up to Count bytes from the resource, starting at the current position, and then advances the current position in the resource by the number of bytes actually transferred. <method namespace="Classes" class="THandleStream">Read</method> returns the number of bytes actually transferred, which may be less than Count if the end of file marker is encountered.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All other data-reading methods of a handle stream (<method namespace="Classes" class="THandleStream">Read</method>Buffer, <method namespace="Classes" class="THandleStream">Read</method>Component) call <method namespace="Classes" class="THandleStream">Read</method> to do the actual reading.</para>
<method namespace="Classes" class="THandleStream">Write</method>s Count bytes from the Buffer to the current position in the resource.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="THandleStream">Write</method> to write Count bytes to the resource associated with the handle stream, starting at the current position. After writing to the resource, <method namespace="Classes" class="THandleStream">Write</method> advances the current position by the number bytes written, and returns the number of bytes written.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All other data-writing methods of a handle stream (<method namespace="Classes" class="THandleStream">Write</method>Buffer, <method namespace="Classes" class="THandleStream">Write</method>Component) call <method namespace="Classes" class="THandleStream">Write</method> to do the actual writing.</para>
</comments>
</member>
<member name="M:Classes.Classes.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Resets the current position of the handle stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="THandleStream">Seek</method> to move the current position within the resource associated with the handle stream by the indicated offset. <method namespace="Classes" class="THandleStream">Seek</method> allows an application to read from or write to a particular location within the resource.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:</para>
<method namespace="Classes" class="THandleStream">Seek</method> returns the new value of the Position property, the new current position in the resource.</para>
<method namespace="Classes" class="THandleStream">Create</method>s an instance of <method namespace="Classes" class="THandleStream">THandleStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="THandleStream">Create</method> to instantiate a <method namespace="Classes" class="THandleStream">THandleStream</method> for a given handle.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The handle must be obtained by opening or creating the resource in the appropriate mode. For example, to create a handle stream for reading from a file, obtain the file handle by opening the file with an fmOpenRead or fmOpenReadWrite mode. To create a handle stream for writing to a file, obtain the file handle by opening the file with an fmOpenWrite or fmOpenReadWrite mode.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetSize">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the end of file marker to truncate the resource at the indicated position.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="THandleStream">SetSize</method> to set the size of the resource. <method namespace="Classes" class="THandleStream">SetSize</method> calls Seek to go to the indicated position, and then writes an end of file marker. If the size of the resource can not be changed, an exception is raised. For example, calling <method namespace="Classes" class="THandleStream">SetSize</method> for a file handle that was opened in fmOpenRead mode will raise an exception.</para>
</comments>
</member>
<member name="P:Classes.Classes.Handle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the handle for the communications resource the stream reads from and writes to.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Classes" class="THandleStream">Handle</property> to get the handle for file management functions. To read from or write to the resource, use the methods of the T<property namespace="Classes" class="THandleStream">Handle</property>Stream object.</para>
<property namespace="Classes" class="THandleStream">Handle</property> is a read-only property. The handle property cannot be changed to allow the handle stream to switch from reading to writing or vice versa. For example, to change from a file handle that is opened in read-only mode to one that is opened in write mode:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1Free the stream object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2Call FileClose to close the file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3Reopen the file in write mode, and use the handle to create a new instance of a handle stream. Alternately, open a TFileStream object for the file, specifying a write mode for the stream.</para>
<para>Do not call the FileClose function on the <property namespace="Classes" class="THandleStream">Handle</property> until after the T<property namespace="Classes" class="THandleStream">Handle</property>Stream object has been destroyed.</para>
<class namespace="Classes">TFileStream</class> enables applications to read from and write to a file on disk.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">TFileStream</class> to access the information in disk files. <class namespace="Classes">TFileStream</class> will open a named file and provide methods to read from or write to it. If an application already has a handle to the file, opened in the appropriate mode, use THandleStream instead.</para>
<method namespace="Classes" class="TFileStream">Create</method>s an instance of <method namespace="Classes" class="TFileStream">TFileStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TFileStream">Create</method> to instantiate a file stream for reading from or writing to the named file. Specify the name of the file and the way the file should be opened as parameters.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Mode parameter indicates how the file is to be opened. The Mode parameter consists of an open mode and (possibly) a share mode or'ed together. The open mode must be one of the following values:</para>
<para>Sharing is compatible with the way FCBs are opened.</para>
</td>
</tr>
<tr>
<td>
<para>fmShareExclusive</para>
</td>
<td>
<para>Other applications can not open the file for any reason.</para>
</td>
</tr>
<tr>
<td>
<para>fmShareDenyWrite</para>
</td>
<td>
<para>Other applications can open the file for reading but not for writing.</para>
</td>
</tr>
<tr>
<td>
<para>fmShareDenyRead</para>
</td>
<td>
<para>Other applications can open the file for writing but not for reading.</para>
</td>
</tr>
<tr>
<td>
<para>fmShareDenyNone</para>
</td>
<td>
<para>No attempt is made to prevent other applications from reading from or writing to the file.</para>
</td>
</tr>
</table>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Rights parameter indicates the permission bits with which to create the file on Linux when Mode is fm<method namespace="Classes" class="TFileStream">Create</method>. Rights is ignored when used on the Windows platform.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the file can not be opened, <method namespace="Classes" class="TFileStream">Create</method> raises an exception.</para>
<method namespace="Classes" class="TFileStream">Destroy</method>s an instance of <method namespace="Classes" class="TFileStream">TFileStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TFileStream">Destroy</method> directly in an application. Instead, call Free, which checks that the <method namespace="Classes" class="TFileStream">TFileStream</method> reference is not nil and only then calls <method namespace="Classes" class="TFileStream">Destroy</method>.</para>
<class namespace="classes">TCustomMemoryStream</class> is an abstract base class used as the common ancestor for memory streams.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="classes">TCustomMemoryStream</class> as a base class when defining a stream object that can transfer data that is stored in memory. Memory streams are useful for providing file-like access to data that is stored in a less accessible medium. Data can be moved to an internal memory buffer when the memory stream is created. After manipulating the data in a memory stream, the data can be written out to its actual storage medium when the memory stream is destroyed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not instantiate an instance of <class namespace="classes">TCustomMemoryStream</class>. It is an abstract class that implements behavior common to all memory streams. To work with an instance of a memory stream, use one of the descendants of <class namespace="classes">TCustomMemoryStream</class>, such as TMemoryStream or TResourceStream.</para>
<method namespace="classes" class="TCustomMemoryStream">Read</method>s up to Count bytes from the memory stream into Buffer and advances the current position of the stream by the number of bytes read.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="classes" class="TCustomMemoryStream">Read</method> to read the contents of the memory stream into a buffer, starting at the current position. <method namespace="classes" class="TCustomMemoryStream">Read</method> will read up to Count bytes from the current position in Memory. If Count bytes extends beyond the end of the memory buffer, <method namespace="classes" class="TCustomMemoryStream">Read</method> will only transfer the data up to the end of the associated memory buffer. <method namespace="classes" class="TCustomMemoryStream">Read</method> returns the number of bytes actually transferred to Buffer, and advances the current position accordingly. If the return value is less than Count, it means that reading reached the end of the stream data.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All the other data-reading methods of the memory stream (<method namespace="classes" class="TCustomMemoryStream">Read</method>Buffer, <method namespace="classes" class="TCustomMemoryStream">Read</method>Component) call <method namespace="classes" class="TCustomMemoryStream">Read</method> to do the actual reading.</para>
<method namespace="classes" class="TCustomMemoryStream">Read</method> treats Count as an upper bound. The <method namespace="classes" class="TCustomMemoryStream">Read</method>Buffer method, by contrast, raises an exception if Count bytes cannot be read.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves the current position of the stream by Offset bytes, relative to the origin specified by Origin.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="classes" class="TCustomMemoryStream">Seek</method> to move the current position within the memory stream by the indicated offset. <method namespace="classes" class="TCustomMemoryStream">Seek</method> allows an application to read from or write to a particular location within the Memory associated with the memory stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Offset is a negative number, the seek is backward from the specified origin. The following table shows the different values of Origin and their meanings for seeking.</para>
<method namespace="classes" class="TCustomMemoryStream">Seek</method> does no error checking on the value provided for Offset. Do not call seek with an offset that would move the current position less than 0 (before the start of Memory) or greater than Size (beyond the end of the memory buffer).</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.SetPointer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Replaces the memory buffer associated with the memory stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="classes" class="TCustomMemoryStream">SetPointer</method> to set the internal memory buffer, Memory, to be the value passed in by Ptr. Size is the number of bytes Ptr points to.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants of <method namespace="classes" class="TCustomMemoryStream">TCustomMemoryStream</method> should use <method namespace="classes" class="TCustomMemoryStream">SetPointer</method> to associate the memory stream with the memory buffer that holds the data for the memory stream.</para>
<method namespace="classes" class="TCustomMemoryStream">SetPointer</method> does not free the existing value of Memory, if any, when it replaces the memory buffer. Descendants of <method namespace="classes" class="TCustomMemoryStream">TCustomMemoryStream</method> that use <method namespace="classes" class="TCustomMemoryStream">SetPointer</method> to replace the stream's memory pool should free the memory pointed to by the Memory property before calling <method namespace="classes" class="TCustomMemoryStream">SetPointer</method> to replace the memory buffer.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.SaveToStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the entire contents of the memory stream to the stream object specified by Stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="classes" class="TCustomMemoryStream">SaveToStream</method> to copy data that is stored in memory into another storage medium. <method namespace="classes" class="TCustomMemoryStream">SaveToStream</method> writes the entire contents of Memory into the indicated stream object, starting at the current position in the stream that was passed as a parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the Stream parameter is a TFileStream object, <method namespace="classes" class="TCustomMemoryStream">SaveToStream</method> does much the same thing as the SaveToFile method. However, <method namespace="classes" class="TCustomMemoryStream">SaveToStream</method> writes to the current position in the target stream. Thus, for example, <method namespace="classes" class="TCustomMemoryStream">SaveToStream</method> can be used to append the contents of Memory to a file stream, rather than replace the contents of the file the way SaveToFile does.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the entire contents of the memory stream cannot be written to the target stream, <method namespace="classes" class="TCustomMemoryStream">SaveToStream</method> raises an EWriteError exception.</para>
</comments>
</member>
<member name="M:Classes.Classes.SaveToFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the entire contents of the memory stream to the file with a given file name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="classes" class="TCustomMemoryStream">SaveToFile</method> to write the contents of Memory to a file. <method namespace="classes" class="TCustomMemoryStream">SaveToFile</method> allows an application to write out the contents of the memory stream without having to explicitly create and free a file stream object. If the named file cannot be created or opened, <method namespace="classes" class="TCustomMemoryStream">SaveToFile</method> raises an EFCreateError exception.</para>
</comments>
</member>
<member name="P:Classes.Classes.Memory">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides direct access to the memory pool allocated for the memory stream. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="classes" class="TCustomMemoryStream">Memory</property> to get access to the memory for the stream. The memory for the stream holds the data that is being transferred by means of the memory stream. Size is the number of bytes of <property namespace="classes" class="TCustomMemoryStream">Memory</property> that were allocated, and Position is the current position within <property namespace="classes" class="TCustomMemoryStream">Memory</property>.</para>
<property namespace="classes" class="TCustomMemoryStream">Memory</property> is a read-only property. <property namespace="classes" class="TCustomMemoryStream">Memory</property> can be used to change the contents of the memory, but to set the actual memory the stream works with, descendants of TCustom<property namespace="classes" class="TCustomMemoryStream">Memory</property>Stream must assign a pointer to a memory buffer by calling the SetPointer method.</para>
<class namespace="Classes">TMemoryStream</class> is a stream that stores its data in dynamic memory.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">TMemoryStream</class> to store data in a dynamic memory buffer that is enhanced with file-like access capabilities. <class namespace="Classes">TMemoryStream</class> provides the general I/O capabilities of a stream object while introducing methods and properties to manage a dynamic memory buffer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Memory streams are useful as intermediary objects that can hold information as well as read it from or write it to another storage medium. They provide a useful format for comparing the contents of streams, or for manipulating data that is stored in a less accessible medium.</para>
<method namespace="Classes" class="TMemoryStream">Write</method>s Count bytes from Buffer to the current position in the memory buffer and updates the current position by Count bytes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TMemoryStream">Write</method> to insert Count bytes into the memory buffer of the memory stream, starting at the current position. <method namespace="Classes" class="TMemoryStream">Write</method> will increase the size of the memory buffer, if necessary, to accommodate the data being written in. If the current position is not the end of the memory buffer, <method namespace="Classes" class="TMemoryStream">Write</method> will overwrite the data following the current position.</para>
<method namespace="Classes" class="TMemoryStream">Write</method> updates the Size property to Position + Count, and sets the Position property to the new value of Size. Thus, any data that was stored in the memory stream in the Count bytes after the current position is lost when calling <method namespace="Classes" class="TMemoryStream">Write</method>.</para>
<method namespace="Classes" class="TMemoryStream">Write</method> always writes the Count bytes in the Buffer, unless there is a memory failure. Thus, for <method namespace="Classes" class="TMemoryStream">TMemoryStream</method>, <method namespace="Classes" class="TMemoryStream">Write</method> is equivalent to the <method namespace="Classes" class="TMemoryStream">Write</method>Buffer method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All other data-writing methods of a memory stream (<method namespace="Classes" class="TMemoryStream">Write</method>Buffer, <method namespace="Classes" class="TMemoryStream">Write</method>Component) call <method namespace="Classes" class="TMemoryStream">Write</method> to do the actual writing.</para>
</comments>
</member>
<member name="M:Classes.Classes.Clear">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees the memory buffer, discarding all data associated with the memory stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TMemoryStream">Clear</method> to empty the memory buffer for the memory stream and free all associated memory. In addition to freeing the memory associated with the memory buffer, <method namespace="Classes" class="TMemoryStream">Clear</method>
</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the Memory property to nil (Delphi) or NULL (C++).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the Position property to 0.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the Size property to 0.</para>
</comments>
</member>
<member name="M:Classes.Classes.LoadFromStream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Loads the entire contents of a stream into the memory buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TMemoryStream">LoadFromStream</method> to fill the memory stream with the contents of the stream specified by the Stream parameter. <method namespace="Classes" class="TMemoryStream">LoadFromStream</method> always sets the Position of the source stream to 0, before streaming in the number of bytes indicated by the source stream's Size property.</para>
<method namespace="Classes" class="TMemoryStream">LoadFromStream</method> reallocates the memory buffer so that the contents of the source stream will exactly fit. It sets the Size property accordingly, and then reads the entire contents of the source stream into the memory buffer. Thus, <method namespace="Classes" class="TMemoryStream">LoadFromStream</method> will discard any pre-existing data stored in the memory stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the source stream is a TFileStream object, <method namespace="Classes" class="TMemoryStream">LoadFromStream</method> does the same thing as LoadFromFile, except that the application must create and free the TFileStream object. <method namespace="Classes" class="TMemoryStream">LoadFromStream</method> also allows applications to fill a memory stream object from other types of stream objects.</para>
</comments>
</member>
<member name="M:Classes.Classes.LoadFromFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Loads the entire contents of a file into the memory buffer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TMemoryStream">LoadFromFile</method> to fill the memory stream with the contents of a file. Pass the name of the file as the FileName parameter. <method namespace="Classes" class="TMemoryStream">LoadFromFile</method> allows an application to read the contents of a file into the memory stream without having to explicitly create and free a file stream object.</para>
<method namespace="Classes" class="TMemoryStream">LoadFromFile</method> reallocates the memory buffer so that the contents of the file will exactly fit. It sets the Size property accordingly, and then reads the entire contents of the file into the memory buffer. Thus, <method namespace="Classes" class="TMemoryStream">LoadFromFile</method> will discard any pre-existing data stored in the memory stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetSize">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the Size property of the memory stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TMemoryStream">SetSize</method> to set the Size of a memory stream before filling it with data. <method namespace="Classes" class="TMemoryStream">SetSize</method> allocates the memory buffer to hold NewSize bytes, preserving as much of the existing data as possible.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TMemoryStream">SetSize</method> before filling the memory buffer with data from various sources, or from a portion of another stream. If the intended contents of the memory stream is exactly the same as the contents of another stream or file, use LoadFromStream or LoadFromFile instead.</para>
<method namespace="Classes" class="TMemoryStream">Destroy</method>s an instance of <method namespace="Classes" class="TMemoryStream">TMemoryStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TMemoryStream">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="Classes" class="TMemoryStream">TMemoryStream</method> reference is not nil, and only then calls <method namespace="Classes" class="TMemoryStream">Destroy</method>.</para>
<method namespace="Classes" class="TMemoryStream">Destroy</method> a <method namespace="Classes" class="TMemoryStream">TMemoryStream</method> object when it is no longer needed to store or write data. <method namespace="Classes" class="TMemoryStream">Destroy</method> calls Clear to free the memory buffer before calling the inherited destructor.</para>
<class namespace="Classes">TStringStream</class> provides file-like access to information stored as a long string.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">TStringStream</class> to store data as a long string enhanced with I/O capabilities. <class namespace="Classes">TStringStream</class> is useful as an intermediary object that can hold text as well as read it from or write it to another storage medium. <class namespace="Classes">TStringStream</class> provides a mechanism for manipulating text that is obtained from a less accessible medium.</para>
<method namespace="Classes" class="TStringStream">Read</method>s up to Count bytes from the string stream into Buffer, and advances the current position of the stream by the number of bytes read.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStringStream">Read</method> to read the contents of the string stream into a buffer, starting at the current position. If Count extends beyond the end of the DataString, <method namespace="Classes" class="TStringStream">Read</method> will only transfer the characters up to the end of the DataString, and advances the current position accordingly. If the return value is less than Count, it means that the end of the string was read.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TStringStream">Read</method>Buffer method and <method namespace="Classes" class="TStringStream">Read</method>Component method call <method namespace="Classes" class="TStringStream">Read</method> to do the actual reading.</para>
<method namespace="Classes" class="TStringStream">Read</method> treats Count as an upper bound. The <method namespace="Classes" class="TStringStream">Read</method>Buffer method, by contrast, raises an exception if Count bytes cannot be read.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.ReadString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a string that consists of up to Count bytes from the current position in the string stream, and advances the current position of the stream by the number of bytes read.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use Read to read the contents of the string stream into a string, starting at the current position. If Count extends beyond the end of the DataString, the returned string will only contain the characters up to the end of DataString, and the current position is advanced accordingly.</para>
<method namespace="Classes" class="TStringStream">ReadString</method> does the same thing as Read, except that it returns a string rather than filling a buffer.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves the current position in the stream by Offset bytes, relative to a specified origin.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStringStream">Seek</method> to move the current position within the string stream by the indicated offset. <method namespace="Classes" class="TStringStream">Seek</method> allows an application to read from or write to a particular location within the DataString.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If Offset is a negative number, the seek is backwards from the specified origin. The following table shows the different values of Origin and their meanings for seeking.</para>
<method namespace="Classes" class="TStringStream">Write</method> writes Count bytes from Buffer to the current position in the string stream and updates the current position by Count bytes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStringStream">Write</method> to replace the end of the string from the current position on with the first Count bytes of Buffer. <method namespace="Classes" class="TStringStream">Write</method> will change the Size property to reflect the new length of the DataString.</para>
<method namespace="Classes" class="TStringStream">Write</method> always writes Count bytes from Buffer, even if a null character is included as one of the Count bytes. Thus, <method namespace="Classes" class="TStringStream">Write</method> is equivalent to the <method namespace="Classes" class="TStringStream">Write</method>Buffer method.</para>
<method namespace="Classes" class="TStringStream">Create</method>s an instance of <method namespace="Classes" class="TStringStream">TStringStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStringStream">Create</method> to instantiate a <method namespace="Classes" class="TStringStream">TStringStream</method> object. <method namespace="Classes" class="TStringStream">Create</method> initializes the DataString property to the AString parameter.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Concatenates a specified string to the current position in the string stream, and updates the current position accordingly.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TStringStream">WriteString</method> to replace the end of the string from the current position on with the string specified by the AString parameter. <method namespace="Classes" class="TStringStream">WriteString</method> changes the Size property to reflect the new length of the DataString.</para>
</comments>
</member>
<member name="P:Classes.Classes.DataString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides direct access to the string that stores the text represented by the <property namespace="Classes" class="TStringStream">TStringStream</property> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TStringStream">DataString</property> to get access to the text of the stream. The text represents the information that is being transferred by means of the string stream. Size is the number of bytes in the string, and Position is the current position within <property namespace="Classes" class="TStringStream">DataString</property>.</para>
<property namespace="Classes" class="TStringStream">DataString</property> is a read-only property. <property namespace="Classes" class="TStringStream">DataString</property> can be used to change the contents of the string, but applications can't change the <property namespace="Classes" class="TStringStream">DataString</property> itself.</para>
<class namespace="Classes">TResourceStream</class> is a memory stream that provides access to the compiled resources in an application. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Classes">TResourceStream</class> to read the resources of an application. An instance of <class namespace="Classes">TResourceStream</class> holds the value of a single resource in a memory buffer where it is accessible to the application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The global ReadComponentRes function uses <class namespace="Classes">TResourceStream</class> to access the compiled resources used by the application.</para>
</comments>
</member>
<member name="M:Classes.Classes.Write">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Overrides the inherited method to raise an exception when an attempt is made to write the resource back to the application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications should not use a <method namespace="Classes" class="TResourceStream">TResourceStream</method> to write the resources of the running application. <method namespace="Classes" class="TResourceStream">Write</method> overrides the inherited method to raise an EStreamError exception when an application tries to write to the application's resources.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As all other data-writing methods of <method namespace="Classes" class="TResourceStream">TResourceStream</method> (<method namespace="Classes" class="TResourceStream">Write</method>Buffer, <method namespace="Classes" class="TResourceStream">Write</method>Component) call <method namespace="Classes" class="TResourceStream">Write</method> to do the actual writing, calling any of the data-writing methods of <method namespace="Classes" class="TResourceStream">TResourceStream</method> will raise an exception.</para>
<method namespace="Classes" class="TResourceStream">Create</method>s an instance of <method namespace="Classes" class="TResourceStream">TResourceStream</method> associated with a particular resource name and type.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TResourceStream">Create</method> to instantiate a <method namespace="Classes" class="TResourceStream">TResourceStream</method>, passing in parameters that identify the resource in a specified instance. <method namespace="Classes" class="TResourceStream">TResourceStream</method> finds the resource data and loads it into the Memory buffer for the <method namespace="Classes" class="TResourceStream">TResourceStream</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Instance parameter is the instance handle associated with the executable or shared library that contains the resource.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In the first constructor syntax, the ResName is the string associated with the resource in the .rc file that was compiled with the application. If the resource is associated with an integer ID rather than a string, use the string representation of the integer after a pound sign. Thus, for example, a resource with an integer identifier of 128 be identified by a ResName of #128.</para>
<para>Specifying resources by ID requires less memory than specifying resources by name.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ResType parameter is a string identifying the type of the resource. Applications can define their own resource types and identify them by name in the .rc file. In addition, there are a number of predefined resource types (which reflect Windows resource types). To identify a resource that is one of the predefined resource types, set ResType to the appropriate value from the following table:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates an instance of <method namespace="Classes" class="TResourceStream">TResourceStream</method> associated with a particular resource ID and type.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TResourceStream">CreateFromID</method> to instantiate a <method namespace="Classes" class="TResourceStream">TResourceStream</method> for a resource in the indicated instance that can be identified by an integer ID. Create finds the resource data and loads it into the Memory buffer for the <method namespace="Classes" class="TResourceStream">TResourceStream</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Instance parameter is the instance handle associated with the executable or shared library that contains the resource.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ResID is the integer ID associated with the resource in the .rc file that was compiled with the application. If the Resource was identified by a string rather than an ID number, use the Create method instead.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ResType parameter is a string identifying the type of the resource. Applications can define their own resource types and identify them by name in the .rc file. In addition, there are a number of predefined resource types (which reflect Windows resource types). To identify a resource that is one of the predefined resource types, set ResType to the appropriate value from the following table:</para>
<method namespace="Classes" class="TResourceStream">Destroy</method>s an instance of <method namespace="Classes" class="TResourceStream">TResourceStream</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TResourceStream">Destroy</method> directly in an application to destroy an instance of <method namespace="Classes" class="TResourceStream">TResourceStream</method>. Instead, call Free. Free verifies that the <method namespace="Classes" class="TResourceStream">TResourceStream</method> reference is not nil, and only then calls <method namespace="Classes" class="TResourceStream">Destroy</method>.</para>
<method namespace="Classes" class="TResourceStream">Destroy</method> frees the memory buffer that stores the resource before calling the inherited destructor.</para>
<para>The stream is an independent object with a different Owner. The object that uses the stream does not free it when it is destroyed.</para>
</td>
</tr>
<tr>
<td>
<para>soOwned</para>
</td>
<td>
<para>The stream is owned by the object that uses it (and exists solely for that object). The object that uses the stream frees the associated stream when it no longer needs to use the stream.</para>
<class namespace="Classes">TStreamAdapter</class> implements the IStream interface on a TStream object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Description<class namespace="Classes">TStreamAdapter</class> is an interfaced object that implements the IStream interface. It is associated with a TStream object in the constructor, which it uses to implement the IStream methods.</para>
<method namespace="Classes" class="TStreamAdapter">Read</method> reads up to cb bytes from the current position in the stream into the buffer pointed to by pv. pcb<method namespace="Classes" class="TStreamAdapter">Read</method> returns the number of bytes actually read.</para>
<method namespace="Classes" class="TStreamAdapter">Read</method> returns S_OK if it successfully reads pcb<method namespace="Classes" class="TStreamAdapter">Read</method> bytes into the buffer. It returns STG_E_INVALIDPOINTER it can't read because pv is nil (Delphi) or NULL (C++). It returns S_FALSE if the read operation fails for any other reason.</para>
</comments>
</member>
<member name="M:Classes.Classes.Write">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">Write</method> method.</para>
<method namespace="Classes" class="TStreamAdapter">Write</method> writes up to cb bytes from the buffer pointed to by pv into the stream, starting at the current position. pcbWritten returns the number of bytes actually written.</para>
<method namespace="Classes" class="TStreamAdapter">Write</method> returns S_OK if it successfully writes pcbWritten bytes into the stream. It returns STG_E_INVALIDPOINTER it can't write because pv is nil. It returns STG_E_CANTSAVE if the write operation fails for any other reason.</para>
</comments>
</member>
<member name="M:Classes.Classes.Seek">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">Seek</method> method.</para>
<method namespace="Classes" class="TStreamAdapter">Seek</method> moves the current position of the stream to the position specified by dlibMove and dwOrigin. The dlibMove parameter indicates a number of bytes, and dwOrigin indicates from where the bytes are measured to locate the new position. The libNewPosition parameter returns the new position of the stream.</para>
<method namespace="Classes" class="TStreamAdapter">Seek</method> returns S_OK if it successfully <method namespace="Classes" class="TStreamAdapter">Seek</method>s to the specified position. It returns STG_E_INVALIDFUNCTION if dlibMove is STREAM_SEEK_SET or STREAM_SEEK_END, because these types of seek operations are not supported by the TStream.<method namespace="Classes" class="TStreamAdapter">Seek</method> method. It returns STG_E_INVALIDPOINTER if the seek operation fails for any other reason.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetSize">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">SetSize</method> method.</para>
<method namespace="Classes" class="TStreamAdapter">SetSize</method> returns S_OK if it successfully resizes the stream to libNewSize. It returns E_FAIL if it could not resize the stream and the current size of the stream is not libNewSize on exit. It returns E_UNEXPECTED if <method namespace="Classes" class="TStreamAdapter">SetSize</method> encounters an exception while trying to set the size of the stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.CopyTo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">CopyTo</method> method.</para>
<method namespace="Classes" class="TStreamAdapter">CopyTo</method> copies up to cb bytes from the current position in the stream to the stream specified by stm. cbRead returns the number of bytes successfully read from the associated stream. cbWritten returns the number of bytes successfully written to stm.</para>
<method namespace="Classes" class="TStreamAdapter">CopyTo</method> returns S_OK if it successfully copied all the bytes read from Stream to the interface specified by stm. It returns E_FAIL if it could not write all the bytes read from Stream to stm. It returns E_UNEXPECTED if it encountered an exception while attempting to perform the copy operation.</para>
</comments>
</member>
<member name="M:Classes.Classes.Commit">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">Commit</method> method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TStreamAdapter">Commit</method> method defined by IStream commits any changes written to a stream that is participating in a transaction.</para>
<method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> does not implement any transaction support, but operates in direct mode. Because of this, <method namespace="Classes" class="TStreamAdapter">Commit</method> returns S_OK to indicate that all changes are already written, but does nothing else.</para>
</comments>
</member>
<member name="M:Classes.Classes.Revert">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">Revert</method> method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TStreamAdapter">Revert</method> method defined by IStream rolls back any changes written to a stream that is participating in a transaction.</para>
<method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> does not implement any transaction support, but operates in direct mode. Because of this, <method namespace="Classes" class="TStreamAdapter">Revert</method> returns STG_E_REVERTED, but does nothing else.</para>
</comments>
</member>
<member name="M:Classes.Classes.LockRegion">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">LockRegion</method> method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TStreamAdapter">LockRegion</method> method defined by IStream restricts access in the associated stream from the position specified by libOffset to the position specified by cb. dwLockType indicates the type of restriction imposed.</para>
<method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> does not support locking of regions, so <method namespace="Classes" class="TStreamAdapter">LockRegion</method> returns STG_E_INVALIDFUNCTION.</para>
</comments>
</member>
<member name="M:Classes.Classes.UnlockRegion">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">UnlockRegion</method> method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TStreamAdapter">UnlockRegion</method> method defined by IStream re-enables access in the associated stream that was previously restricted by a call to LockRegion. The region runs from the position specified by libOffset to the position specified by cb. dwLockType indicates the type of restriction to be released.</para>
<method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> does not support locking of regions, so <method namespace="Classes" class="TStreamAdapter">UnlockRegion</method> returns STG_E_INVALIDFUNCTION.</para>
</comments>
</member>
<member name="M:Classes.Classes.Stat">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">Stat</method> method.</para>
<method namespace="Classes" class="TStreamAdapter">Stat</method> fills out a T<method namespace="Classes" class="TStreamAdapter">Stat</method>Stg record with information about the stream object The grf<method namespace="Classes" class="TStreamAdapter">Stat</method>Flag parameter indicates what information in the record, if any, is not needed.</para>
<method namespace="Classes" class="TStreamAdapter">Stat</method> ignores the grf<method namespace="Classes" class="TStreamAdapter">Stat</method>Flag parameter. It always sets dwType to STGTY_STREAM, grfLocksSupported to LOCK_WRITE, and all of the TFileTime parameters to 0. It sets cbSize to the size of the stream, and leaves the remaining fields unchanged.</para>
<method namespace="Classes" class="TStreamAdapter">Stat</method> returns S_OK if it does not encounter any exceptions filling out statstg, E_UNEXPECTED otherwise.</para>
</comments>
</member>
<member name="M:Classes.Classes.Clone">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implements the IStream <method namespace="Classes" class="TStreamAdapter">Clone</method> method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TStreamAdapter">Clone</method> method defined by IStream returns a second IStream interface that accesses the same bytes as this IStream interface, but which operates independently (can have its own position).</para>
<method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> returns E_NOTIMPL to indicate that it does not support the <method namespace="Classes" class="TStreamAdapter">Clone</method> method.</para>
<method namespace="Classes" class="TStreamAdapter">Create</method>s an instance of a <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TStreamAdapter">Create</method> to instantiate a <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> object that implements the IStream interface using the stream object specified by Stream. Ownership initializes the StreamOwnership property, indicating whether the <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> object is responsible for freeing the stream specified by Stream from its own destructor.</para>
</comments>
</member>
<member name="M:Classes.Classes.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees the instance of <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most applications do not need to explicitly free the <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> instance. Instead, it is freed automatically when its reference count drops to 0.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If you must explicitly destroy a <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> instance, use the Free method instead of Destoy. Free checks that the <method namespace="Classes" class="TStreamAdapter">TStreamAdapter</method> reference is not nil before calling <method namespace="Classes" class="TStreamAdapter">Destroy</method>.</para>
<method namespace="Classes" class="TStreamAdapter">Destroy</method> frees the associated stream object (Stream property) if its StreamOwnership property is True.</para>
</comments>
</member>
<member name="P:Classes.Classes.Stream">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the associated T<property namespace="Classes" class="TStreamAdapter">Stream</property> object that T<property namespace="Classes" class="TStreamAdapter">Stream</property>Adapter uses to implement the I<property namespace="Classes" class="TStreamAdapter">Stream</property> interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Classes" class="TStreamAdapter">Stream</property> to directly access the T<property namespace="Classes" class="TStreamAdapter">Stream</property> object that the stream adapter represents. This object is associated with the T<property namespace="Classes" class="TStreamAdapter">Stream</property> object in the T<property namespace="Classes" class="TStreamAdapter">Stream</property>Adapter constructor.</para>
</comments>
</member>
<member name="P:Classes.Classes.StreamOwnership">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies whether the <property namespace="Classes" class="TStreamAdapter">TStreamAdapter</property> should act as the Owner of the associated stream object.</para>
<property namespace="Classes" class="TStreamAdapter">StreamOwnership</property> indicates whether the <property namespace="Classes" class="TStreamAdapter">TStreamAdapter</property> is responsible for freeing the associated stream object. </para>
<type namespace="Qt">TValueType</type> is the type used by the TReader and TWriter filer objects to type check property values that are read from and written to streams when streaming components and their properties.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The CLX filers use a tagged value system, where each value on the stream is preceded by a prefix indicating its type. Those prefixes are of type <type namespace="Qt">TValueType</type>. The following table lists the values for <type namespace="Qt">TValueType</type>:</para>
<type namespace="Qt">TFilerFlag</type> indicates information about how a filer should read or write a component and <type namespace="Qt">TFilerFlag</type>s is a set of <type namespace="Qt">TFilerFlag</type> values.</para>
<type namespace="Qt">TFilerFlag</type> values are written to form files as a prefix to saved components. They indicate any special status of the component that the streaming system must take into account. <type namespace="Qt">TFilerFlag</type>s is a set containing all the flags (if any) that pertain to a single component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The following table lists the possible <type namespace="Qt">TFilerFlag</type> values:</para>
<class namespace="Classes">TFiler</class> is the abstract base class for reader and writer objects, which are used for loading and saving components and their properties.</para>
<class namespace="Classes">TFiler</class> works with stream and component objects. It handles the internal mechanics of the streaming system that reads and writes components and their associated data. This streaming system is the mechanism by which the IDE saves components to or reads components from disk (in form files) and by which it saves and restores temporary in-memory images of components.</para>
<class namespace="Classes">TFiler</class> has two descendants, TReader and TWriter, that implement the methods introduced by <class namespace="Classes">TFiler</class>. The filer type is used as a parameter to component methods that can require either a reader or writer object, depending on whether the data is read from or written to a stream. Every filer has an associated stream that is passed as a parameter to its constructor. Filer objects are usually created by the stream that becomes associated with the filer.</para>
<class namespace="Classes">TFiler</class> properties provide support for managing the streaming of owned components. Filer objects read and write the properties of components to and from a stream. Filer objects provide buffering of data to speed read and write operations.</para>
<class namespace="Classes">TFiler</class> introduces abstract methods that are customized by its descendant reader and writer objects. These include methods that enable components to load and save hidden or complex data as if it was the value of a published property.</para>
<para>Most of the filer properties and methods have public visibility for convenience within the streaming system. The majority of them are never called directly by applications.</para>
<method namespace="Classes" class="TFiler">Create</method>s a filer object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TFiler">Create</method> to instantiate a filer descendant at runtime, if necessary. It is seldom necessary to directly create a filer object because the methods and routines that use them automatically create filers.</para>
<method namespace="Classes" class="TFiler">Create</method> allocates memory for a filer object, and associates it with the stream passed in the Stream parameter, with a buffer of size BufSize.</para>
</comments>
</member>
<member name="M:Classes.Classes.DefineProperty">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract method that allows descendants to read or write data like a property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each descendant filer object declares a <method namespace="Classes" class="TFiler">DefineProperty</method> method that defines the data that the descendant object will read or write as if the data were a property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract method that allows descendants to read and write unformatted data like a property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each descendant filer object declares a <method namespace="Classes" class="TFiler">DefineBinaryProperty</method> method that reads or writes binary data as if the data were a property.</para>
</comments>
</member>
<member name="M:Classes.Classes.FlushBuffer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an abstract method that allows descendants to synchronize the filer's buffer with its stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each descendant filer object defines a <method namespace="Classes" class="TFiler">FlushBuffer</method> method to provide practical implementations for synchronizing the filer object's buffer with the associated stream.</para>
<method namespace="Classes" class="TFiler">Destroy</method>s a filer object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TFiler">Destroy</method> directly in an application. Instead, call Free, which checks that the filer reference is not nil before calling <method namespace="Classes" class="TFiler">Destroy</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TFiler">Destroy</method> method for filer objects~<method namespace="Classes" class="TFiler">TFiler</method> frees memory associated with the buffer. Memory deallocation for the object instance is handled automatically when <method namespace="Classes" class="TFiler">Destroy</method> is called. <method namespace="Classes" class="TFiler">TFiler</method>'s <method namespace="Classes" class="TFiler">Destroy</method> method is called by descendant objects in their respective destructors.</para>
</comments>
</member>
<member name="P:Classes.Classes.Root">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which object is the root, or ultimate owner, of the objects read or written by the filer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <property namespace="Classes" class="TFiler">Root</property> directly. It is used internally to find the root object when streaming owned components. <property namespace="Classes" class="TFiler">Root</property> represents the ultimate owner of all the components being streamed during the current streaming process.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Read<property namespace="Classes" class="TFiler">Root</property>Component and Write<property namespace="Classes" class="TFiler">Root</property>Component methods set <property namespace="Classes" class="TFiler">Root</property> before reading or writing their components and owned components.</para>
</comments>
</member>
<member name="P:Classes.Classes.LookupRoot">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the root component for resolving names while loading and saving components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Filer sets <property namespace="Classes" class="TFiler">LookupRoot</property> when loading or saving components to resolve name references in nested frames. This allows the Writer to look up component names relative to a local root component, even when a frame is nested in another root component.</para>
</comments>
</member>
<member name="P:Classes.Classes.Ancestor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether to write the properties of inherited components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not use <property namespace="Classes" class="TFiler">Ancestor</property> directly. It is used internally by the methods of writer objects to write components in inherited forms.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In Visual Form Inheritance, a writer object only needs to write the values of properties that differ from those that are inherited. It tracks each component from which properties can be inherited in <property namespace="Classes" class="TFiler">Ancestor</property> and compares properties before writing. If <property namespace="Classes" class="TFiler">Ancestor</property> is nil (Delphi) or NULL (C++), there is no corresponding component from which to inherit, and the writer object writes the component out to the stream completely.</para>
<property namespace="Classes" class="TFiler">Ancestor</property> is only non-nil (Delphi) or non-NULL (C++) when writing forms created with Visual Form Inheritance. The streaming system uses WriteDescendent and WriteDescendentRes to write such forms to the stream. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When writing or overriding a DefineProperties method, be aware that <property namespace="Classes" class="TFiler">Ancestor</property> might be set, and it might be necessary to write or omit properties, as appropriate. Normally, DefineProperty read procedures ignore the value of <property namespace="Classes" class="TFiler">Ancestor</property>.</para>
</comments>
</member>
<member name="P:Classes.Classes.IgnoreChildren">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enables a writer object to save a component without saving the components it owns.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Programs rarely use <property namespace="Classes" class="TFiler">IgnoreChildren</property> directly. Programs use <property namespace="Classes" class="TFiler">IgnoreChildren</property> internally to avoid writing owned components when the Root is changed during the streaming process. A few components change Root while streaming, but this is rare.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="Classes" class="TFiler">IgnoreChildren</property> is true, the writer writes a component without writing any child components it owns. If <property namespace="Classes" class="TFiler">IgnoreChildren</property> is false, the writer object writes all owned objects to the stream.</para>
<type namespace="Qt">TComponentClass</type> is the metaclass for TComponent. Its value is the class reference for TComponent or for one of its descendants.</para>
<class namespace="Classes">IVarStreamable</class> is the interface for loading and saving the values of Variants.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Implement <class namespace="Classes">IVarStreamable</class> on a custom Variant type class to allow Variants of that type to load or save their values. When a TCustomVaraintType descendant implements the <class namespace="Classes">IVarStreamable</class> interface, then when Variants of that custom type are used as the values of published properties, their values are loaded from and saved to form files using the <class namespace="Classes">IVarStreamable</class> methods. Without the <class namespace="Classes">IVarStreamable</class> interface, the value of the Variant is loaded from and saved to form files as a string.</para>
<method namespace="Classes" class="IVarStreamable">StreamIn</method> reads the Variant's value from a stream and fills in a TVarData data structure to reflect the value.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Dest is the TVarDatathat is filled in by <method namespace="Classes" class="IVarStreamable">StreamIn</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Stream is a stream that is positioned so that the next value that can be read from the stream is the value of the Variant.</para>
</comments>
</member>
<member name="M:Classes.Classes.StreamOut">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the value of the Variant to a stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">StreamIn writes the value from a TVarData value to a specified stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Source is the TVarData that stores the data for the Variant that needs to write its value.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Stream is a stream to which <method namespace="Classes" class="IVarStreamable">StreamOut</method> writes the value stored in Source.</para>
<class namespace="Classes">TReader</class> is used internally by the component streaming system to restore the state of a component that has been written to a stream. It handles the mechanics of reading the data associated with a component from the stream. The reader object, rather than the stream object, is responsible for handling the complexities of streaming components. These include methods for:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creating component instances from class names read from the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Assigning stream data to published component properties.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enabling an object to store hidden or complex data as if they were published properties of the object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Resolving references between components, such as when a property refers to another component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Other methods and properties of <class namespace="Classes">TReader</class> trigger the reader object's events and interaction with the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications do not directly create reader objects. Readers are automatically created in a stream object's methods or in global routines that initiate the component streaming process. These include:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">the global routine ObjectBinaryToText procedure, which directly creates a reader object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">the global ReadComponentResFile function, which creates a file stream that creates a reader object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">the ReadComponent method of a stream object, which creates a reader object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once the streaming process is underway applications do not need to directly manipulate reader objects. The interaction between the reader, component, and stream objects happens automatically in methods of these objects that make calls to each other.</para>
</comments>
</member>
<member name="M:Classes.Classes.EndOfList">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the end of a group of items that are sequentially read from the stream.</para>
<method namespace="Classes" class="TReader">EndOfList</method> is used by other methods that iterate through a list of items when reading in data. It checks for a value type that signals the end of that type of data. <method namespace="Classes" class="TReader">EndOfList</method> returns true if the reader object has read to the end of a list of items.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When reading a list of items, the reader object calls ReadListBegin method, then the items are repeatedly read until <method namespace="Classes" class="TReader">EndOfList</method> returns true. Finally, the reader calls ReadListEnd.</para>
<para>Component writers can use this in their defined property ReadData methods, as, for example, with TStrings.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.NextValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the type of the next item in the reader object's stream without moving the position of the stream.</para>
<method namespace="Classes" class="TReader">NextValue</method> is used internally by reader methods to query the type of the next item in the stream. After identifying the type of the next item, <method namespace="Classes" class="TReader">NextValue</method> returns with the stream position still before the value-type indicator.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TValueType type defines the kinds of values written to and read from filer objects. CLX filers use a tagged value system, where each value on the stream is preceded by a prefix indicating its type. Those prefixes are of type TValueType.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadBoolean">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a boolean from the reader object's stream and returns that boolean value.</para>
<method namespace="Classes" class="TReader">ReadBoolean</method> is a helper method used by other reader methods to read a tagged boolean value at the current reader Position. <method namespace="Classes" class="TReader">ReadBoolean</method> uses ReadValue to check the type for a vaTrue value and returns that result. Note that <method namespace="Classes" class="TReader">ReadBoolean</method> will not verify that the value being read is a boolean, only whether or not the value is true.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadChar">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a character from the reader object's stream and returns that character value.</para>
<method namespace="Classes" class="TReader">ReadChar</method> is a helper method used by other reader methods to read a tagged character value at the current reader Position. <method namespace="Classes" class="TReader">ReadChar</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaString, ReadString checks the length. If the length indicates that the value is a char, it calls Read and returns the character. Otherwise a EReadError exception is raised.</para>
<para>If the tagged data is a string with length = 1, it is char compatible. If length > 1, it is an error, however, the rest of the string data must be read to keep the reader in a consistent state. Each action that processes tagged data must leave the reader Position at the start of the next unread tag.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.ReadComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads the component specified by Instance from the stream and returns the component.</para>
<method namespace="Classes" class="TReader">ReadComponent</method> is called by ReadRootComponent to read each of the components owned by Root. Users would not need to call <method namespace="Classes" class="TReader">ReadComponent</method> directly.</para>
<method namespace="Classes" class="TReader">ReadComponent</method> handles the loading and initialization process for each component. After loading all the components in the list, <method namespace="Classes" class="TReader">ReadComponent</method>s calls the Loaded method of each loaded component in the order it read them. <method namespace="Classes" class="TReader">ReadComponent</method> manages the complexities of reading the component from the stream through calls to other reader methods and to the component's methods.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadFloat">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a floating-point number from the reader object's stream and returns its value.</para>
<method namespace="Classes" class="TReader">ReadFloat</method> is a helper method used by other reader methods to read a tagged floating-point data value at the current reader Position. <method namespace="Classes" class="TReader">ReadFloat</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaExtended <method namespace="Classes" class="TReader">ReadFloat</method> calls Read and returns the float value. Otherwise it calls ReadInteger.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadSingle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a float value from the reader object's stream and returns its value.</para>
<method namespace="Classes" class="TReader">ReadSingle</method> is a helper method used by other reader methods to read a tagged Delphi Single data value at the current reader Position. (The Single data type corresponds to float in C++.) <method namespace="Classes" class="TReader">ReadSingle</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaSingle, <method namespace="Classes" class="TReader">ReadSingle</method> calls Read and returns the value. Otherwise it calls ReadInteger.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadCurrency">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a Currency value from the reader object's stream and returns its value.</para>
<method namespace="Classes" class="TReader">ReadCurrency</method> is a helper method used by other reader methods to read a tagged Currency data value at the current reader Position. <method namespace="Classes" class="TReader">ReadCurrency</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaCurrency <method namespace="Classes" class="TReader">ReadCurrency</method> calls Read and returns the value. Otherwise it calls ReadInteger.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadDate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a TDateTime value from the reader object's stream and returns its value.</para>
<method namespace="Classes" class="TReader">ReadDate</method> is a helper method used by other reader methods to read a tagged TDateTime data value at the current reader Position. <method namespace="Classes" class="TReader">ReadDate</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaDate <method namespace="Classes" class="TReader">ReadDate</method> calls Read and returns the value. Otherwise it calls ReadInteger.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadIdent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads an identifier from the reader object's stream and returns the identifier.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ReadIndent is a helper method used by other reader methods to read an identifying type at the current reader Position. ReadIndent first checks the value type (TValueType) by calling the ReadValue method. If the item is:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A vaIdent type, ReadIndent calls Read and returns the identifier string value.</para>
<method namespace="Classes" class="TReader">ReadInteger</method> is a helper method used by other reader methods to read a tagged integer value at the current reader Position. <method namespace="Classes" class="TReader">ReadInteger</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaString or a vaInt8, vaInt16 or vaInt32 type, <method namespace="Classes" class="TReader">ReadInteger</method> calls Read and returns the integer value. Otherwise it raises an EReadError exception.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadInt64">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads an 64-bit integer from the reader object's stream and returns its value.</para>
<method namespace="Classes" class="TReader">ReadInt64</method> is a helper method used by other reader methods to read a tagged 64-bit integer value at the current reader Position. <method namespace="Classes" class="TReader">ReadInt64</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaInt64, <method namespace="Classes" class="TReader">ReadInt64</method> calls Read and returns the integer value. Otherwise it calls ReadInteger, in case the value was saved in another integer format.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a component and all its owned components from the reader object's stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TReader">ReadRootComponent</method> directly. It is used internally by the component streaming system. When the reader object is created by its stream in the stream's ReadComponent method, it immediately calls the <method namespace="Classes" class="TReader">ReadRootComponent</method> method, which initiates the streaming sequence of restoring an object.</para>
<method namespace="Classes" class="TReader">ReadRootComponent</method> first calls the ReadSignature method to ensure that it is reading a proper component. <method namespace="Classes" class="TReader">ReadRootComponent</method> also handles initializations and fixup references. For example, the component passed in Root becomes the value of the Root property for the reader object.</para>
<method namespace="Classes" class="TReader">ReadRootComponent</method> calls the component's ReadState method, which calls back to the reader's ReadData method. The ReadState method of TComponent is virtual, which allows component classes to override ReadState to prepare themselves for being loaded with the new data from the stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadStr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a string value.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TReader">ReadStr</method> directly. <method namespace="Classes" class="TReader">ReadStr</method> is for internal use by certain CLX components.</para>
<para>Use <method namespace="Classes" class="TReader">ReadStr</method>ing instead for reading component strings to streams. <method namespace="Classes" class="TReader">ReadStr</method> can corrupt data if not used correctly.</para>
</warning>
</comments>
</member>
<member name="M:Classes.Classes.ReadString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a tagged string value written by WriteString from the reader object's stream and returns its contents.</para>
<method namespace="Classes" class="TReader">ReadString</method> is a helper method used by other reader methods to read a string at the current reader Position. <method namespace="Classes" class="TReader">ReadString</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaString or a vaLString type <method namespace="Classes" class="TReader">ReadString</method> calls Read and returns the string. Otherwise it raises an EReadError exception.</para>
<para>Always use <method namespace="Classes" class="TReader">ReadString</method> for reading component strings to streams. The similarly-named ReadStr method is for internal use only by certain CLX components.</para>
</warning>
</comments>
</member>
<member name="M:Classes.Classes.ReadWideString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a tagged wide string value from the reader object's stream and returns its contents.</para>
<method namespace="Classes" class="TReader">ReadWideString</method> is a helper method used by other reader methods to read a wide string at the current reader Position. <method namespace="Classes" class="TReader">ReadWideString</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaWString type, <method namespace="Classes" class="TReader">ReadWideString</method> calls Read and returns the string. Otherwise it raises an EReadError exception.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads the type of the next item on the reader object's stream and returns with the stream positioned after the value-type indicator.</para>
<method namespace="Classes" class="TReader">ReadValue</method> is used by other reader methods when the subsequent processing depends upon a type check of the data about to be read.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TValueType type defines the kinds of values written to and read from filer objects. CLX filers use a tagged value system, where each value on the stream is preceded by a prefix indicating its type. Those prefixes are of type TValueType.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadVariant">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a Variant value from the reader object's stream and returns its value.</para>
<method namespace="Classes" class="TReader">ReadVariant</method> is a helper method used by other reader methods to read a tagged Variant data value at the current reader Position. <method namespace="Classes" class="TReader">ReadVariant</method> first checks the value type (TValueType) by calling the ReadValue method. If the item is a vaVariant <method namespace="Classes" class="TReader">ReadVariant</method> calls Read and returns the value. Otherwise it calls ReadInteger.</para>
</comments>
</member>
<member name="M:Classes.Classes.BeginReferences">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Starts a block of commands that read components that might contain references to other components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TReader">BeginReferences</method> directly. <method namespace="Classes" class="TReader">BeginReferences</method> is used internally for streaming properties that reference other components.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Following the call to <method namespace="Classes" class="TReader">BeginReferences</method>, the reader object creates a list of all the objects read and their names. After all of the interdependent objects are read, FixupReferences is called to resolve the named references from the stream into instance references. Finally, call EndReferences to dispose of the fixup list.</para>
<method namespace="Classes" class="TReader">BeginReferences</method> is always used together with FixupReferences and EndReferences in a try...finally (Delphi) or try...__finally (C++) block.</para>
</comments>
</member>
<member name="M:Classes.Classes.CheckValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Checks that the next value to be read from the stream is of a specified type.</para>
<method namespace="Classes" class="TReader">CheckValue</method> ascertains that the next value to be read from the stream is of the type specified by Value. If it is not, <method namespace="Classes" class="TReader">CheckValue</method> skips over that value, positioning the stream on the following value, and raises an EReadError exception.</para>
</comments>
</member>
<member name="M:Classes.Classes.DefineProperty">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Defines data the reader object reads as if it were a published property.</para>
<method namespace="Classes" class="TReader">DefineProperty</method> is called internally by the DefineProperties method of an object that has data it needs to store. DefineProperties takes a generic filer object as its parameter. For reading data DefineProperties takes a <method namespace="Classes" class="TReader">TReader</method> object and then calls the DefineProperties method of the reader object. <method namespace="Classes" class="TReader">DefineProperty</method> then reads the property's name and its data.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter specifies the name of the "fake" property to be read from the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ReadData parameter points to a procedure (defined in the storing object) that reads the object's data which represents a property value to the reader object. For <method namespace="Classes" class="TReader">TReader</method> the WriteData parameter is ignored.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HasData parameter determines at run time whether the "fake" property has data to store (write). For <method namespace="Classes" class="TReader">TReader</method> the HasData parameter is ignored.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The difference between DefineBinaryProperty and <method namespace="Classes" class="TReader">DefineProperty</method> is that the binary property is read directly from a stream, rather than going through a filer object, and binary data is harder to edit as text.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Defines binary data the reader object reads as if the data were a published property. </para>
<method namespace="Classes" class="TReader">DefineBinaryProperty</method> is called internally by the DefineProperties method of an object that has data it needs to store. Applications can call <method namespace="Classes" class="TReader">DefineBinaryProperty</method> directly when overriding the DefineProperties method of a component with large custom data (like a bitmap). This is the only context in which <method namespace="Classes" class="TReader">DefineBinaryProperty</method> (or DefineProperty) should be used.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">DefineProperties takes a generic filer object as its parameter. For reading binary data, DefineProperties takes a <method namespace="Classes" class="TReader">TReader</method> object and calls its <method namespace="Classes" class="TReader">DefineBinaryProperty</method> method. <method namespace="Classes" class="TReader">DefineBinaryProperty</method> then reads the property's name data and passes the data to the indicated ReadData method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter specifies the name of the "fake" property to be read from the stream. A "fake" property is a property that is not published, and that exists only in the code for the <method namespace="Classes" class="TReader">DefineBinaryProperty</method> method. The Top and Left properties of a non-visual component are examples of "fake" properties. These are also called "defined properties" or "custom defined properties."</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ReadData and WriteData parameters point to a procedure (defined in the component object) that reads or writes a binary representation of the object's data directly to or from the stream passed to them in the Stream parameter. For <method namespace="Classes" class="TReader">TReader</method> the WriteData parameter is ignored.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HasData parameter determines at run time whether the "fake" property has data to store (write). For <method namespace="Classes" class="TReader">TReader</method> the HasData parameter is ignored.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Defined binary properties are rare. CLX objects that store graphics as binary data are the most common use of filer objects to store and retrieve binary data. More commonly, objects use the DefineProperty method. The difference between <method namespace="Classes" class="TReader">DefineBinaryProperty</method> and DefineProperty is that when using <method namespace="Classes" class="TReader">DefineBinaryProperty</method>, the component reads the binary property directly from a memory stream, rather than going through the filer object. Binary data is also harder to edit as text.</para>
<para>Streamable objects that are descended from TPersistent inherit a DefineProperties method, however DefineProperties does nothing until TComponent. Therefore, it is a component's DefineProperties method that calls the reader's <method namespace="Classes" class="TReader">DefineBinaryProperty</method> when reading binary data.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.EndReferences">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Terminates a block of code that reads components from the reader object's stream that might contain references to each other.</para>
<method namespace="Classes" class="TReader">EndReferences</method> is used for streaming properties that reference another component. Programmers should not need to call <method namespace="Classes" class="TReader">EndReferences</method> directly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The reader object calls <method namespace="Classes" class="TReader">EndReferences</method> and creates a list of all the objects read and their names. After all the interdependent objects are read, FixupReferences is called to resolve the named references from the stream into instance references. Finally, call <method namespace="Classes" class="TReader">EndReferences</method> to dispose of the fixup list.</para>
<method namespace="Classes" class="TReader">EndReferences</method> is always used in the finally part of a try...finally (Delphi) or try...__finally (C++) block that also includes calls to BeginReferences and FixupReferences.</para>
</comments>
</member>
<member name="M:Classes.Classes.FixupReferences">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Resolves references when streaming properties that are represented by another component.</para>
<method namespace="Classes" class="TReader">FixupReferences</method> is used internally by the streaming system to resolve the named references from the stream into instance references. Users would never need to call this method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The reader object calls BeginReferences and creates a list of all the objects read and their names. After all the interdependent objects are read, <method namespace="Classes" class="TReader">FixupReferences</method> is called to resolve the references among various mutually dependent components read from the reader object's stream after all of the objects have been read. Finally, call EndReferences to dispose of the fixup list.</para>
<method namespace="Classes" class="TReader">FixupReferences</method> is always used inside a try...finally (Delphi) or try...__finally (C++) block between calls to BeginReferences and EndReferences.</para>
</comments>
</member>
<member name="M:Classes.Classes.FlushBuffer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Synchronizes the reader's buffer with its stream's buffer.</para>
<method namespace="Classes" class="TReader">FlushBuffer</method> synchronizes the reader's buffer with the associated stream by setting the stream's Position to match the reader's Position.</para>
<method namespace="Classes" class="TReader">Read</method>s data from the associated stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call read directly. <method namespace="Classes" class="TReader">Read</method> is used internally to read data from the stream. Many other writer methods call <method namespace="Classes" class="TReader">Read</method>, usually after setting pertinent values or verifying data types.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadCollection">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a collection from the reader object's stream and returns that character value.</para>
<method namespace="Classes" class="TReader">ReadCollection</method> is a helper method used by other reader methods to read a tagged collection value at the current reader Position. <method namespace="Classes" class="TReader">ReadCollection</method> iterates through items in a collection so that each item in a collection property has an opportunity to stream out its properties. This method does not write out the number of items and the collection indices, because a user can add or delete items.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadComponents">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a list of owned components from the reader object's associated stream.</para>
<method namespace="Classes" class="TReader">ReadComponents</method> is used internally by the IDE for design-time streaming. Do not call <method namespace="Classes" class="TReader">ReadComponents</method> directly.</para>
<method namespace="Classes" class="TReader">ReadComponents</method> first sets the reader object's Root and Owner properties to the component passed in the AOwner parameter and sets its Parent property to AParent. Next <method namespace="Classes" class="TReader">ReadComponents</method> reads components by calling the ReadComponent method, passing each returned component to the method passed in Proc.</para>
<method namespace="Classes" class="TReader">ReadListBegin</method> is used by other methods that iterate through a list of items to ensure that the type about to be read is a list. <method namespace="Classes" class="TReader">ReadListBegin</method> is also used by component writers in defined property ReadData methods.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the next item in the stream is not a start-of list marker as written by the WriteListBegin method, <method namespace="Classes" class="TReader">ReadListBegin</method> raises an EReadError exception.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A call to <method namespace="Classes" class="TReader">ReadListBegin</method> is generally followed by a reading loop that terminates when the EndOfList method returns true, indicating that an end-of-list marker is next on the stream, at which point a call to ReadListEnd is required.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadListEnd">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads an end-of-list marker from the reader object's associated stream.</para>
<method namespace="Classes" class="TReader">ReadListEnd</method> is used by other methods that iterate through a list of items to signal the end of a group of items being read. <method namespace="Classes" class="TReader">ReadListEnd</method> is also used by component writers in defined property ReadData methods.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A call to <method namespace="Classes" class="TReader">ReadListEnd</method> is generally preceded by a reading loop that terminates when the EndOfList method returns true, indicating that an end-of-list marker is next on the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the item read is not an end-of-list marker, <method namespace="Classes" class="TReader">ReadListEnd</method> raises an EReadError exception. A call to <method namespace="Classes" class="TReader">ReadListEnd</method> must correspond to a preceding call to ReadListBegin.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadPrefix">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads preliminary information concerning form inheritance for a component.</para>
<method namespace="Classes" class="TReader">ReadPrefix</method> is used internally by the component streaming system. It is called automatically by ReadComponent to read flags that determine whether a component in an inherited form (ffInherited), whether its creation order in the form is important (ffChildPos), and whether it is a top-level component such as a form or data module (ffInline). It also reads the component's position in the ancestor form's creation order if the ffChildPos flag is set. When a writer object writes a component to its stream, it prefixes the component with these flags.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadSignature">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads the filer signature from the reader object's associated stream. </para>
<method namespace="Classes" class="TReader">ReadSignature</method> is used by several routines to ensure that the file about to be read is a valid component stream. For example, ReadRootComponent, calls <method namespace="Classes" class="TReader">ReadSignature</method> before reading its component from the stream. By checking for the signature before loading objects, the reader object can guard against inadvertently reading invalid or corrupted data.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The signature is a four-character sequence.</para>
</comments>
</member>
<member name="M:Classes.Classes.CopyValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies data while reading components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TReader">CopyValue</method>, it is used internally.</para>
</comments>
</member>
<member name="M:Classes.Classes.SkipValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Skips the next value read from the stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TReader">SkipValue</method> to skip over a value, positioning the stream on the following value.</para>
</comments>
</member>
<member name="M:Classes.Classes.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves the current position of the stream back to the beginning before calling the inherited destructor.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TReader">Destroy</method> directly. Reader objects are created indirectly through the methods or routines that use them. These methods and routines handle freeing the <method namespace="Classes" class="TReader">TReader</method> object.</para>
</comments>
</member>
<member name="P:Classes.Classes.Owner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Stores the component that is assigned as the <property namespace="Classes" class="TReader">Owner</property> property of components read from the reader object's stream.</para>
<property namespace="Classes" class="TReader">Owner</property> is used internally by the component streaming system to determine which components to stream. The streaming process handles all components owned by the Root component.</para>
<property namespace="Classes" class="TReader">Owner</property> is the <property namespace="Classes" class="TReader">Owner</property> property of the component read from the stream. The component's <property namespace="Classes" class="TReader">Owner</property> property is assigned its value from the reader's <property namespace="Classes" class="TReader">Owner</property> property. If the value of the reader's <property namespace="Classes" class="TReader">Owner</property> property is nil (Delphi) or NULL (C++), then the Root property is assigned as the component's <property namespace="Classes" class="TReader">Owner</property> property.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For most components, <property namespace="Classes" class="TReader">Owner</property> is nil (Delphi) or NULL (C++). For components that can contain subcomponents that are not owned by the Root form, such as the nodes of a tree view component, the <property namespace="Classes" class="TReader">Owner</property> is not the same as the Root. The GetChild<property namespace="Classes" class="TReader">Owner</property> method of the component determines the <property namespace="Classes" class="TReader">Owner</property>.</para>
</comments>
</member>
<member name="P:Classes.Classes.Parent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Stores the component that is assigned as the <property namespace="Classes" class="TReader">Parent</property> property of controls read from the reader's stream.</para>
<property namespace="Classes" class="TReader">Parent</property> is used internally by the component streaming system. The value of the <property namespace="Classes" class="TReader">Parent</property> property is determined by the order that components are read from the stream. The <property namespace="Classes" class="TReader">Parent</property> relationship determines the visual containment of components.</para>
</comments>
</member>
<member name="P:Classes.Classes.Position">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the current reading position in the associated stream. </para>
<property namespace="Classes" class="TReader">Position</property> is used to track the reader's position within the stream. The value of <property namespace="Classes" class="TReader">Position</property> will always be inside the most recent buffer block read. Thus, for reading, <property namespace="Classes" class="TReader">Position</property> will always be less than the stream's <property namespace="Classes" class="TReader">Position</property>.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnError">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a reader object encounters an error reading its data, such as reading the name of an undeclared property or an illegal value.</para>
<event namespace="Classes" class="TReader">OnError</event> is used internally by the IDE to report errors. It can also be used to write an event handler to selectively choose to process or ignore errors.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The last parameter passed to the <event namespace="Classes" class="TReader">OnError</event> event handler, Handled, is passed by reference. By default, the Error method passes false in Handled, but a handler that corrects the error or chooses to ignore the error can set Handled to true, which prevents further processing of the error. If the event handler returns with Handler still set to false, the reader object raises an EReadError exception.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnFindMethod">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs each time the reader object reads an event, which is a method-pointer property, for an object.</para>
<event namespace="Classes" class="TReader">OnFindMethod</event> is used internally by the IDE for reading events. It can also be used to write a handler to ask the user how to handle missing methods.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the reader cannot locate the named method assigned to the method pointer, it sets the Error parameter of the <event namespace="Classes" class="TReader">OnFindMethod</event> handler to true. The handler can set Error to false, which prevents FindMethod from raising an exception when the handler returns.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnSetName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs just before the reader object sets the Name property of a component it reads from its stream.</para>
<event namespace="Classes" class="TReader">OnSetName</event> is used by internally by the IDE to handle duplicate names of components and forms. It can also be used to write an event handler to perform special processing just before the Name property is set for the component which has just been created and is about to have its properties read from the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter to the <event namespace="Classes" class="TReader">OnSetName</event> event handler passed by reference, so the handler can change the name before the reader assigns it to the component. For example, <event namespace="Classes" class="TReader">OnSetName</event> is useful for filtering all the component names in a form, to add or change part of the string.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnReferenceName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when resolving references to other objects such as when one object is the property value of another.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the reader has read a component's class but has not yet instantiated the component.</para>
<event namespace="Classes" class="TReader">OnCreateComponent</event> is used internally to provide an alternate mechanism for instantiating components. If <event namespace="Classes" class="TReader">OnCreateComponent</event> returns a component as the value of the Component parameter, the Reader uses that instance instead of calling the component's constructor.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a reader first reads the name of a component class.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ReadComponent method generates an <event namespace="Classes" class="TReader">OnFindComponentClass</event> event when it reads the class name for the component it is loading. An <event namespace="Classes" class="TReader">OnFindComponentClass</event> event handler can replace the class reference with a different class to change the type of component that gets loaded.</para>
<class namespace="Classes">TWriter</class> is used internally by the component streaming system to write information associated with a component, such as published properties of components or custom property data, to a stream. <class namespace="Classes">TWriter</class> handles the mechanics of writing the data associated with a component to a stream. It is the writer object, rather than the stream, that is responsible for handling the complexities of streaming components. These include methods for:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writing different kinds of items to the associated stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writing property deltas used for streaming inherited forms and properties with default values.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writing nested groups of items or collections to the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Other methods and properties of <class namespace="Classes">TWriter</class> are used for interacting with stream and component objects.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not directly create writer objects. Writers are automatically created in stream object methods or in global routines that initiate the streaming process. These include:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">the global routine ObjectTextToBinary procedure, which directly creates a writer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">the global WriteComponentResFile function, which creates a file stream that creates a writer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">the WriteDescendent method of TStream, which creates a writer object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once the streaming process is underway, programs do not need to directly manipulate writer objects. The interaction between the writer, component, and stream objects happens automatically in methods of these objects that make calls to each other.</para>
</comments>
</member>
<member name="M:Classes.Classes.DefineProperty">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Defines data the writer object writes as if the data were a property.</para>
<method namespace="Classes" class="TWriter">DefineProperty</method> is called internally by the DefineProperties method of an object that has data it needs to store. DefineProperties takes a generic filer object as its parameter. For writing data, DefineProperties takes a <method namespace="Classes" class="TWriter">TWriter</method> object and calls its <method namespace="Classes" class="TWriter">DefineProperty</method> method. <method namespace="Classes" class="TWriter">DefineProperty</method> then writes the property's name and its data, but only if the HasData parameter is true. Otherwise it does nothing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter specifies the name of the "fake" property to be written to the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The WriteData parameter points to a procedure (defined in the component object) that writes the object's data, which represents a property value, to the writer object. For <method namespace="Classes" class="TWriter">TWriter</method> the ReadData parameter is ignored.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HasData parameter determines at run time whether the "fake" property has data to store (write). Thus, writer objects only use HasData when writing data.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The difference between DefineBinaryProperty and <method namespace="Classes" class="TWriter">DefineProperty</method> is that with DefineBinaryProperty, the binary data is written directly to a stream object, rather than going through a filer object.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When writing a component that has special (large) data storage requirements, the component's DefineProperties can be overridden. For each special or "fake" property item, call <method namespace="Classes" class="TWriter">DefineProperty</method> or DefineBinaryProperty. For the ReadData and WriteData parameters, pass in methods of the component that know how to handle that special data type. When reading, ReadData is called. When writing, WriteData is called.</para>
<para>When defining properties, a component should be aware of the Ancestor property, which, if non-nil (Delphi) or non-NULL (C++) indicates that the component should only write the values of properties that differ from those inherited from Ancestor.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Treats unformatted data as if it were the value of a published property, and writes it directly to a memory stream.</para>
<method namespace="Classes" class="TWriter">DefineBinaryProperty</method> is called internally by the DefineProperties method of an object that has data it needs to store. DefineProperties takes a generic filer object as its parameter.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For writing binary data DefineProperties takes a <method namespace="Classes" class="TWriter">TWriter</method> object and then calls its <method namespace="Classes" class="TWriter">DefineBinaryProperty</method> method. <method namespace="Classes" class="TWriter">DefineBinaryProperty</method> writes the property's name and it's data, but only if the HasData parameter is true. Otherwise it does nothing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name parameter specifies the name of the "fake" property to be written to the stream. A "fake" property is a property that is not published, and that exists only in the code for the <method namespace="Classes" class="TWriter">DefineBinaryProperty</method> method. The Top and Left properties of a non-visual component are examples of "fake" properties. These are also called "defined properties" or "custom defined properties."</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TStreamProc type is the type of the ReadData and WriteData parameters. It is the method-pointer type that points to a procedure (defined in the storing object) that reads or writes a binary representation of the object's data directly to or from the stream passed as its Stream parameter. For <method namespace="Classes" class="TWriter">TWriter</method> the ReadData parameter is ignored.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HasData parameter determines at run time whether the "fake" property has data to store (write).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Defined binary properties are quite rare. Persistent objects that store graphics as binary data are the most common use of filer objects to store and retrieve that data. More commonly, objects use the DefineProperty method. The difference between <method namespace="Classes" class="TWriter">DefineBinaryProperty</method> and DefineProperty is that with <method namespace="Classes" class="TWriter">DefineBinaryProperty</method> the component reads or writes the binary property directly to or from a memory stream, rather than going through a filer object.</para>
<para>Streamable objects that are descended from TPersistent inherit a DefineProperties method, however DefineProperties does not do anything until TComponent. It is TComponent's DefineProperties method that calls the writer's <method namespace="Classes" class="TWriter">DefineBinaryProperty</method> when writing out binary data.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.FlushBuffer">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Synchronizes the writer's buffer with the associated stream by writing the current buffer.</para>
<method namespace="Classes" class="TWriter">FlushBuffer</method> writes the current buffer to the stream, then resets an internal pointer to the correct position.</para>
<method namespace="Classes" class="TWriter">Write</method>s Count bytes from Buf to the writer object's associated stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TWriter">Write</method> directly. It is used internally to write data to the stream. Many other writer methods call <method namespace="Classes" class="TWriter">Write</method>, usually after setting pertinent values or verifying data types.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteBoolean">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the Boolean value passed in Value to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteBoolean</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteBoolean</method> for writing component boolean properties to streams.</para>
<method namespace="Classes" class="TWriter">WriteBoolean</method> checks to ensure that Value is the correct type before calling Write to write the boolean value and its value type to the stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteCollection">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the collection of objects passed in Value to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteCollection</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteCollection</method> for writing component properties that are collections to streams.</para>
<method namespace="Classes" class="TWriter">WriteCollection</method> first writes the type identifier indicating a collection.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the Value parameter is not nil (Delphi) or NULL (C++), <method namespace="Classes" class="TWriter">WriteCollection</method> next writes each element of the collection to the stream, bounding the elements with start-of-list and end-of-list markers. Otherwise, it skips the elements, assuming an empty collection.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the component specified by Component to a stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Never call <method namespace="Classes" class="TWriter">WriteComponent</method> directly. <method namespace="Classes" class="TWriter">WriteComponent</method> is recursively called for each owned component in Root.</para>
<method namespace="Classes" class="TWriter">WriteComponent</method> sets the csWriting state in Component's ComponentState property before calling the WriteState method of Component and clears the csWriting flag when WriteState returns.</para>
<para>The sequence of events is as follows: the writer's <method namespace="Classes" class="TWriter">WriteComponent</method> method calls the Component's WriteState method, which calls the writer's WriteData method. That method writes the properties for each child component, then calls <method namespace="Classes" class="TWriter">WriteComponent</method>.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Because the Component's WriteState is virtual, it is the Component's only opportunity to prepare itself to be streamed (i.e. to consolidate its data.)</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteChar">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the character passed in Value to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteChar</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteChar</method> for writing component character properties to streams.</para>
<method namespace="Classes" class="TWriter">WriteChar</method> calls WriteString which checks to ensure that Value is the correct type before calling Write to write the character and its value type to the stream. </para>
<method namespace="Classes" class="TWriter">WriteChar</method> calls StringChar to enable writing character properties that are upwardly compatible with string properties.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.WriteDescendent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Triggers the writing of descendant components in inherited forms.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Never call <method namespace="Classes" class="TWriter">WriteDescendent</method> directly. It is part of a sequence of calls used for streaming descendant components in inherited forms.</para>
<method namespace="Classes" class="TWriter">WriteDescendent</method> sets the writer object's Ancestor and RootAncestor properties to the value passed in AAncestor, sets the Root property to the value passed in Root, then calls WriteSignature and WriteComponent to write Root and any components it owns to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteDescendent</method> differs from WriteComponent in that, by setting Ancestor, it uses Ancestor's property values as the defaults, rather than those defined by Root's type.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteFloat">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the floating-point value passed in Value to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteFloat</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteFloat</method> for writing floating point data to streams.</para>
<method namespace="Classes" class="TWriter">WriteFloat</method> checks to ensure that Value is the correct type before calling Write to write the float value and its value type to the stream.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteSingle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes a value of type Single (Delphi) or float (C++) to the writer's stream.</para>
<method namespace="Classes" class="TWriter">WriteSingle</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteSingle</method> for writing component properties of Delphi type Single (which corresponds to C++ type float) to streams.</para>
<method namespace="Classes" class="TWriter">WriteCurrency</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteCurrency</method> for writing component properties of type Currency to streams.</para>
<method namespace="Classes" class="TWriter">WriteDate</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteDate</method> for writing component properties of type TDateTime to streams.</para>
<method namespace="Classes" class="TWriter">WriteIdent</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteIdent</method> for writing component identifier properties to streams. Component names and enumerated type elements are examples of strings that must be restricted to identifier syntax.</para>
<method namespace="Classes" class="TWriter">WriteIdent</method> checks for certain common identifiers (such as true, false, nil (Delphi), or NULL (C++)) and inserts a special token for these values. Otherwise, it writes the identifier as a string.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteInteger">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the integer value passed in Value to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteInteger</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteInteger</method> for writing component integer properties to streams.</para>
<method namespace="Classes" class="TWriter">WriteInteger</method> checks to ensure that Value is the correct type before calling Write to write the integer value and its value type to the stream. <method namespace="Classes" class="TWriter">WriteInteger</method> handles integers of different sizes.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteListBegin">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes a start-of-list marker to the writer object's associated stream.</para>
<method namespace="Classes" class="TWriter">WriteListBegin</method> is used by other methods that iterate through a group of items about to be written to the stream. <method namespace="Classes" class="TWriter">WriteListBegin</method> writes a start-of-list marker to the writer object's associated stream. Every call to <method namespace="Classes" class="TWriter">WriteListBegin</method> must have a corresponding call to WriteListEnd.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteListEnd">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes an end-of-list marker to the writer object's associated stream.</para>
<method namespace="Classes" class="TWriter">WriteListEnd</method> is used by other methods that iterate through a group of items that are sequentially written to the stream during a single process. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A call to <method namespace="Classes" class="TWriter">WriteListEnd</method> is generally preceded by a writing loop. A call to <method namespace="Classes" class="TWriter">WriteListEnd</method> must correspond to a preceding call to WriteListBegin.</para>
<method namespace="Classes" class="TWriter">WriteSignature</method> is used internally by several methods that write the filer signature before processing some action. For example, the WriteRootComponent method calls <method namespace="Classes" class="TWriter">WriteSignature</method> before writing its component to the stream. By checking for the signature before loading objects, reader objects can guard against inadvertently reading invalid or corrupted data.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteStr">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes raw data to the writer object's stream.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TWriter">WriteStr</method> directly. <method namespace="Classes" class="TWriter">WriteStr</method> is for internal use by certain components. <method namespace="Classes" class="TWriter">WriteStr</method> writes the string passed in Value to the writer object's stream.</para>
<para>Always use <method namespace="Classes" class="TWriter">WriteStr</method>ing for writing component strings to streams. <method namespace="Classes" class="TWriter">WriteStr</method> can corrupt data if not used correctly.</para>
</warning>
</comments>
</member>
<member name="M:Classes.Classes.WriteString">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes tagged data to the writer object's stream.</para>
<method namespace="Classes" class="TWriter">WriteString</method> is used internally by the component streaming system to write component properties to a stream. <method namespace="Classes" class="TWriter">WriteString</method> is otherwise only used by component writers in the DefineProperties and WriteData procedures.</para>
<method namespace="Classes" class="TWriter">WriteString</method> writes the string passed in Value to the writer object's stream. <method namespace="Classes" class="TWriter">WriteString</method> checks to ensure that Value is the correct type before calling Write to write the string and its value type to the stream.</para>
<para>Always use <method namespace="Classes" class="TWriter">WriteString</method> for writing component strings to streams. The similarly-named WriteStr method is for internal use by certain components and can corrupt data if not used correctly.</para>
<method namespace="Classes" class="TWriter">WriteWideString</method> is used internally by the component streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteWideString</method> for writing WideString component to streams.</para>
<method namespace="Classes" class="TWriter">WriteWideString</method> first writes a type identifier and the length of the string before writing the value.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteVariant">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes a Variant value to the writer's stream.</para>
<method namespace="Classes" class="TWriter">WriteVariant</method> is used internally by the streaming system to write component properties to a stream. Use <method namespace="Classes" class="TWriter">WriteVariant</method> for writing component properties of type Variant to streams.</para>
<method namespace="Classes" class="TWriter">Destroy</method>s of an instance of a writer.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TWriter">Destroy</method> directly in an application. Writers are created indirectly by the global routines or stream methods that use them. When these routines are finished, they handle disposing of the writer.</para>
<method namespace="Classes" class="TWriter">Destroy</method> writes the buffer before calling the inherited <method namespace="Classes" class="TWriter">Destroy</method>, which frees the buffer.</para>
</comments>
</member>
<member name="P:Classes.Classes.Position">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the current writing position in the associated stream.</para>
<property namespace="Classes" class="TWriter">Position</property> is used internally by writer objects to indicate the current writing position in the stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="Classes" class="TWriter">Position</property> will be inside the most recent buffer block read or the next block to be written. Thus, for writing, <property namespace="Classes" class="TWriter">Position</property> will generally be less than the stream's <property namespace="Classes" class="TWriter">Position</property>. When <property namespace="Classes" class="TWriter">Position</property> is set to a location outside the current buffer, the writer's buffer is flushed to the stream.</para>
</comments>
</member>
<member name="P:Classes.Classes.RootAncestor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the ancestor of the component in the Root property.</para>
<property namespace="Classes" class="TWriter">RootAncestor</property> is used internally by writer objects for dealing with form inheritance. It is used to iterate through ancestor components when writing properties in inherited forms.</para>
<property namespace="Classes" class="TWriter">RootAncestor</property> is always the ancestor form. For each component in Root, which is the inherited form, the Ancestor property tracks a corresponding component in <property namespace="Classes" class="TWriter">RootAncestor</property>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The writer object iterates through each of the Root form's owned components, comparing each to the corresponding component in the <property namespace="Classes" class="TWriter">RootAncestor</property> form. It then writes only those properties in the current component that differ in some way from those in the Ancestor component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether all class names should be qualified by the name of the unit in which they are defined.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TWriter">UseQualifiedNames</property> to indicate whether class names need to be qualified by the name of the unit in which they are defined. In Windows versions of the IDE, for example, some components (such as TButton) appear both in the Windows-only and in the cross-platform component libraries. When writing such a component, setting <property namespace="Classes" class="TWriter">UseQualifiedNames</property> to true allows a reader to distinguish the Windows-only TButton control in StdCtrls from the cross-platform TButton control in QStdCtrls.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnFindAncestor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a component is about to be written to a stream.</para>
<event namespace="Classes" class="TWriter">OnFindAncestor</event> allows the writer to explicitly specify the ancestor of a component when it is written to a stream. The WriteComponent method generates this event to override the value of the Ancestor property before writing a component to a stream.</para>
<para>See the Threads demo for multi-threading program samples.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.WaitFor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Waits for the thread to terminate and then returns the value of the ReturnValue property.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TThread">WaitFor</method> to obtain the value of ReturnValue when the thread finishes executing. <method namespace="Classes" class="TThread">WaitFor</method> doesn't return until the thread terminates, so the thread must exit either by finishing the Execute method or by exiting when the Terminated property is true.</para>
<method namespace="Classes" class="TThread">Synchronize</method> causes the call specified by Method to be executed using the main thread, thereby avoiding multi-thread conflicts. If you are unsure whether a method call is thread-safe, call it from within the <method namespace="Classes" class="TThread">Synchronize</method> method to ensure that it executes in the main thread.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Execution of the thread current is suspended while Method executes in the main thread.</para>
<para>Do not call <method namespace="Classes" class="TThread">Synchronize</method> from within the main thread. This can cause an infinite loop.</para>
<method namespace="Classes" class="TThread">DoTerminate</method> calls the OnTerminate event handler, but does not terminate the thread.</para>
</comments>
</member>
<member name="M:Classes.Classes.Execute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides an abstract or pure virtual method to contain the code which executes when the thread is run. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Override <method namespace="Classes" class="TThread">Execute</method> and insert the code that should be executed when the thread runs. <method namespace="Classes" class="TThread">Execute</method> is responsible for checking the value of the Terminated property to determine if the thread needs to exit.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A thread executes when Create is called if CreateSuspended set to false, or when Resume is first called after the thread is created if CreateSuspended set to true. </para>
<para>Do not use the properties and methods of other objects directly in the <method namespace="Classes" class="TThread">Execute</method> method of a thread. Instead, separate the use of other objects into a separate procedure call, and call that procedure by passing it as a parameter to the Synchronize method.</para>
<method namespace="Classes" class="TThread">AfterConstruction</method> launches the Execute method when the thread is not created in a suspended state. By calling Execute from the <method namespace="Classes" class="TThread">AfterConstruction</method> method rather than the constructor, <method namespace="Classes" class="TThread">TThread</method> avoids a race condition where the thread may free itself after Execute finishes but before the main thread calls <method namespace="Classes" class="TThread">AfterConstruction</method>.</para>
</comments>
</member>
<member name="M:Classes.Classes.Resume">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Restarts the execution of a suspended thread. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TThread">Resume</method> to cause a suspended thread to start running again. Calls to Suspend can be nested; <method namespace="Classes" class="TThread">Resume</method> must be called the same number of times Suspend was called before the thread will resume execution.</para>
</comments>
</member>
<member name="M:Classes.Classes.Suspend">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pauses a running thread.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TThread">Suspend</method> to temporarily halt execution of the thread. To resume execution after a call to <method namespace="Classes" class="TThread">Suspend</method>, call Resume. Calls to <method namespace="Classes" class="TThread">Suspend</method> can be nested; Resume must be called the same number of times <method namespace="Classes" class="TThread">Suspend</method> was called before the thread will resume execution.</para>
</comments>
</member>
<member name="M:Classes.Classes.Terminate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Signals the thread to terminate by setting the <method namespace="Classes" class="TThread">Terminate</method>d property to true. </para>
<method namespace="Classes" class="TThread">Terminate</method> sets the thread's <method namespace="Classes" class="TThread">Terminate</method>d property to true, signaling that the thread should be terminated as soon as possible. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For <method namespace="Classes" class="TThread">Terminate</method> to work, the thread's Execute method and any methods that Execute calls should check <method namespace="Classes" class="TThread">Terminate</method>d periodically and exit when it's true.</para>
<para>Unlike the Windows API <method namespace="Classes" class="TThread">Terminate</method>Thread, which forces the thread to terminate immediately, the <method namespace="Classes" class="TThread">Terminate</method> method merely requests that the thread terminate. This allows the thread to perform any cleanup before it shuts down.</para>
<method namespace="Classes" class="TThread">Destroy</method>s the thread object and releases the memory allocated to it.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TThread">Destroy</method> in an application. Instead, use Free to destroy a thread when FreeOnTerminate is False.</para>
<method namespace="Classes" class="TThread">Destroy</method> signals the thread to terminate and then waits for the thread to return before calling the inherited <method namespace="Classes" class="TThread">Destroy</method> method.</para>
</comments>
</member>
<member name="P:Classes.Classes.ReturnValue">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the value returned to other waiting threads when the thread finishes executing.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TThread">ReturnValue</property> to indicate success/failure or numeric result/output of the thread to the application or other threads. The WaitFor method returns the value stored in <property namespace="Classes" class="TThread">ReturnValue</property>.</para>
</comments>
</member>
<member name="P:Classes.Classes.Terminated">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the thread has been asked to terminate.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The thread's Execute method and any methods that Execute calls should
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Terminate method is the polite way to abort the execution of a
thread, but it requires cooperation from the thread's Execute code. Using
Terminate is recommended over the TerminateThread Win32 API call. </para>
</comments>
</member>
<member name="P:Classes.Classes.FatalException">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the thread object is automatically destroyed when the thread terminates. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the Execute method raises an exception that is not caught and handled within that method, the thread terminates and sets <property namespace="Classes" class="TThread">FatalException</property> to the exception object for that exception. Applications can check <property namespace="Classes" class="TThread">FatalException</property> from an OnTerminate event handler to determine whether the thread terminated due to an exception.</para>
</comments>
</member>
<member name="P:Classes.Classes.FreeOnTerminate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the thread object is automatically destroyed when the thread terminates. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TThread">FreeOnTerminate</property> to true if you don't want to explicitly destroy threads after they finish executing. When <property namespace="Classes" class="TThread">FreeOnTerminate</property> is false, the thread object must be explicitly destroyed in application code.</para>
<para>When <property namespace="Classes" class="TThread">FreeOnTerminate</property> is true, the Execute method may run and then free the thread before your application can execute the next line of code. Thus, you should not call any methods of the thread object when <property namespace="Classes" class="TThread">FreeOnTerminate</property> is true unless you create the thread in a suspended state.</para>
</warning>
</comments>
</member>
<member name="P:Classes.Classes.Handle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the thread's handle<condition os="Linux"> (Windows
only)</condition>.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">On Windows, use
<property namespace="Classes" class="TThread">Handle</property> for
calling Win32 API functions for thread manipulation.</para>
<para>Boosting the thread priority of a CPU intensive operation may
"starve" the other threads in the application. Only apply priority boosts to
threads that spend most of their time waiting for external events.</para>
</warning>
</comments>
</member>
<member name="P:Classes.Classes.Suspended">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a thread is suspended. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Classes" class="TThread">Suspended</property> to true to suspend a thread; set it to false to resume it. <property namespace="Classes" class="TThread">Suspended</property> threads do not continue execution until they are resumed.</para>
</comments>
</member>
<member name="P:Classes.Classes.ThreadID">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the thread throughout the system.</para>
<property namespace="Classes" class="TThread">ThreadID</property> is
different than the thread's handle in the Handle property.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnTerminate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after the thread's Execute method has returned and before the thread is destroyed. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TThread">OnTerminate</event> event handler to execute code after the thread finishes executing. The <event namespace="Classes" class="TThread">OnTerminate</event> event handler is called in the context of the main thread, which means methods and properties can be called freely. </para>
<type namespace="Qt">TOperation</type> represents the types of operations whose occurrence is broadcast by the Notification method.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <type namespace="Qt">TOperation</type> type is used in the Notification method to indicate whether the notification indicates the creation or deletion of an object. The following table gives the possible values:</para>
<type namespace="Qt">TComponentState</type> defines the set of possible state flags for the ComponentState property of a TComponent instance. The following table lists the possible values for the <type namespace="Qt">TComponentState</type> type and the meaning corresponding to each flag:</para>
<para>The component was introduced in an ancestor form. Only set if csDesigning is also set.</para>
</td>
</tr>
<tr>
<td>
<para>csDesigning</para>
</td>
<td>
<para>The component is in a form being manipulated by the form designer.</para>
</td>
</tr>
<tr>
<td>
<para>csDestroying</para>
</td>
<td>
<para>The component is about to be destroyed.</para>
</td>
</tr>
<tr>
<td>
<para>csFixups</para>
</td>
<td>
<para>The component is linked to a component in another form that has not yet been loaded. This flag is cleared when all pending fix-ups are resolved.</para>
</td>
</tr>
<tr>
<td>
<para>csFreeNotification</para>
</td>
<td>
<para>One or more other components have requested that this component notify them when it is destroyed. This flag is set when another component calls this component's FreeNotification method.</para>
</td>
</tr>
<tr>
<td>
<para>csInline</para>
</td>
<td>
<para>The component is a top-level component that can be modified at design time and also embedded in a form. This flag is used to identify nested frames while loading and saving.</para>
</td>
</tr>
<tr>
<td>
<para>csLoading</para>
</td>
<td>
<para>A filer object is currently loading the component. This flag is set when the component is first created and not cleared until the component and all its children are fully loaded (when the Loaded method is called).</para>
</td>
</tr>
<tr>
<td>
<para>csReading</para>
</td>
<td>
<para>The component is reading its property values from a stream. Note that the csLoading flag is always set as well when csReading is set. That is, csReading is set for the subinterval of the time when a component is loading that covers reading in property values.</para>
</td>
</tr>
<tr>
<td>
<para>csUpdating</para>
</td>
<td>
<para>The component is being updated to reflect changes in an ancestor form. Only set if csAncestor is also set.</para>
</td>
</tr>
<tr>
<td>
<para>csWriting</para>
</td>
<td>
<para>The component is writing its property values to a stream.</para>
</td>
</tr>
<tr>
<td>
<para>csDesignInstance</para>
</td>
<td>
<para>The component is the root object in a designer. For example, it is set for a frame when you are designing it, but not on a frame that acts like a component. This flag always appears with csDesigning. </para>
<type namespace="Qt">TComponentStyle</type> is a set of flags that describe the current Style of a component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The following table indicates the meaning of the various <type namespace="Qt">TComponentStyle</type> flags:</para>
<para>Descendant form types can inherit from the component. If any of the components in a form do not have the csInheritable style, the form cannot be used as the ancestor of an inherited form.</para>
</td>
</tr>
<tr>
<td>
<para>csCheckPropAvail</para>
</td>
<td>
<para> The component needs to check its properties for readability. This is only used for COM controls (on Windows), where the Object Inspector cannot tell directly that a property is readable, and therefore displayable.</para>
</td>
</tr>
<tr>
<td>
<para>csSubComponent</para>
</td>
<td>
<para>The component is a subcomponent of the component that is the value of its Owner property. Unlike top-level components, subcomponents are not saved with the form or data module in which they reside. Instead, a subcomponent appears as the value of a published property of its Owner, and its published properties and events are saved in the form file with the owning component.</para>
</td>
</tr>
<tr>
<td>
<para>csTransient</para>
</td>
<td>
<para>The component is a temporary object that should not be saved in a form file.</para>
<class namespace="Classes">IDesignerNotify</class> is the interface for responding to notifications about changes to components in the designer.</para>
<class namespace="Classes">IDesignerNotify</class> introduces two methods, Modified and Notification, that allow the designer to respond when components are added, deleted, or changed. These methods are called automatically by the form designer or by component and property editors.</para>
</comments>
</member>
<member name="M:Classes.Classes.Modified">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Notifies property and component editors when a change is made to a component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When any change is made to a component the property and component editors call this method, allowing the designer to respond to the change.</para>
</comments>
</member>
<member name="M:Classes.Classes.Notification">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Allows the designer to respond when a notification is sent to the form.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When a form receives a notification, it calls the <method namespace="Classes" class="IDesignerNotify">Notification</method> method of the designer, allowing the designer to respond to all the notifications the form receives.</para>
<class namespace="Classes">TComponent</class> is the base class for all components. <class namespace="Classes">TComponent</class> implements the following features:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Components are persistent objects that have the following capabilities:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">IDE integration. The ability to appear on an IDE palette and be manipulated in a form designer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ownership. The ability to manage other components. If component A owns component B, then A is responsible for destroying B when A is destroyed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Streaming and filing. Enhancements of the persistence features inherited from TPersistent.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">COM support. Components can be converted into ActiveX controls or other COM objects using wizards provided with Windows products. Components can serve as wrappers for COM objects.</para>
<para>COM features are present in all implementations of <class namespace="Classes">TComponent</class>, including those provided with Linux development tools. However, these features are only useful in Windows applications, and are marked in this documentation as "Windows only". Do not use these features in cross-platform applications.</para>
<class namespace="Classes">TComponent</class> does not provide any user interface or display features. These features are provided by two classes that directly descend from <class namespace="Classes">TComponent</class>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TControl, in the QControls unit, is the base class for "visual" components in cross-platform applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TControl, in the Controls unit, is the base class for "visual" components in Windows-only applications.</para>
<para>The Controls unit and other Windows-specific units are not provided with Linux development tools.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Components that can be visible at runtime are sometimes called "visual components". Other components, which are never visible at runtime, are sometimes called "non-visual components". However it is more common to refer to "visual components" as "controls" and "non-visual components" simply as "components."</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Classes">TComponent</class>. Use <class namespace="Classes">TComponent</class> as a base class when declaring non-visual components that can appear on the component palette and be used in the form designer. Properties and methods of <class namespace="Classes">TComponent</class> provide basic behavior that descendant classes inherit as well as behavior that components can override to customize their behavior.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetChildOwner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the owner of a child component being read from a stream.</para>
<method namespace="Classes" class="TComponent">GetChildOwner</method> is used internally by the component streaming system. It is rarely necessary to call it directly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">GetChildOwner</method> always returns nil (Delphi) or NULL (C++), indicating that the owner is the root component currently being read (usually a form or data module). The Owner of a component is responsible for destroying it.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetChildParent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.</para>
<method namespace="Classes" class="TComponent">GetChildParent</method> is used internally in the component streaming system. It is not necessary to call it directly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">GetChildParent</method> returns Self (Delphi) or this (C++). If <method namespace="Classes" class="TComponent">GetChildParent</method> returns nil (Delphi) or NULL (C++), the parent is assumed to be the root component currently being read (usually a form).</para>
</comments>
</member>
<member name="M:Classes.Classes.GetOwner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the owner of a component.</para>
<method namespace="Classes" class="TComponent">GetOwner</method> is called by GetNamePath to find the owner of a component. GetNamePath and <method namespace="Classes" class="TComponent">GetOwner</method> are introduced in TPersistent so descendants such as collections can appear in the Object Inspector. For <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">GetOwner</method> returns the value of the Owner property.</para>
</comments>
</member>
<member name="M:Classes.Classes.QueryInterface">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a reference to a specified interface if the object supports that interface.</para>
<method namespace="Classes" class="TComponent">QueryInterface</method> checks whether the component supports the interface specified by IID, and if so, returns a reference to that interface as the Obj parameter. If the component does not support the interface, the Obj parameter returns nil (Delphi) or NULL (C++).</para>
<para>For components that act as COM object wrapper, <method namespace="Classes" class="TComponent">QueryInterface</method> calls the <method namespace="Classes" class="TComponent">QueryInterface</method> method of the internal COM object.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes._AddRef">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Called when an application uses a component interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">_<method namespace="Classes" class="TComponent">AddRef</method> is a basic implementation of the IInterface method, <method namespace="Classes" class="TComponent">AddRef</method>.</para>
<para>If the component is a wrapper for a COM object, _<method namespace="Classes" class="TComponent">AddRef</method> calls the <method namespace="Classes" class="TComponent">AddRef</method> method of that COM object, and returns the resulting reference count.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In all other cases, _<method namespace="Classes" class="TComponent">AddRef</method> simply returns ΓÇô1 and takes no action. This allows the component to implement interfaces where reference counting is not required. More sophisticated components should override _<method namespace="Classes" class="TComponent">AddRef</method> to implement reference counting.</para>
</comments>
</member>
<member name="M:Classes.Classes._Release">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Called when an application releases a component interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">_<method namespace="Classes" class="TComponent">Release</method> is a basic implementation of the IInterface method, <method namespace="Classes" class="TComponent">Release</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">_<method namespace="Classes" class="TComponent">Release</method> returns the resulting value of the reference count for the component's interface.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In all other cases, _<method namespace="Classes" class="TComponent">Release</method> simply returns ΓÇô1 and takes no action. This allows the component to implement interfaces where reference counting is not required. More sophisticated components should override _<method namespace="Classes" class="TComponent">Release</method> to implement reference counting.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the number of type information interfaces that an object provides (either 0 or 1).</para>
<method namespace="Classes" class="TComponent">GetTypeInfoCount</method> implements the IDispatch interface <method namespace="Classes" class="TComponent">GetTypeInfoCount</method> method. For components that support interfaces, <method namespace="Classes" class="TComponent">GetTypeInfoCount</method> calls this method for the interface supported by the component. The Count parameter points to a location that receives the number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetTypeInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Retrieves the type information for an object. </para>
<method namespace="Classes" class="TComponent">GetTypeInfo</method> implements the IDispatch interface <method namespace="Classes" class="TComponent">GetTypeInfo</method> method. For components that support interfaces, <method namespace="Classes" class="TComponent">GetTypeInfo</method> calls the <method namespace="Classes" class="TComponent">GetTypeInfo</method> method for the interface supported by the component, passing it the specified parameters. Use the returned value to get the type information for an interface implemented by the component.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetIDsOfNames">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).</para>
<method namespace="Classes" class="TComponent">GetIDsOfNames</method> implements the IDispatch interface <method namespace="Classes" class="TComponent">GetIDsOfNames</method> method. For components that support interfaces, <method namespace="Classes" class="TComponent">GetIDsOfNames</method> calls this method for the interface supported by the component, passing the specified parameters. The returned value can be used on subsequent calls to the Invoke method.</para>
</comments>
</member>
<member name="M:Classes.Classes.Invoke">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides access to Automation properties and methods when the component wraps an Automation object.</para>
<method namespace="Classes" class="TComponent">Invoke</method> is the standard mechanism for accessing the exposed properties and methods of an Automation object. For components that wrap the IDispatch interface of an Automation object, <method namespace="Classes" class="TComponent">Invoke</method> calls the <method namespace="Classes" class="TComponent">Invoke</method> method for the interface supported by the component, passing it the parameters specified by the function.</para>
</comments>
</member>
<member name="M:Classes.Classes.ExecuteAction">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Invokes an action with the component as its target.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the user invokes an action, CLX makes a series of calls to respond to that action. First, it generates an OnExecute event of the action list that contains the action. If the action list does not handle the OnExecute event, then the action is routed to the Application object's <method namespace="Classes" class="TComponent">ExecuteAction</method> method, which invokes the OnActionExecute event handler. If the OnActionExecute event handler does not handle the action, then it is routed to the action's OnExecute event handler. If that does not handle the action, the active control's <method namespace="Classes" class="TComponent">ExecuteAction</method> method is called.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Action parameter specifies the action that was invoked. <method namespace="Classes" class="TComponent">ExecuteAction</method> returns true if the action was successfully dispatched, and false if the component could not handle the action. If <method namespace="Classes" class="TComponent">ExecuteAction</method> returns false for the active control, CLX calls the active form's <method namespace="Classes" class="TComponent">ExecuteAction</method> method. If this returns false, CLX tries all active controls in the form. If these all return false, CLX repeats the process with the main form, if that is different from the active form. </para>
<method namespace="Classes" class="TComponent">ExecuteAction</method> is only called for components and forms that are Visible.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">ExecuteAction</method> checks whether the action component knows how to perform its function with the component as a target, and if so, executes the action and returns true. Otherwise, <method namespace="Classes" class="TComponent">ExecuteAction</method> returns false.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendants override <method namespace="Classes" class="TComponent">ExecuteAction</method> to interpret actions in a class-specific manner and change the default behavior of the action when it specifies the descendant class as a target.</para>
</comments>
</member>
<member name="M:Classes.Classes.FindComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a given component is owned by the component.</para>
<method namespace="Classes" class="TComponent">FindComponent</method> returns the component in the Components property array with the name that matches the string in the AName parameter. Use <method namespace="Classes" class="TComponent">FindComponent</method> to determine whether a given component is owned by another.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Component name matches are not case sensitive.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the parent of a component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <method namespace="Classes" class="TComponent">GetParentComponent</method> method is introduced in <method namespace="Classes" class="TComponent">TComponent</method> for the streaming system that loads and saves CLX components. As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">GetParentComponent</method> always returns nil (Delphi) or NULL (C++). Descendant classes can override <method namespace="Classes" class="TComponent">GetParentComponent</method> to return an appropriate parent component.</para>
<para>Do not confuse a component's parent, which is responsible for writing the component to a stream, with the component's owner, which is responsible for freeing the component.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.GetNamePath">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a string used by the Object Inspector.</para>
<method namespace="Classes" class="TComponent">GetNamePath</method> is used to determine the text to display in the Object Inspector for the name of the object being edited. <method namespace="Classes" class="TComponent">GetNamePath</method> is introduced in TPersistent so descendants such as collections can appear in the Object Inspector. <method namespace="Classes" class="TComponent">TComponent</method> overrides <method namespace="Classes" class="TComponent">GetNamePath</method> to return the component's name. Do not call <method namespace="Classes" class="TComponent">GetNamePath</method> directly.</para>
</comments>
</member>
<member name="M:Classes.Classes.HasParent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the component has a parent to handle its filing.</para>
<method namespace="Classes" class="TComponent">HasParent</method> is introduced in <method namespace="Classes" class="TComponent">TComponent</method> for the streaming system that loads and saves CLX components. It returns false for <method namespace="Classes" class="TComponent">TComponent</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A return value of true indicates that some other object (a parent) is responsible for writing the object to a stream. Most commonly the parent is a form or panel that contains a control.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Any child component that returns true from <method namespace="Classes" class="TComponent">HasParent</method> must also implement the GetParentComponent and SetParentComponent methods.</para>
<para>Do not confuse a component's parent, which is responsible for writing the component to a stream, with the component's owner, which is responsible for freeing the component.</para>
<method namespace="Classes" class="TComponent">SafeCallException</method> handles exceptions in methods that use the safecall calling convention. Some classes that implement interfaces override this method to handle errors that might occur. <method namespace="Classes" class="TComponent">TComponent</method> calls the implementation of this method for the interface supported by the component, if it exists. If the component does not support interfaces, this method calls the <method namespace="Classes" class="TComponent">SafeCallException</method> method inherited from TObject, which returns E_UNEXPECTED. This is a default return value that is appropriate for classes that do not support any interfaces.</para>
</comments>
</member>
<member name="M:Classes.Classes.UpdateAction">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Updates an action component to reflect the current state of the component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the application is idle, CLX makes a series of calls to update the properties (such as whether it is enabled, checked, and so on) of every action that is linked to a visible control or menu item. First, CLX generates an OnUpdate event of the action list that contains the action. If the action list does not handle the OnUpdate event, then the action is routed to the Application object's <method namespace="Classes" class="TComponent">UpdateAction</method> method, which invokes the OnActionUpdate event handler. If the OnActionUpdate event handler does not update the action, then it is routed to the action's OnUpdate event handler. If that does not update the action, the active control's <method namespace="Classes" class="TComponent">UpdateAction</method> method is called.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Action parameter specifies the action component that should be updated. <method namespace="Classes" class="TComponent">UpdateAction</method> returns true if the action component now reflects the state of the component, and false if it did not know how to update the action. If <method namespace="Classes" class="TComponent">UpdateAction</method> returns false for the active component, CLX calls the active form's <method namespace="Classes" class="TComponent">UpdateAction</method> method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TComponent">UpdateAction</method>. It is called automatically when the application is idle. As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">UpdateAction</method> allows the action to update itself with the component as a target. Descendants can override this method to perform updates that reflect class-specific properties or states.</para>
</comments>
</member>
<member name="M:Classes.Classes.IsImplementorOf">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the component implements a specified interface.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TComponent">IsImplementorOf</method> to determine whether the component (or, if the component aggregates its interface with other components, whether the controlling component) supports the interface specified by I. <method namespace="Classes" class="TComponent">IsImplementorOf</method> is similar to the QueryInterface method, but it can handle a request for a nil (Delphi) or NULL (C++) interface, and it does not return an interface pointer.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The streaming system that loads and saves components uses <method namespace="Classes" class="TComponent">IsImplementorOf</method> to resolve property values that are interfaces.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Component writers use <method namespace="Classes" class="TComponent">ReferenceInterface</method> to ensure that properties whose values are interfaces are informed when the objects that implement those interfaces are destroyed. This notification must be in place for a property whose value is an interface to be saved with the component in a form file (that is, for such a property to persist as a published property).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">I is an interface pointer that is the value of the published property of interest.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Operation indicates whether the notification link to the implementer of the interface should be established (opInsert) or removed (opRemove).</para>
<method namespace="Classes" class="TComponent">ReferenceInterface</method> returns true if it is successful in establishing or removing the notification link. If <method namespace="Classes" class="TComponent">ReferenceInterface</method> returns false when called with Operation set to opInsert, the specified interface can't be stored as the value of a published property.</para>
<para> A result of false does not necessarily indicate an error, merely that the interface can't be stored by the property streaming system. For example, <method namespace="Classes" class="TComponent">ReferenceInterface</method> returns false when the specified interface employs true reference counting, independent of component lifetimes.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.Create">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Allocates memory and constructs a safely initialized instance of a component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">All objects have a <method namespace="Classes" class="TComponent">Create</method> method that constructs the object. <method namespace="Classes" class="TComponent">TComponent</method> redefines <method namespace="Classes" class="TComponent">Create</method> so that, for components, <method namespace="Classes" class="TComponent">Create</method> also:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">establishes the relationship of a component and its Owner, as indicated by the AOwner parameter</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">sets the ComponentStyle property to csInheritable, meaning that the component can be inherited by a descendant form type</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">It is not necessary to explicitly create components added in the form designer. These components are created automatically when the application is run, and they are destroyed when the application is closed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For components created programmatically, that is, not created in the form designer, call <method namespace="Classes" class="TComponent">Create</method> and pass in an owner component as the AOwner parameter. The owner disposes of the component when it is destroyed. If the component is not owned, then use Free when it needs to be destroyed.</para>
<para>When passing in Self as the Owner parameter, consider what Self references. If a component creates another component in one of its methods, then Self refers to the first component and not the component being created, which is then owned by the first component.</para>
<para>The <method namespace="Classes" class="TComponent">TComponent</method> constructor is virtual in part to allow polymorphic instantiation of class references. This is critical to the streaming system and to the form designer. Do not forget to use the override directive when declaring a new component's <method namespace="Classes" class="TComponent">Create</method> constructor.</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.ChangeName">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the private, internal storage for the Name property to the string passed in NewName.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not use <method namespace="Classes" class="TComponent">ChangeName</method> directly in an application. Instead, use the Name property.</para>
<para>The property setter for Name, SetName, uses <method namespace="Classes" class="TComponent">ChangeName</method> to change the component's name. <method namespace="Classes" class="TComponent">ChangeName</method> is not virtual; do not override it.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Designates methods for storing an object's unpublished data on a stream such as a form file.</para>
<method namespace="Classes" class="TComponent">TComponent</method> overrides the <method namespace="Classes" class="TComponent">DefineProperties</method> method defined in TPersistent to define "fake" Top and Left properties. These are defined so that components that are not controls can be manipulated at design-time. However, the Top and Left properties are hidden, that is, they are not published, because only controls appear at run-time.</para>
<method namespace="Classes" class="TComponent">DefineProperties</method> is virtual; descendant classes can override it. When overriding <method namespace="Classes" class="TComponent">DefineProperties</method>, be aware that the Ancestor property of Filer might be set, and that this property can determine whether or not it is appropriate to write properties.</para>
<method namespace="Classes" class="TComponent">DefineProperties</method> is called automatically as part of the component streaming system; do not call it directly.</para>
</comments>
</member>
<member name="M:Classes.Classes.GetChildren">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the interface for a method that windowed controls use to return their child components.</para>
<method namespace="Classes" class="TComponent">GetChildren</method> is introduced in <method namespace="Classes" class="TComponent">TComponent</method> for the streaming system that loads and saves CLX components. Descendant classes override <method namespace="Classes" class="TComponent">GetChildren</method> to execute the callback specified by Proc for each of their "child" components; that is, components that return this component from their GetParentComponent method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Root specifies the top-level component (such as a form or data module) that is currently being loaded or saved. Proc is a callback that loads or saves the child component.</para>
</comments>
</member>
<member name="M:Classes.Classes.Loaded">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the component after the form file has been read into memory.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the protected <method namespace="Classes" class="TComponent">Loaded</method> method. The streaming system calls this method after it loads the component's form from a stream.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the streaming system loads a form or data module from its form file, it first constructs the form component by calling its constructor, then reads its property values from the form file. After reading all the property values for all the components, the streaming system calls the <method namespace="Classes" class="TComponent">Loaded</method> methods of each component in the order the components were created. This gives the components a chance to initialize any data that depends on the values of other components or other parts of itself.</para>
<para>All references to sibling components are resolved by the time <method namespace="Classes" class="TComponent">Loaded</method> is called. <method namespace="Classes" class="TComponent">Loaded</method> is the first place that sibling pointers can be used after being streamed in.</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">Loaded</method> clears the csLoading flag in the ComponentState property, indicating that the component is no longer loading.</para>
<method namespace="Classes" class="TComponent">Loaded</method> may be called multiple times on inherited forms. It is called every time a level of inheritance is streamed in. Do not allocate memory in an overridden <method namespace="Classes" class="TComponent">Loaded</method> method without first checking that the memory has not been allocated in a previous call.</para>
</warning>
</comments>
</member>
<member name="M:Classes.Classes.Notification">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Forwards notification messages to all owned components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the <method namespace="Classes" class="TComponent">Notification</method> method in an application. <method namespace="Classes" class="TComponent">Notification</method> is called automatically when the component specified by AComponent is about to be inserted or removed, as specified by Operation. By default, components pass along the notification to their owned components, if any.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A component can, if needed, act on the notification that a component is being inserted or removed. For example, if a component has object fields or properties that contain references to other components, it can check the notifications of component removals and invalidate those references as needed.</para>
<method namespace="Classes" class="TComponent">Notification</method> is not called for components that are freed implicitly (because their Owner is freed).</para>
</note>
</comments>
</member>
<member name="M:Classes.Classes.PaletteCreated">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when the component is created from the component palette.</para>
<method namespace="Classes" class="TComponent">PaletteCreated</method> is called automatically at design time when the component has just been created from the component palette. Component writers can override this method to perform adjustments that are required only when the component is created from the component palette.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">PaletteCreated</method> does nothing.</para>
</comments>
</member>
<member name="M:Classes.Classes.ReadState">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads the component's data from a stream.</para>
<method namespace="Classes" class="TComponent">ReadState</method> is part of a sequence of calls used by the streaming system that loads and saves CLX components. It reads the values of all the component's published properties, stored data, and owned components from the reader object passed in Reader. Do not call <method namespace="Classes" class="TComponent">ReadState</method> directly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Although <method namespace="Classes" class="TComponent">ReadState</method> is virtual, it is rarely overridden. Any descendant classes overriding <method namespace="Classes" class="TComponent">ReadState</method> should end with a call to the inherited <method namespace="Classes" class="TComponent">ReadState</method> method of <method namespace="Classes" class="TComponent">TComponent</method>.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetAncestor">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets or clears the ComponentState property's csAncestor flag.</para>
<method namespace="Classes" class="TComponent">SetAncestor</method> is used internally by the streaming system that loads and saves CLX components. Do not call <method namespace="Classes" class="TComponent">SetAncestor</method> directly.</para>
<method namespace="Classes" class="TComponent">SetAncestor</method> sets or clears the csAncestor flag, which indicates whether the component was introduced in an ancestor form. <method namespace="Classes" class="TComponent">SetAncestor</method> then calls the <method namespace="Classes" class="TComponent">SetAncestor</method> methods of any owned components, passing Value, so that the owned components' ComponentState properties will be synchronized with the owner's.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetDesigning">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ensures that components inserted at design time have their design-mode flag set.</para>
<method namespace="Classes" class="TComponent">SetDesigning</method> is used internally by the Form designer. Do not call <method namespace="Classes" class="TComponent">SetDesigning</method> directly.</para>
<method namespace="Classes" class="TComponent">SetDesigning</method> sets the csDesigning flag in the ComponentState property if Value is true; otherwise, it removes csDesigning. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the SetChildren parameter is true, <method namespace="Classes" class="TComponent">SetDesigning</method> then calls the <method namespace="Classes" class="TComponent">SetDesigning</method> methods of any owned components, passing Value, so that the owned components' ComponentState properties are synchronized with the owner's.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The InsertComponent and RemoveComponent methods call <method namespace="Classes" class="TComponent">SetDesigning</method> for inserted or removed components to ensure that their design-mode flags are set properly.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetInline">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the csInline bit of the component's ComponentState property</para>
<method namespace="Classes" class="TComponent">SetInline</method> is used internally to indicate whether the component can act as a root component in the designer but also be embedded in a form.</para>
<method namespace="Classes" class="TComponent">SetInline</method> sets the csInline flag in the ComponentState property if Value is true; otherwise, it removes csInline. </para>
<method namespace="Classes" class="TComponent">SetDesignInstance</method> is used internally by the Form designer to identify objects that act as a design surface. Do not call <method namespace="Classes" class="TComponent">SetDesignInstance</method> directly.</para>
<method namespace="Classes" class="TComponent">SetDesignInstance</method> sets the csDesignInstance flag in the ComponentState property if Value is true; otherwise, it removes csDesignInstance. </para>
</comments>
</member>
<member name="M:Classes.Classes.SetChildOrder">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the interface for a method to rearrange child components.</para>
<method namespace="Classes" class="TComponent">SetChildOrder</method> is introduced in <method namespace="Classes" class="TComponent">TComponent</method> for the streaming system that loads and saves CLX components. As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">SetChildOrder</method> does nothing. Descendant classes override <method namespace="Classes" class="TComponent">SetChildOrder</method> to change the order in which a child appears list returned by GetChildren.</para>
<method namespace="Classes" class="TComponent">SetParentComponent</method> is introduced in <method namespace="Classes" class="TComponent">TComponent</method> for the streaming system that loads and saves CLX components. <method namespace="Classes" class="TComponent">SetParentComponent</method> does nothing in <method namespace="Classes" class="TComponent">TComponent</method>. Descendant classes override <method namespace="Classes" class="TComponent">SetParentComponent</method> to change the value that GetParentComponent returns to match the Value parameter.</para>
</comments>
</member>
<member name="M:Classes.Classes.Updating">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the cs<method namespace="Classes" class="TComponent">Updating</method> state in the component's ComponentState property. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TComponent">Updating</method> directly. It is used internally to indicate that the component is about to be updated. A call to <method namespace="Classes" class="TComponent">Updating</method>, which sets the cs<method namespace="Classes" class="TComponent">Updating</method> flag, is always followed by a call to Updated, which clears the flag.</para>
</comments>
</member>
<member name="M:Classes.Classes.Updated">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Clears the csUpdating state in the component's ComponentState property when the component finishes updating.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TComponent">Updated</method> directly. It is used internally to clear the csUpdating flag of the ComponentState property. A call to <method namespace="Classes" class="TComponent">Updated</method> always follows a call to Updating, which sets the flag.</para>
</comments>
</member>
<member name="M:Classes.Classes.UpdateRegistry">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TComponent">UpdateRegistry</method> directly. It is for internal use only. </para>
</comments>
</member>
<member name="M:Classes.Classes.ValidateRename">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ensures that renaming an owned component does not create name conflict.</para>
<method namespace="Classes" class="TComponent">ValidateRename</method> checks to see if a component can rename one of its owned components, passed in AComponent, from its current name (CurName) to the string passed in NewName. If AComponent is nil (Delphi) or NULL (C++) or NewName is already the name of a component in the Components list, <method namespace="Classes" class="TComponent">ValidateRename</method> raises an EComponentError exception.</para>
<method namespace="Classes" class="TComponent">ValidateRename</method> is used internally when the Name property is modified. It is not necessary to call it directly.</para>
<method namespace="Classes" class="TComponent">ValidateContainer</method> is called by a component when it is about to be inserted into a container object. By default, <method namespace="Classes" class="TComponent">ValidateContainer</method> calls the ValidateInsert method of the component specified by the AComponent parameter. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendant components can override <method namespace="Classes" class="TComponent">ValidateContainer</method> to disallow a component from being inserted into specific containers. To disallow an insertion, raise an exception in the derived method.</para>
</comments>
</member>
<member name="M:Classes.Classes.ValidateInsert">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides the interface for a method that validates an child component before it is inserted.</para>
<method namespace="Classes" class="TComponent">ValidateInsert</method> does nothing in <method namespace="Classes" class="TComponent">TComponent</method>. Descendant classes can override it to disallow a component from accepting an object as a child. By default <method namespace="Classes" class="TComponent">ValidateInsert</method> allows any object to be inserted into the component. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If a component needs to validate only certain objects, descendant classes can override <method namespace="Classes" class="TComponent">ValidateInsert</method> to filter out those objects. To disallow an insertion, raise an exception in the derived method.</para>
</comments>
</member>
<member name="M:Classes.Classes.WriteState">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the component's data to a stream.</para>
<method namespace="Classes" class="TComponent">WriteState</method> is part of a sequence of calls used by the streaming system that loads and saves CLX components. <method namespace="Classes" class="TComponent">WriteState</method> is an iterative method that writes the values of all the component's published properties and other stored data to the Writer component passed as the Writer parameter. Do not call <method namespace="Classes" class="TComponent">WriteState</method> directly.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Although <method namespace="Classes" class="TComponent">WriteState</method> is virtual, it is rarely overridden. Any descendant classes overriding <method namespace="Classes" class="TComponent">WriteState</method> should end with a call to the <method namespace="Classes" class="TComponent">WriteState</method> method inherited from <method namespace="Classes" class="TComponent">TComponent</method>.</para>
<method namespace="Classes" class="TComponent">BeforeDestruction</method> is called automatically immediately before the component's first destructor executes. Do not call it explicitly in your applications.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">As implemented in <method namespace="Classes" class="TComponent">TComponent</method>, <method namespace="Classes" class="TComponent">BeforeDestruction</method> checks whether the Destroying method has been called, and if not, calls it. Descendants that override this method to perform other actions before a component is destroyed should call the inherited method first to ensure that this check takes place.</para>
<method namespace="Classes" class="TComponent">DestroyComponents</method> iterates through the components owned by the component, removing each from the list of owned components and destroying it.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">It is not necessary to call <method namespace="Classes" class="TComponent">DestroyComponents</method> directly. <method namespace="Classes" class="TComponent">DestroyComponents</method> is automatically called when the component is destroyed.</para>
</comments>
</member>
<member name="M:Classes.Classes.Destroying">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates that the component and its owned components are about to be destroyed.</para>
<method namespace="Classes" class="TComponent">Destroying</method> sets the cs<method namespace="Classes" class="TComponent">Destroying</method> flag in the ComponentState property. It then calls the <method namespace="Classes" class="TComponent">Destroying</method> method for each owned component so that their cs<method namespace="Classes" class="TComponent">Destroying</method> flags are also set. If cs<method namespace="Classes" class="TComponent">Destroying</method> is already set, <method namespace="Classes" class="TComponent">Destroying</method> does nothing.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">It is not necessary to call <method namespace="Classes" class="TComponent">Destroying</method> directly. <method namespace="Classes" class="TComponent">Destroying</method> is automatically called when the component is destroyed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ensures that AComponent is notified that the component is going to be destroyed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TComponent">FreeNotification</method> to register AComponent as a component that should be notified when the component is about to be destroyed. It is only necessary to register components this way when they are in a different form or have a different owner. For example, if AComponent is in another form and uses the component to implement a property, it must call <method namespace="Classes" class="TComponent">FreeNotification</method> so that its Notification method is called when the component is destroyed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For components with the same owner, the Notification method is called automatically when an application explicitly frees the component. This notification is not sent out when components are freed implicitly, because the Owner is already being freed.</para>
<method namespace="Classes" class="TComponent">RemoveFreeNotification</method> removes the component specified by the AComponent parameter from the internal list of objects to be notified that the component is about to be destroyed. AComponent is added to this list by a previous call to the FreeNotification method.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Most applications have no need to call <method namespace="Classes" class="TComponent">RemoveFreeNotification</method>. It is used by <method namespace="Classes" class="TComponent">TComponent</method> to detect loops where two components are notifying each other of their impending destruction.</para>
</comments>
</member>
<member name="M:Classes.Classes.FreeOnRelease">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees the interface reference for components that were created from COM classes. </para>
<method namespace="Classes" class="TComponent">FreeOnRelease</method> is called when an interface implemented by the component is released. <method namespace="Classes" class="TComponent">FreeOnRelease</method> is used internally and calls the corresponding interface method. It should not be necessary to call <method namespace="Classes" class="TComponent">FreeOnRelease</method> directly.</para>
</comments>
</member>
<member name="M:Classes.Classes.InsertComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Establishes the component as the owner of a specified component.</para>
<method namespace="Classes" class="TComponent">InsertComponent</method> adds the component passed in the AComponent parameter to the end of the Components array property. The inserted component must have no name (no specified Name property value), or the name must be unique among all others in the Components list.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the owning component is destroyed, AComponent is destroyed also.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Components are automatically inserted and removed when visually manipulating them in the form designer. Use <method namespace="Classes" class="TComponent">InsertComponent</method> when manually adding components to another Owner component's Components list.</para>
</comments>
</member>
<member name="M:Classes.Classes.RemoveComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Removes a specified component specified from the component's Components list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Components are automatically inserted and removed when visually manipulating them in the form designer. Use <method namespace="Classes" class="TComponent">RemoveComponent</method> to programmatically delete the component specified by AComponent from its Owner component.</para>
</comments>
</member>
<member name="M:Classes.Classes.SetSubComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies whether the component is a subcomponent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TComponent">SetSubComponent</method> to indicate that this component is or is not a subcomponent. A subcomponent is a component whose Owner is a component other than the form or data module in which it resides. Unless such a component calls <method namespace="Classes" class="TComponent">SetSubComponent</method> with IsSubComponent set to true, its published properties will not be saved to the form file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">IsSubComponent indicates whether the component is a subcomponent (true) or not (false).</para>
<method namespace="Classes" class="TComponent">SetSubComponent</method> is called at design time either</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">From the constructor of a component that always acts as a subcomponent. In this case, the component calls its own <method namespace="Classes" class="TComponent">SetSubComponent</method> method from the constructor with IsSubComponent set to true.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Immediately after constructing an instance of the subcomponent. In this case, the Owner calls the <method namespace="Classes" class="TComponent">SetSubComponent</method> method of a component it has just instantiated, with IsSubComponent set to true.</para>
</comments>
</member>
<member name="M:Classes.Classes.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Disposes of the component and its owned components.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TComponent">Destroy</method> directly. Call Free instead. Free verifies that the component is not nil, and only then calls <method namespace="Classes" class="TComponent">Destroy</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Never explicitly free a component in one of its own event handlers, nor free a component from the event handler of a component that it owns or contains.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To destroy a form, call its Release method. Release waits for all the form's event handlers and the event handlers of the form's components to finish executing before destroying the form.</para>
<para>A form owns all the controls and non-visual components that are placed on it in design mode. When it is freed, all of these components are automatically freed as well. By default, all forms are owned by the global Application object. When an application terminates, it frees the global Application object, which frees all forms. For objects that are not components, and for components created with a nil owner, be sure to call Free after finishing with the object; otherwise the memory allocated for the object will be lost until the application terminates.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.ComObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the interface reference implemented by the component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">ComObject</property> to assign a COM interface implemented by a component to an interface reference. This property is used by components that support COM interfaces. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the component is not a wrapper for a COM component, trying to read <property namespace="Classes" class="TComponent">ComObject</property> causes <property namespace="Classes" class="TComponent">TComponent</property> to raise an EComponentError exception.</para>
</comments>
</member>
<member name="P:Classes.Classes.Components">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists all components owned by the component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">Components</property> to access any of the components owned by this component, such as the components owned by a form. The <property namespace="Classes" class="TComponent">Components</property> property is most useful when referring to owned components by number rather than name. It is also used internally for iterative processing of all owned components.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index ranges from 0 to ComponentIndex minus 1.</para>
</comments>
</member>
<member name="P:Classes.Classes.ComponentCount">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of components owned by the component.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">ComponentCount</property> to find or verify the number of components owned by a component, or when iterating through the Components list to perform some action on all owned components. <property namespace="Classes" class="TComponent">ComponentCount</property> is used internally for such iterative procedures.</para>
<para>The <property namespace="Classes" class="TComponent">ComponentCount</property> of a component contains the same number of items as in the Components list for that component, and is always 1 more than the highest Components index, because the first Components index is always 0. </para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.ComponentIndex">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the position of the component in its owner's Components property array.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">ComponentIndex</property> when iterating through the Components list of the component's owner to perform some action on owned components. It can be used in conjunction with ComponentCount. <property namespace="Classes" class="TComponent">ComponentIndex</property> is used internally for iterative assignment procedures. </para>
<para>The first component in the list has a <property namespace="Classes" class="TComponent">ComponentIndex</property> value of 0, the second has a value of 1, and so on. Therefore, when using <property namespace="Classes" class="TComponent">ComponentIndex</property> with ComponentCount, note that ComponentCount is always 1 more than the highest Components index.</para>
</note>
</comments>
</member>
<member name="P:Classes.Classes.ComponentState">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the current state of the component, indicating when a component needs to avoid certain actions.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Components use the <property namespace="Classes" class="TComponent">ComponentState</property> property to detect states in which certain kinds of actions are allowed or disallowed. For example, if a component needs to avoid certain behaviors at design time that it performs at runtime, it can check for the csDesigning flag. <property namespace="Classes" class="TComponent">ComponentState</property> is read-only and its flags are set automatically when appropriate.</para>
</comments>
</member>
<member name="P:Classes.Classes.ComponentStyle">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Governs the behavior of the component.</para>
<property namespace="Classes" class="TComponent">ComponentStyle</property> governs how the component interacts with the streaming system and the Object Inspector. <property namespace="Classes" class="TComponent">ComponentStyle</property> is a read-only property. Typically, the value of the various component style flags are part of a component's definition, specified in a component's constructor. The one exception to this is the csSubComponent style, which can be set by calling the SetSubComponent method.</para>
</comments>
</member>
<member name="P:Classes.Classes.DesignInfo">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains information used by the Form designer.</para>
<property namespace="Classes" class="TComponent">DesignInfo</property> is used internally. Do not use this property in applications.</para>
</comments>
</member>
<member name="P:Classes.Classes.Owner">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the component that is responsible for streaming and freeing this component. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">Owner</property> to find the owner of a component. The <property namespace="Classes" class="TComponent">Owner</property> of a component is responsible for two things:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The memory for the owned component is freed when its owner's memory is freed. This means that when a form is destroyed, all the components on the form are also destroyed.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="Classes" class="TComponent">Owner</property> is responsible for loading and saving the published properties of its owned controls.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, a form owns all components that are on it. In turn, the form is owned by the application. Thus when the application shuts down and its memory is freed, the memory for all forms (and all their owned components) is also freed. When a form is loaded into memory, it loads all of the components that are on it.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The owner of a component is determined by the parameter passed to the constructor when the component is created. For components created in the form designer, the form is automatically assigned as the <property namespace="Classes" class="TComponent">Owner</property>.</para>
<para>If a component has an <property namespace="Classes" class="TComponent">Owner</property> other than a form or data module, it will not be saved or loaded with its <property namespace="Classes" class="TComponent">Owner</property> unless you identify it as a subcomponent. To identify a component as a subcomponent, call the SetSubComponent method.</para>
</warning>
</comments>
</member>
<member name="P:Classes.Classes.VCLComObject">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents information used internally by components that support COM.</para>
<property namespace="Classes" class="TComponent">VCLComObject</property> is for internal use only. To access the interfaces implemented by a CLX COM component, use the ComObject property instead.</para>
</comments>
</member>
<member name="P:Classes.Classes.Name">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the name of the component as referenced in code.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">Name</property> to change the name of a component to reflect its purpose in the current application. By default, the IDE assigns sequential names based on the type of the component, such as 'Button1', 'Button2', and so on.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TComponent">Name</property> to refer to the component in code.</para>
<para>Changing <property namespace="Classes" class="TComponent">Name</property> at runtime causes any references to the old name to become undefined. Any subsequent code that uses the old name will cause an exception.</para>
</warning>
</comments>
</member>
<member name="P:Classes.Classes.Tag">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Stores an integer value as part of a component. </para>
<property namespace="Classes" class="TComponent">Tag</property> has no predefined meaning. The <property namespace="Classes" class="TComponent">Tag</property> property is provided for the convenience of developers. It can be used for storing an additional integer value or it can be typecast to any 32-bit value such as a component reference or a pointer.</para>
<class namespace="Classes">TBasicActionLink</class> is the base class for action link classes that handle the communication between actions and clients.</para>
<class namespace="Classes">TBasicActionLink</class> is the base class from which all other action link classes ultimately descend. TBasicAction link lays the foundation for the connection between action and the client. The client is a parameter to the <class namespace="Classes">TBasicActionLink</class> constructor, and the action object is indicated by the Action property. <class namespace="Classes">TBasicActionLink</class> sets up the link between the action and client execution and updating events.</para>
</comments>
</member>
<member name="M:Classes.Classes.Execute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Invokes the action's <method namespace="Classes" class="TBasicActionLink">Execute</method> method.</para>
<method namespace="Classes" class="TBasicActionLink">Execute</method> calls the action's <method namespace="Classes" class="TBasicActionLink">Execute</method> method and returns true if the action has an assigned On<method namespace="Classes" class="TBasicActionLink">Execute</method> event handler, false otherwise. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AComponent is the client component that the user clicked to execute the action.</para>
</comments>
</member>
<member name="M:Classes.Classes.Update">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Invokes the action's <method namespace="Classes" class="TBasicActionLink">Update</method> method.</para>
<method namespace="Classes" class="TBasicActionLink">Update</method> calls the action's <method namespace="Classes" class="TBasicActionLink">Update</method> method and returns true if the action has an assigned On<method namespace="Classes" class="TBasicActionLink">Update</method> event handler, false otherwise. The action link's <method namespace="Classes" class="TBasicActionLink">Update</method> method is called if the client is linked to the action for this event.</para>
</comments>
</member>
<member name="M:Classes.Classes.Create">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Instantiates and initializes a <method namespace="Classes" class="TBasicActionLink">TBasicActionLink</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications do not need to call the constructor directly. Instances of <method namespace="Classes" class="TBasicActionLink">TBasicActionLink</method> are created automatically when you connect an action with a client in the action list editor. The AClient parameter is the client for the link. The link connects this client to its action.</para>
<method namespace="Classes" class="TBasicActionLink">Create</method> ensures that the client is of the appropriate type for the particular type of link. Descendant classes can progressively specify more customized client types. For example, there are action link classes for controls, for windowed controls, and for button controls.</para>
<method namespace="Classes" class="TBasicActionLink">Destroy</method>s an instance of an action link object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">You do not need to destroy the action link; it is automatically destroyed by the client that was passed to its constructor when it was created.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If you want to destroy the action link manually, do not call the destructor directly. Call Free instead. Free checks that the link is not nil, and only then invokes the destructor.</para>
</comments>
</member>
<member name="P:Classes.Classes.Action">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which action the link connects to its client.</para>
<property namespace="Classes" class="TBasicActionLink">Action</property> is the action object that the link associates with its client.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnChange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when an <event namespace="Classes" class="TBasicActionLink">OnChange</event> event is triggered on the action.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TBasicActionLink">OnChange</event> event handler when you want to respond to a change that occurs when the associated action fires an <event namespace="Classes" class="TBasicActionLink">OnChange</event> event.</para>
<class namespace="Classes">TBasicAction</class> introduces the fundamental behavior for an action. Descendants of <class namespace="Classes">TBasicAction</class> add functionality for containment in an action list, for being categorized, and for specializing their behavior tailored to particular clients such as controls or menu items. Use <class namespace="Classes">TBasicAction</class> if you want to create an action for an object that is neither a menu item nor a control.</para>
</comments>
</member>
<member name="M:Classes.Classes.HandlesTarget">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an interface for verifying that the type, and state, of a target component or control are appropriate for the action.</para>
<method namespace="Classes" class="TBasicAction">HandlesTarget</method> does nothing in <method namespace="Classes" class="TBasicAction">TBasicAction</method>. <method namespace="Classes" class="TBasicAction">HandlesTarget</method> was introduced in <method namespace="Classes" class="TBasicAction">TBasicAction</method> so that descendants can override it to check the type and state of a target. Handles target can verify any information about a target that is relevant for the action. <method namespace="Classes" class="TBasicAction">HandlesTarget</method> returns true if the target meets the specified criteria, false otherwise.</para>
</comments>
</member>
<member name="M:Classes.Classes.Execute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="Classes" class="TBasicAction">Execute</method> event.</para>
<method namespace="Classes" class="TBasicAction">Execute</method> calls the On<method namespace="Classes" class="TBasicAction">Execute</method> event handler, if one is assigned, with the action as the Sender. <method namespace="Classes" class="TBasicAction">Execute</method> returns true if an event handler is called, false otherwise.</para>
</comments>
</member>
<member name="M:Classes.Classes.Update">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides an opportunity to execute centralized code when an application is idle.</para>
<method namespace="Classes" class="TBasicAction">Update</method> triggers the On<method namespace="Classes" class="TBasicAction">Update</method> event handler. <method namespace="Classes" class="TBasicAction">Update</method> returns true if a handler was found for that event, false otherwise. When the application is idle, the On<method namespace="Classes" class="TBasicAction">Update</method> event occurs for every action. This provides an opportunity for applications to execute centralized code for enabling and disabling, checking and unchecking, and so on.</para>
</comments>
</member>
<member name="M:Classes.Classes.Create">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Instantiates and initializes a <method namespace="Classes" class="TBasicAction">TBasicAction</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications do not need to instantiate <method namespace="Classes" class="TBasicAction">TBasicAction</method> directly. Actions are created automatically when you choose New Action in the action list editor. If you want to create an action at runtime, call <method namespace="Classes" class="TBasicAction">Create</method> and assign a TActionList component to its ActionList property.</para>
<method namespace="Classes" class="TBasicAction">Create</method> calls the inherited constructor and then creates its sub-objects, which includes a list of clients that are action links.</para>
</comments>
</member>
<member name="M:Classes.Classes.Change">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="Classes" class="TBasicAction">Change</method> event.</para>
<method namespace="Classes" class="TBasicAction">Change</method> is called automatically when the action's properties change. This method calls the On<method namespace="Classes" class="TBasicAction">Change</method> event handler, if one is assigned.</para>
</comments>
</member>
<member name="M:Classes.Classes.Notification">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when components are created or destroyed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the <method namespace="Classes" class="TBasicAction">Notification</method> method in an application. <method namespace="Classes" class="TBasicAction">Notification</method> is called automatically when the component specified by AComponent is about to be inserted or removed, as specified by Operation. </para>
<method namespace="Classes" class="TBasicAction">TBasicAction</method> overrides the <method namespace="Classes" class="TBasicAction">Notification</method> method to check whether the component that is the value of the ActionComponent property is about to be freed. If so, it sets the ActionComponent property to nil (Delphi) or NULL (C++).</para>
</comments>
</member>
<member name="M:Classes.Classes.UpdateTarget">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an interface for a method of notifying a client when the action updates itself.</para>
<method namespace="Classes" class="TBasicAction">UpdateTarget</method> does nothing in <method namespace="Classes" class="TBasicAction">TBasicAction</method>. <method namespace="Classes" class="TBasicAction">UpdateTarget</method> was introduced in <method namespace="Classes" class="TBasicAction">TBasicAction</method> so that descendants can override it to correspondingly update a target when the action updates. For examples, see the TEditAction objects in the stdactns unit.</para>
</comments>
</member>
<member name="M:Classes.Classes.ExecuteTarget">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Introduces an interface for invoking an action on a target client component or control.</para>
<method namespace="Classes" class="TBasicAction">ExecuteTarget</method> does nothing in <method namespace="Classes" class="TBasicAction">TBasicAction</method>. <method namespace="Classes" class="TBasicAction">ExecuteTarget</method> was introduced in <method namespace="Classes" class="TBasicAction">TBasicAction</method> so that descendants can override it to initiate the action on the target. For example, an edit action that performs copying might copy the contents of an edit control to the clipboard.</para>
</comments>
</member>
<member name="M:Classes.Classes.RegisterChanges">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Associates the action with an action link.</para>
<method namespace="Classes" class="TBasicAction">RegisterChanges</method> is called when the action and link are connected, for example, when a link sets a new action. Value is the action link with which the action associates itself. The link is added to the action's client list.</para>
<method namespace="Classes" class="TBasicAction">UnRegisterChanges</method> is called when the action and link should no longer be associated. <method namespace="Classes" class="TBasicAction">UnRegisterChanges</method> is called, for example, in the destructor or when a link sets a new action. Value is the action link with which the association is broken.</para>
</comments>
</member>
<member name="M:Classes.Classes.Destroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Disposes of an instance of a <method namespace="Classes" class="TBasicAction">TBasicAction</method> object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">You do not need to call the destructor for an action. An action is a component and is automatically destroyed by its owner, which was passed to the constructor when it is created. If you must destroy an action manually, call Free instead, which safely invokes the destructor.</para>
</comments>
</member>
<member name="P:Classes.Classes.ActionComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the client component that caused this action to execute.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Classes" class="TBasicAction">ActionComponent</property> to discern which client component caused this action to execute. For example, examine <property namespace="Classes" class="TBasicAction">ActionComponent</property> from an OnExecute event handler if you need to know what user action triggered this action.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the user clicks a client control, that client sets <property namespace="Classes" class="TBasicAction">ActionComponent</property> before calling the action's Execute method. After the action executes, the action resets <property namespace="Classes" class="TBasicAction">ActionComponent</property> to nil (Delphi) or NULL (C++).</para>
</comments>
</member>
<member name="E:Classes.Classes.OnChange">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when one of the action's properties changes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Applications can't use the protected <event namespace="Classes" class="TBasicAction">OnChange</event> event. It is used internally to manage the relationship between the properties of the action and the corresponding properties of the action's clients.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Component writers can use <event namespace="Classes" class="TBasicAction">OnChange</event> in descendant objects to respond when the action's properties change.</para>
</comments>
</member>
<member name="E:Classes.Classes.OnExecute">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the client event that is linked to it fires.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TBasicAction">OnExecute</event> event handler when you want to respond when the user triggers the client object's default event (typically an OnClick event). For most target clients, <event namespace="Classes" class="TBasicAction">OnExecute</event> is triggered on a Click method, and is associated with the OnClick event.</para>
<event namespace="Classes" class="TBasicAction">OnExecute</event> also occurs when the user types the shortcut <condition os="Windows">(or one of the secondary shortcuts) </condition>associated with the action or its client.</para>
<para>If you assign an <event namespace="Classes" class="TBasicAction">OnExecute</event> event handler to a predefined action, the default behavior of that action will not occur.</para>
</warning>
</comments>
</member>
<member name="E:Classes.Classes.OnUpdate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the application is idle or when the action list updates.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TBasicAction">OnUpdate</event> event handler to execute centralized code while an application is idle. For example, actions may want to update enabling and disabling, or checking and unchecking of client targets.</para>
<class namespace="Classes">TDataModule</class> centralizes the handling of nonvisual components in an application.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use a <class namespace="Classes">TDataModule</class> object in an application to provide a location for centralized handling of nonvisual components. Typically these are data access components, such as TSQLDataSet, and TSQLConnection. DataModules are not limited to data access components, they can also contain other nonvisual components, such as TTimer, TOpenDialog, or TImageList).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time a <class namespace="Classes">TDataModule</class> object provides a visual container into which a developer can place nonvisual components, set their properties, and write event handlers for them. To create a data module at design time, choose File | New Data Module.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">In the unit file for the data module a developer may also place any business rules that are to be applied to the application.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To make the data module available to another unit in the application, select that unit, then choose File|Use Unit (when working in Delphi) or File|Include Unit Header (when working in C++) to add the data module to the uses clause for the unit.</para>
<method namespace="Classes" class="TDataModule">Create</method>s an instance of a data module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Classes" class="TDataModule">Create</method> to instantiate a data module at runtime if it was not created at design time. <method namespace="Classes" class="TDataModule">Create</method> calls <method namespace="Classes" class="TDataModule">Create</method>New. If an error occurs, an exception is raised. Otherwise, if Old<method namespace="Classes" class="TDataModule">Create</method>Order is true, <method namespace="Classes" class="TDataModule">Create</method> calls the On<method namespace="Classes" class="TDataModule">Create</method> event handler for the data module if one is assigned to it.</para>
</comments>
</member>
<member name="M:Classes.Classes.CreateNew">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates an instance of a data module and registers with the global screen object.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Classes" class="TDataModule">CreateNew</method> instead of Create to create a data module without using the associated .form file to initialize it.</para>
<para>Using <method namespace="Classes" class="TDataModule">CreateNew</method> instead of Create can cause unpredictable results because most data modules are written assuming their controls will be created from the form file.</para>
<method namespace="Classes" class="TDataModule">CreateNew</method> calls the inherited constructor, and then informs the global screen object of the existence of the data module.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The first argument, AOwner, is the owner of the data module (usually the application). The second argument, Dummy, defaults to 0 and is not used by this constructor. The system passes 0 by default if this constructor is passed only the first argument, AOwner.</para>
<method namespace="Classes" class="TDataModule">CreateNew</method> bypasses the streaming in of the previously associated form file. Therefore, you must stream in an external form file to bind the visual components with their classes. You can stream in the previously associated form file by calling InitInheritedComponent. To stream in a different form file, bracket the call to <method namespace="Classes" class="TDataModule">CreateNew</method> with calls to WriteComponentResFile and ReadComponentResFile. The following code sequence</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1. streams out an external form file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2. creates a new data module disassociated from any form file;</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3. streams in the external form file and binds it to this new data module.</para>
<method namespace="Classes" class="TDataModule">AfterConstruction</method> is called after the data module's constructor has finished. Do not call it explicitly in applications. </para>
<method namespace="Classes" class="TDataModule">TDataModule</method> overrides <method namespace="Classes" class="TDataModule">AfterConstruction</method> to generate an OnCreate event when OldCreateOrder is false.</para>
<method namespace="Classes" class="TDataModule">BeforeDestruction</method> is called immediately before the data module's destructor. Do not call it explicitly in applications.</para>
<method namespace="Classes" class="TDataModule">TDataModule</method> overrides <method namespace="Classes" class="TDataModule">BeforeDestruction</method> to generate an OnDestroy event when OldCreateOrder is false.</para>
<method namespace="Classes" class="TDataModule">Destroy</method>s the instance of the data module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="Classes" class="TDataModule">Destroy</method> directly. Instead call Free, which checks that the data module reference is not nil before calling <method namespace="Classes" class="TDataModule">Destroy</method>.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Before calling the inherited destructor, <method namespace="Classes" class="TDataModule">Destroy</method> removes any fixup references, calls its On<method namespace="Classes" class="TDataModule">Destroy</method> event handler (if one is defined and OldCreateOrder is true), and informs the global screen variable that the data module is going away.</para>
</comments>
</member>
<member name="P:Classes.Classes.DesignOffset">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the design offset for the data module at design time.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An application should never need to set this value. It is used to control the position of the data module at design time.</para>
</comments>
</member>
<member name="P:Classes.Classes.DesignSize">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the design size for the data module at design time.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An application should never need to set this value. It controls the size of the data module window at design time.</para>
</comments>
</member>
<member name="P:Classes.Classes.OldCreateOrder">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies when OnCreate and OnDestroy events occur.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="Classes" class="TDataModule">OldCreateOrder</property> is false (the default) the OnCreate event occurs after all constructors are finished (from the AfterConstruction method) and the OnDestroy event occurs before any destructors are called (from the BeforeDestruction method).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="Classes" class="TDataModule">OldCreateOrder</property> is true, OnCreate is triggered from the data module constructor and OnDestroy from the data module destructor.</para>
<para>This timing differs from Delphi version 3 and previous and from C++Builder version 1, where the OnCreate event occurred when the <property namespace="Classes" class="TDataModule">TDataModule</property> constructor executed and the OnDestroy event occurred when the <property namespace="Classes" class="TDataModule">TDataModule</property> destructor executed. Applications that require the OnCreate event and OnDestroy events to occur from the constructor and destructor of the data module can set <property namespace="Classes" class="TDataModule">OldCreateOrder</property> to true.</para>
</note>
</comments>
</member>
<member name="E:Classes.Classes.OnCreate">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when an application instantiates a data module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TDataModule">OnCreate</event> event handler to take specific actions when an application instantiates a data module. For example, if a data module contains database and dataset components, an application may establish a database connection immediately. If the data module contains timers, the application may initialize them.</para>
<para>Use of the <event namespace="Classes" class="TDataModule">OnCreate</event> event is discouraged in C++ because it can interact badly with the data module's constructor (see OldCreateOrder). It is recommended that you override the constructor instead.</para>
</note>
</comments>
</member>
<member name="E:Classes.Classes.OnDestroy">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the data module is about to be destroyed.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Classes" class="TDataModule">OnDestroy</event> event handler to take specific actions when an application frees a data module. For example, if the unit code for the data module instantiates any objects of its own, such as string lists, the <event namespace="Classes" class="TDataModule">OnDestroy</event> event handler can be used to free those objects.</para>
<type namespace="Qt">TStreamOriginalFormat</type> indicates the format in which a form file is saved.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Form files can be saved in binary format or as a text file, depending on the options set in the Environment Options dialog. <type namespace="Qt">TStreamOriginalFormat</type> specifies the format used for saving a form file. It is one of the following values:</para>
<para>The format of the file from which a form is being read or to which it is being written is unknown. If the format can't be deduced from the stream, an exception is raised.</para>
</td>
</tr>
<tr>
<td>
<para>sofBinary</para>
</td>
<td>
<para>The form is being read from or written to a form file that uses binary format.</para>
</td>
</tr>
<tr>
<td>
<para>sofText</para>
</td>
<td>
<para>The form is being read from or written to a text file.</para>
</td>
</tr>
</table>
</comments>
</member>
<member name="M:Classes.SmallPoint">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a T<routine namespace="Classes">SmallPoint</routine> structure from a pair of coordinates.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">SmallPoint</routine> to create a T<routine namespace="Classes">SmallPoint</routine> that represents the specified coordinates.</para>
</comments>
</member>
<member name="M:Classes.PointsEqual">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether two points have the same coordinates.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">PointsEqual</routine> to compare two points. <routine namespace="Classes">PointsEqual</routine> returns true if P1 has the same coordinates as P2, false if the two points differ.</para>
</comments>
</member>
<member name="M:Classes.Rect">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a T<routine namespace="Classes">Rect</routine> structure from a set of coordinates.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">Rect</routine> to create a T<routine namespace="Classes">Rect</routine> that represents the rectangle with the specified coordinates. Use <routine namespace="Classes">Rect</routine> to construct parameters for functions that require T<routine namespace="Classes">Rect</routine>, rather than setting up local variables for each parameter.</para>
</comments>
</member>
<member name="M:Classes.InvalidPoint">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a specified point is equal to (-1,-1).</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The point (-1,-1) is often used, by convention, to represent an invalid set of coordinates. This convention is often employed by Windows API functions<condition os="Linux"/>and by several Linux utilities. When working with other code that uses this convention, use <routine namespace="Classes">InvalidPoint</routine> to identify coordinate values that are invalid.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At is the point to examine.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">X and Y identify the point by giving the X and Y coordinates respectively.</para>
<routine namespace="Classes">InvalidPoint</routine> returns true if the specified point is (-1,-1), false otherwise.</para>
</comments>
</member>
<member name="M:Classes.GetClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a registered persistent class given its name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">GetClass</routine> to obtain a class from a class name. This class can be used as a parameter to routines that require a class. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Class must be registered before <routine namespace="Classes">GetClass</routine> can find it. Form classes and component classes that are referenced in a form declaration (instance variables) are automatically registered when the form is loaded. Other classes can be registered by calling RegisterClass or RegisterClasses.</para>
<para>To obtain an unregistered class from a class name in C++, use the __classid routine.</para>
</note>
</comments>
</member>
<member name="M:Classes.FindClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Finds and returns a class that is derived from TPersistent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">FindClass</routine> to locate a class type by name. <routine namespace="Classes">FindClass</routine> searches the classes that the streaming system knows about. Form classes and component classes that are referenced in a form declaration (instance variables) are automatically registered with the streaming system. Other classes can be registered (with a call to RegisterClasses) so that the streaming system will recognize that class in a stream and know how to construct it. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the requested class name cannot be found, <routine namespace="Classes">FindClass</routine> raises an exception.</para>
</comments>
</member>
<member name="M:Classes.RegisterClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers a class of persistent object so that it's class type can be retrieved.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">RegisterClass</routine> to register a class with the streaming system. Form classes and component classes that are referenced in a form declaration (instance variables) are automatically registered. Any other classes used by an application must be explicitly registered by calling <routine namespace="Classes">RegisterClass</routine> if instances are to be saved.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once classes are registered, they can be loaded or saved by the component streaming system. IdentToInt returns nil (Delphi) or NULL (C++) when passed the class name of an unregistered class, and FindClass raises an exception for unregistered classes.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AClass parameter is the class that is descended from TPersistent. Put the call to <routine namespace="Classes">RegisterClass</routine> in a Register procedure. In Delphi, you can also put the call in the initialization section of the unit in which the class is defined. In C++, the call can also go in the namespace of the compilation unit that defines the class.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the class is already registered, <routine namespace="Classes">RegisterClass</routine> does nothing. If a different class with the same name is already registered, <routine namespace="Classes">RegisterClass</routine> raises an EFilerError exception.</para>
<para>Registering a component using the RegisterNoIcon or RegisterComponents method does not automatically register the class. It is still necessary to call <routine namespace="Classes">RegisterClass</routine> for components.</para>
</note>
</comments>
</member>
<member name="M:Classes.RegisterClasses">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers a set of classes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">RegisterClasses</routine> to register a set of custom classes in a single line. Each class is registered by calling RegisterClass. Unregistered classes can't be loaded or saved by the component streaming system.</para>
<para>In C++, the AClasses parameter identifies the classes to be registered These must be descendants of TPersistent. The AClasses_Size parameter indicates the index of the last class in AClasses (one less than the total number of classes).</para>
</note>
</comments>
</member>
<member name="M:Classes.RegisterClassAlias">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers a class that is identical to another class except for the name.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Component writers call <routine namespace="Classes">RegisterClassAlias</routine> to register custom classes that are identical to another persistent class except for the name. Registering a class allows it to be loaded and saved by the component streaming system.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AClass parameter identifies the previously registered persistent class to which the new class is identical. The Alias parameter specifies the class name of the new class.</para>
</comments>
</member>
<member name="M:Classes.UnRegisterClass">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unregisters an object class.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">UnregisterClass</routine> to unregister an object class. When a class is unregistered, it can't be loaded or saved by the component streaming system.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After unregistering a class, its name can be reused to register another object class.</para>
</comments>
</member>
<member name="M:Classes.UnRegisterClasses">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unregisters a set of classes.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">UnregisterClasses</routine> to unregister several persistent object classes in a single line. When a class is unregistered, it can't be loaded or saved by the component streaming system.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AClasses parameter specifies the classes (descendants of TPersistent) to unregister.</para>
<para>In C++, the AClasses_Size parameter indicates the index of the last class in the AClasses array (one less than the number of classes).</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After unregistering a class, its name can be reused to register another object class.</para>
</comments>
</member>
<member name="M:Classes.UnRegisterModuleClasses">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unregisters all classes defined in a specified module.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">UnregisterModuleClasses</routine> to unregister all object classes that were registered by the module with the handle specified by the Module parameter. When a class is unregistered, it can't be loaded or saved by the component streaming system.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After unregistering a class, its name can be reused to register another object class.</para>
</comments>
</member>
<member name="M:Classes.StartClassGroup">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Starts a class group derived from TPersistent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The streaming system allows the classes that can be loaded and saved to be registered in separate groups. This allows the IDE to distinguish between cross-platform and Windows-only classes. <routine namespace="Classes">StartClassGroup</routine> creates a new group of classes, and adds the class specified by AClass to that group. </para>
</comments>
</member>
<member name="M:Classes.ActivateClassGroup">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Activates a group of classes that derive from TPersistent.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The streaming system allows the classes that can be loaded and saved to be registered in separate groups. This allows the IDE to distinguish between cross-platform and Windows-only classes. Call <routine namespace="Classes">ActivateClassGroup</routine> to activate the group of classes that contains the class specified by AClass. If AClass is in more than one group, all groups that contain the class are activated. </para>
<routine namespace="Classes">ActivateClassGroup</routine> returns the class that was last used to activate a class group.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the requested class group cannot be activated <routine namespace="Classes">ActivateClassGroup</routine> raises an exception.</para>
</comments>
</member>
<member name="M:Classes.RegisterComponents">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers a set of components so that they all appear on the same page of the component palette.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">RegisterComponents</routine> to install a set of components in the IDE. Once a component is registered, it appears on the component palette, where it can be selected and placed on forms or data modules. Registered components can communicate with the Object Inspector to allow the user to get and set properties and events.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the Page parameter to the name of the page on the component palette where the components should appear. If the named page already exists, the components are added to that page. If the named page does not exist, a new palette page with that name is created.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pass the components to be registered in the ComponentClasses parameter.</para>
<para>In C++, the ComponentClasses_Size parameter indicates the index of the last class in the ComponentClasses array (one less than the number of classes).</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">RegisterComponents</routine> from the implementation of the Register procedure in one of the units that defines the custom components. The units that define the components must then be compiled into a package and the package must be installed before the custom components appear in the component palette.</para>
<para>After components are registered, users can move them to different palette pages. Once this happens, the component always appears on the new page. Calling <routine namespace="Classes">RegisterComponents</routine> a second time does not influence the page on which the component appears.</para>
</note>
</comments>
</member>
<member name="M:Classes.RegisterNoIcon">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers a set of components but does not add them to the component palette.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">RegisterNoIcon</routine> to register a set of custom components so that objects from that class can use the Object Inspector. Because the components are not added to the component palette, instances of components registered using <routine namespace="Classes">RegisterNoIcon</routine> must be explicitly created by calling the constructor, usually from another component.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The ComponentClasses parameter is an array of custom classes that are descended from TComponent.</para>
<para>In C++, the ComponentClasses_Size parameter is index of the last class in the array (one less than the number of classes).</para>
</note>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Put the call to <routine namespace="Classes">RegisterNoIcon</routine> in the Register procedure. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To add the components to the component palette, use RegisterComponents instead.</para>
</comments>
</member>
<member name="M:Classes.RegisterIntegerConsts">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Registers conversion functions for string identifiers that represent type values.</para>
<routine namespace="Classes">RegisterIntegerConsts</routine> (which can only be called in Delphi) registers conversion functions for type identifiers. Call <routine namespace="Classes">RegisterIntegerConsts</routine> from the initialization section of the unit that defines an integer-based type and a set of strings that represent the values of that type.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIntegerType is a pointer to the type information for the integer-based type whose values are represented as strings. Its value can be obtained from the base type using the TypeInfo function.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIdentToInt is the conversion function that converts strings that are symbolic representations of values to the corresponding integers.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIntToIdent is the conversion function that converts values that are instances of the base type to the corresponding string representation.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Once the conversion functions are registered, string identifiers can represent type values and the conversion functions are used to convert the string identifiers into the underlying integer values. For example, the TColor type uses this system to convert between the type constants in the Graphics unit and numeric TColor values.</para>
</comments>
</member>
<member name="M:Classes.UnregisterIntegerConsts">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unregisters conversion functions for string identifiers that represent type values.</para>
<routine namespace="Classes">UnregisterIntegerConsts</routine>, which can only be called in Delphi, unregisters conversion functions that were previously registered by a call to RegisterIntegerConsts. Call <routine namespace="Classes">UnregisterIntegerConsts</routine> from the finalization section of the unit that defines the constants and registers the conversion functions in its initialization section. Once the conversion functions are unregistered, string identifiers can't be used to represent type values.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIntegerType is a pointer to the type information for the integer-based type whose values are represented as strings. Its value can be obtained from the base type using the TypeInfo function.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIdentToInt is the conversion function that converts strings that are symbolic representations of values to the corresponding integers.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AIntToIdent is the conversion function that converts values that are instances of the base type to the corresponding string representation.</para>
</comments>
</member>
<member name="M:Classes.IdentToInt">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Uses a mapping array to convert string identifiers into their corresponding integer values.</para>
<routine namespace="Classes">IdentToInt</routine> provides the underlying translation from string identifiers to integers that occurs, for example, when you register a mapping using the RegisterIntegerConsts procedure in Delphi.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ident is the string identifier to translate.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Int returns the corresponding integer value.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Map is an array of records (Delphi) or structs (C++) that describe the mapping. Each member of the array contains a Value field, which is the integer value to return and a Name field, which is the string identifier to translate.</para>
<routine namespace="Classes">IdentToInt</routine> looks for the string specified by Ident as the Name field on an entry in Map. If it finds a match, it sets Int to the corresponding Value field and returns true. If it does not find a match, it returns False.</para>
</comments>
</member>
<member name="M:Classes.IntToIdent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Uses a mapping array to convert integers into their corresponding string identifiers.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">IdentToInt provides the underlying translation from string identifiers to integers that occurs, for example, when you register a mapping using the RegisterIntegerConsts procedure in Delphi.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Int is the integer to translate.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ident returns the corresponding string identifier.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Map is an array of records (Delphi) or structs (C++) that describe the mapping. Each member of the array contains a Value field, which is the integer value to translate and a Name field, which is the corresponding string identifier.</para>
<routine namespace="Classes">IntToIdent</routine> looks for the integer specified by Int as the Value field on an entry in Map. If it finds a match, it sets Ident to the corresponding Name field and returns true. If it does not find a match, it returns false.</para>
</comments>
</member>
<member name="M:Classes.FindGlobalComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns a top-level container component.</para>
<routine namespace="Classes">FindGlobalComponent</routine> is used by the component streaming system to implement form linking. When a component property refers to a component on another form, data module, or other top-level container component, the streaming system calls <routine namespace="Classes">FindGlobalComponent</routine> to locate the root object in the form linking reference (e.g. Form1 in Form1.Edit1 (Delphi) or Form1->Edit1 (C++)). If the object cannot be found, <routine namespace="Classes">FindGlobalComponent</routine> returns nil (Delphi) or NULL (C++).</para>
<routine namespace="Classes">IsUniqueGlobalComponentName</routine> returns true if the name specified by Name is not currently used by any component on any form, data module, or other top-level container component. <routine namespace="Classes">IsUniqueGlobalComponentName</routine> returns false if another component is already using Name (in which case, references to the component should be qualified by the root object's name.</para>
</comments>
</member>
<member name="M:Classes.InitInheritedComponent">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes streaming of a form file for an inherited root class.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">InitInheritedComponent</routine> from the constructor of a root class to start streaming in of information in the associated form file.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Instance is the object being instantiated.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">RootAncestor is the base root class of which Instance may represent a descendant. This class must be a root class, meaning a class such as TCustomForm, TFrame, or TDataModule, which is the starting point of the streaming process (the component associated with the form file).</para>
<routine namespace="Classes">InitInheritedComponent</routine> returns true if the form file was successfully streamed in, false otherwise.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The call to <routine namespace="Classes">InitInheritedComponent</routine> is only required for descendant classes of the root class, and must follow the construction of the object instance except for streaming in of persistent properties in the form file. The following Delphi and C++ code samples show typical root class contstructors:</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads components and their properties from a specified resource.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">ReadComponentRes</routine> to create a component from its representation in a resource header. The ResName parameter is the name assigned to the resource for the component. The Instance parameter is an instance of the component that should be filled in with the attributes of the saved resource. Instance must be an object of the same class as the saved resource, or one of its descendants. Create an instance of the appropriate type of object, and then call <routine namespace="Classes">ReadComponentRes</routine> to read in its property settings. If Instance is nil (Delphi) or NULL (C++), the object class is read from the resource.</para>
<routine namespace="Classes">ReadComponentRes</routine> returns an instance of the component that was read from the resource.</para>
</comments>
</member>
<member name="M:Classes.ReadComponentResEx">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads a component from a resource.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="Classes">ReadComponentResEx</routine> to load a component from a resource stored in a particular module (as opposed to ReadComponentRes, which assumes the current module).</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HInstance parameter is the instance handle for the module that stores the component as a resource. The ResName parameter is the name assigned to the resource for the component.</para>
<routine namespace="Classes">ReadComponentResEx</routine> returns an instance of the component that was read from the resource.</para>
</comments>
</member>
<member name="M:Classes.ReadComponentResFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reads components and their properties from a specified <condition os="Windows">Windows </condition>resource file.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">ReadComponentResFile</routine> to create a component and its children from their representation in a Windows<condition os="Windows"/>resource file. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The FileName parameter is the name of the compiled resource file that contains the component resource. </para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Instance parameter is an instance of the type of component that should be read. Create an instance of the appropriate type of object, and then call <routine namespace="Classes">ReadComponentResFile</routine> to read in its property settings. If Instance is nil (Delphi) or NULL (C++), the object class is read from the resource. Before passing an Instance parameter of nil (Delphi) or NULL (C++), all classes being read must have been registered using the RegisterClass or RegisterClasses routine.</para>
<routine namespace="Classes">ReadComponentResFile</routine> returns an instance of the component that was read from the resource file.</para>
</comments>
</member>
<member name="M:Classes.WriteComponentResFile">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes components and their properties to a file using a resource file format.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="Classes">WriteComponentResFile</routine> to save the component specified by the Instance parameter to the specified file, storing it in a resource-file format.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To read a component written with <routine namespace="Classes">WriteComponentResFile</routine>, call ReadComponentResFile.</para>
</comments>
</member>
<member name="M:Classes.CollectionsEqual">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Compares the contents of two collections.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">CollectionsEqual</routine> to determine whether two collections contain identical information. <routine namespace="Classes">CollectionsEqual</routine> returns true if all the items in each collection have the same settings, and the items appear in the same order. <routine namespace="Classes">CollectionsEqual</routine> returns false if the collections differ in number or order of items, or if any of the items in the collections differ.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">C1 and C2 are the collections to compare.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Owner1 and Owner2 are the Owners of the collections. Owner1 and Owner2 must be "root" components, such as forms or data modules. They are used for resolving name references in the properties of the collections.</para>
</comments>
</member>
<member name="M:Classes.LineStart">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Finds the end of the last whole line in a buffer. </para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="Classes">LineStart</routine> to find the start of the last partial line in the buffer. <routine namespace="Classes">LineStart</routine> starts at BufPos and scans backwards for a line-feed character (\n). It returns a pointer to that character. If no line-feed char is found, it returns the Buffer pointer. Buffer should point to the beginning of a block of memory and BufPos to the end of the block you want to scan.</para>
<para>The undocumented TParser class uses <routine namespace="Classes">LineStart</routine> to locate line-endings in chunks of text read into a fixed-size buffer. When the last full line of text is parsed, the parser moves the last partial line of text from the end of the buffer to the front and fills the rest of the buffer with new data from disk.</para>
</note>
</comments>
</member>
<member name="M:Classes.ExtractStrings">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Fills a string list with substrings parsed from a delimited list.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="Classes">ExtractStrings</routine> to fill a string list with the substrings of the null-terminated string specified by Content.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Separators is a set of characters that are used as delimiters, separating the substrings. Carriage returns, newline characters, and quote characters (single or double) are always treated as separators. Separators are ignored when inside a quoted string until the final end quote. (Note that quoted characters can appear in a quoted string if the quote character is doubled.)</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WhiteSpace is a set of characters to be ignored when parsing Content if they occur at the beginning of a string.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Content is the null-terminated string to parse into substrings.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Strings is a string list to which all substrings parsed from Content are added. The string list is not cleared by <routine namespace="Classes">ExtractStrings</routine>, so any strings already in the string list are preserved.</para>
<routine namespace="Classes">ExtractStrings</routine> does not add empty strings to the list.</para>
</note>
</comments>
</member>
<member name="M:Classes.CountGenerations">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the number of intermediate classes between a derived class and its ancestor.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="Classes">CountGenerations</routine> to determine how close a derived class is to one of its ancestors. For example, if Ancestor and Descendant are the same class, <routine namespace="Classes">CountGenerations</routine> returns 0. If Descendant is derived directly from Ancestor, <routine namespace="Classes">CountGenerations</routine> returns 1.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Ancestor is the ancestor class.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Descendant is the descendant class. If it is not the same as Ancestor or does not derive from Ancestor, <routine namespace="Classes">CountGenerations</routine> returns ΓÇô1.</para>
<para>To check that Descendant derives from Ancestor using Delphi, use the is operator to check that Descendant is Ancestor before calling <routine namespace="Classes">CountGenerations</routine>. In C++, use the static InheritsFrom method of Descendant.</para>
</tip>
</comments>
</member>
<member name="M:Classes.BinToHex">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a binary value into its hexadecimal representation.</para>
</summary>
<comments>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="Classes">BinToHex</routine> to convert the binary value in a buffer into a string that is its hexadecimal representation.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Buffer is a buffer of bytes that contains the binary value.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Text returns a null-terminated string that represents the value of Buffer as a hexadecimal number.</para>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">BufSize is the size of Buffer. Text needs to point to a sequence of characters that has at least 2*BufSize bytes because each hexadecimal character represents two bytes.</para>
</comments>
</member>
<member name="M:Classes.HexToBin">
<summary>
<para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Converts a string of hexadecimal digits to the corresponding binary value.</para>
