fpc/packages/fcl-res/xml/coffreader.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fcl-res">

<!--
  ====================================================================
    coffreader
  ====================================================================
-->

<module name="coffreader">
<short>Contains a resource reader for COFF files</short>
<descr>
<p>This unit contains <link id="TCoffResourceReader"/>, a <link id="resource.TAbstractResourceReader">TAbstractResourceReader</link> descendant that is able to read COFF object files containing resources.</p>
<p>Adding this unit to a program's <var>uses</var> clause registers class <link id="TCoffResourceReader"/> with <link id="resource.TResources">TResources</link>.</p>
</descr>

<!-- unresolved type reference Visibility: default -->
<element name="Classes">
</element>

<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
</element>

<!-- unresolved type reference Visibility: default -->
<element name="resource">
</element>

<!-- unresolved type reference Visibility: default -->
<element name="resourcetree">
</element>

<!-- unresolved type reference Visibility: default -->
<element name="cofftypes">
</element>

<!-- object Visibility: default -->
<element name="TCoffResourceReader">
<short>COFF resource reader</short>
<descr>
<p>This class provides a reader for COFF object files containing resources.</p>
<p>COFF is the file format used by Microsoft Windows object files. Usually resources get stored in a object file that can be given to a linker to produce an executable.</p>
<p>After an object file has been read, <link id="TCoffResourceReader.MachineType">MachineType</link> property holds the machine type the object file was built for.</p>
<remark>This reader is not able to read full PE images. Use <link id="winpeimagereader.TWinPEImageResourceReader">TWinPEImageResourceReader</link> instead.</remark>
</descr>
<seealso>
<link id="TCoffResourceReader.MachineType"/>
<link id="resource.TAbstractResourceReader">TAbstractResourceReader</link>
<link id="winpeimagereader.TWinPEImageResourceReader">TWinPEImageResourceReader</link>
<link id="coffwriter.TCoffResourceWriter">TCoffResourceWriter</link>
</seealso>
</element>

<!-- property Visibility: public -->
<element name="TCoffResourceReader.MachineType">
<short>The machine type of the object file</short>
<descr>
<p>This property holds the machine type of the object file that has been read.</p>
<remark>Obviously, this property is meaningful only after an object file has been read.</remark>
</descr>
<seealso>
<link id="cofftypes.TCoffMachineType">TCoffMachineType</link>
</seealso>
</element>

</module> <!-- coffreader -->

</package>
</fpdoc-descriptions>