mirror of
https://gitlab.com/freepascal.org/fpc/source.git
synced 2025-04-19 00:39:34 +02:00
+ Completed documentation with all identifiers
This commit is contained in:
michael
parent
abf48f62f5
commit
b121cd4fd7
207
docs/go32.xml
207
docs/go32.xml
@ -2134,6 +2134,213 @@ Check the <link id="int31error"/> variable.
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="tmeminfo.reserved0">
|
||||
<short>Unused</short>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="tmeminfo.reserved1">
|
||||
<short>Unused</short>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="tmeminfo.reserved2">
|
||||
<short>Unused</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="set_descriptor_access_right">
|
||||
<short>Set access rights to memory descriptor</short>
|
||||
<descr>
|
||||
<var>set_descriptor_access_right</var> sets the access rights for descriptor
|
||||
<var>d</var> to <var>w</var>
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="map_device_in_memory_block">
|
||||
<short>Map a device into program's memory space</short>
|
||||
<descr>
|
||||
<var>map_device_in_memory_block</var> allows to map a device in memory. This
|
||||
function is a direct call of the extender. For more information about it's
|
||||
arguments, see the extender documentation.
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="get_exception_handler">
|
||||
<short>Return current exception handler</short>
|
||||
<descr>
|
||||
<var>get_exception_handler</var> returns the exception handler for exception
|
||||
<var>E</var> in <var>intaddr</var>. It returns <var>True</var> if the call
|
||||
was successful, <var>False</var> if not.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="set_exception_handler"/>
|
||||
<link id="get_pm_exception_handler"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="set_exception_handler">
|
||||
<short>Set exception handler</short>
|
||||
<descr>
|
||||
<var>set_exception_handler</var> sets the exception handler for exception
|
||||
<var>E</var> to <var>intaddr</var>. It returns <var>True</var> if the call
|
||||
was successful, <var>False</var> if not.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="get_exception_handler"/>
|
||||
<link id="set_pm_exception_handler"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="get_pm_exception_handler">
|
||||
<short>Get protected mode exception handler</short>
|
||||
<descr>
|
||||
<var>get_pm_exception_handler</var> returns the protected mode exception handler for exception
|
||||
<var>E</var> in <var>intaddr</var>. It returns <var>True</var> if the call
|
||||
was successful, <var>False</var> if not.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="get_exception_handler"/>
|
||||
<link id="set_pm_exception_handler"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="set_pm_exception_handler">
|
||||
<short>Set protected mode exception handler</short>
|
||||
<descr>
|
||||
<var>set_pm_exception_handler</var> sets the protected mode exception handler for exception
|
||||
<var>E</var> to <var>intaddr</var>. It returns <var>True</var> if the call
|
||||
was successful, <var>False</var> if not.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="set_exception_handler"/>
|
||||
<link id="get_pm_exception_handler"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="request_linear_region">
|
||||
<short>Request linear address region.</short>
|
||||
<descr>
|
||||
<var>request_linear_region</var> requests a linear range of addresses of
|
||||
size <var>Size</var>, starting at <var>linearaddr</var>. If successful,
|
||||
<var>True</var> is returned, and a handle to the address region is returned in
|
||||
<var>blockhandle</var>.
|
||||
</descr>
|
||||
<errors>
|
||||
On error, <var>False</var> is returned.
|
||||
</errors>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="tb_segment">
|
||||
<short>Return DOS transfer buffer segment</short>
|
||||
<descr>
|
||||
<var>tb_segment</var> returns the DOS transfer buffer segment.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="transfer_buffer"/>
|
||||
<link id="tb_offset"/>
|
||||
<link id="tb_size"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="tb_offset">
|
||||
<short>Return DOS transfer buffer offset</short>
|
||||
<descr>
|
||||
<var>tb_offset</var> returns the DOS transfer buffer segment.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="transfer_buffer"/>
|
||||
<link id="tb_segment"/>
|
||||
<link id="tb_size"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="dpmi_dosmemput">
|
||||
<short>Move data from DPMI memory to DOS memory.</short>
|
||||
<descr>
|
||||
<var>dpmi_dosmemput</var> moves <var>count</var> bytes of data from
|
||||
<var>data</var> to the DOS memory location indicated by <var>seg</var> and
|
||||
<var>ofs</var>.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="dpmi_dosmemget"/>
|
||||
<link id="dpmi_dosmemmove"/>
|
||||
<link id="dpmi_dosmemfillchar"/>
|
||||
<link id="dpmi_dosmemfillword"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="dpmi_dosmemget">
|
||||
<short>Move data from DOS memory to DPMI memory</short>
|
||||
<descr>
|
||||
<var>dpmi_dosmemput</var> moves <var>count</var> bytes of data from
|
||||
the DOS memory location indicated by <var>seg</var> and
|
||||
<var>ofs</var> to DPMI memory indicated by <var>data</var>.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="dpmi_dosmemput"/>
|
||||
<link id="dpmi_dosmemmove"/>
|
||||
<link id="dpmi_dosmemfillchar"/>
|
||||
<link id="dpmi_dosmemfillword"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="dpmi_dosmemmove">
|
||||
<short>Move DOS memory</short>
|
||||
<descr>
|
||||
<var>dpmi_dosmemmove</var> moves <var>count</var> bytes from DOS memory
|
||||
<var>sseg</var>,<var>sofs</var> to <var>dseg</var>,<var>dofs</var>.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="dpmi_dosmemput"/>
|
||||
<link id="dpmi_dosmemget"/>
|
||||
<link id="dpmi_dosmemfillchar"/>
|
||||
<link id="dpmi_dosmemfillword"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="dpmi_dosmemfillchar">
|
||||
<short>Fill DOS memory with a character</short>
|
||||
<descr>
|
||||
<var>dpmi_dosmemfillchar</var> fills the DOS memory reagion indicated by
|
||||
<var>seg</var>,<var>ofs</var> with <var>count</var> characters <var>c</var>.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="dpmi_dosmemput"/>
|
||||
<link id="dpmi_dosmemget"/>
|
||||
<link id="dpmi_dosmemmove"/>
|
||||
<link id="dpmi_dosmemfillword"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="dpmi_dosmemfillword">
|
||||
<short>Fill DOS memory with a word value</short>
|
||||
<descr>
|
||||
<var>dpmi_dosmemfillword</var> fills the DOS memory reagion indicated by
|
||||
<var>seg</var>,<var>ofs</var> with <var>count</var> words <var>W</var>.
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="dpmi_dosmemput"/>
|
||||
<link id="dpmi_dosmemget"/>
|
||||
<link id="dpmi_dosmemfillchar"/>
|
||||
<link id="dpmi_dosmemmove"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
197
docs/objects.xml
197
docs/objects.xml
@ -3275,6 +3275,203 @@ A stream error may occur when writing the strings to the stream.
|
||||
<short>Value for invalid handle. Initial value for file stream handles or when the stream is closed.</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallVoidConstructor">
|
||||
<short>Call a constructor with no arguments</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>CallVoidConstructor</var> calls the constructor of an object.
|
||||
<var>Ctor</var> is the address of the constructor, <var>Obj</var> is a
|
||||
pointer to the instance. If it is <var>Nil</var>, then a new instance is
|
||||
allocated. <var>VMT</var> is a pointer to the object's VMT. The return value
|
||||
is a pointer to the instance.
|
||||
</p>
|
||||
<p>
|
||||
Note that this can only be used on constructors that require no arguments.
|
||||
</p>
|
||||
</descr>
|
||||
<errors>
|
||||
If the constructor expects arguments, the stack may be corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallPointerConstructor"/>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallPointerConstructor">
|
||||
<short>Call a constructor with a pointer argument.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>CallVoidConstructor</var> calls the constructor of an object.
|
||||
<var>Ctor</var> is the address of the constructor, <var>Obj</var> is a
|
||||
pointer to the instance. If it is <var>Nil</var>, then a new instance is
|
||||
allocated. <var>VMT</var> is a pointer to the object's VMT.
|
||||
<var>Param1</var> is passed to the constructor. The return value
|
||||
is a pointer to the instance.
|
||||
</p>
|
||||
<p>
|
||||
Note that this can only be used on constructors that require a pointer as
|
||||
the sole argument. It can also be used to call a constructor with a single
|
||||
argument by reference.
|
||||
</p>
|
||||
</descr>
|
||||
<errors>
|
||||
If the constructor expects other arguments than a pointer, the stack may be corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallVoidMethod">
|
||||
<short>Call an object method</short>
|
||||
<descr>
|
||||
<var>CallVoidMethod</var> calls the method with address <var>Method</var>
|
||||
for instance <var>Obj</var>. It returns a pointer to the instance.
|
||||
</descr>
|
||||
<errors>
|
||||
If the method expects parameters, the stack may become corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerConstructor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallPointerMethod">
|
||||
<short>Call a method with a single pointer argument</short>
|
||||
<descr>
|
||||
<var>CallPointerMethod</var> calls the method with address <var>Method</var>
|
||||
for instance <var>Obj</var>. It passes <var>Param1</var> to the method as
|
||||
the single argument. It returns a pointer to the instance.
|
||||
</descr>
|
||||
<errors>
|
||||
If the method expects other parameters than a single pointer, the stack may become corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallVoidMethod"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerConstructor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallVoidLocal">
|
||||
<short>Call a local nested procedure.</short>
|
||||
<descr>
|
||||
<var>CallVoidLocal</var> calls the local procedure with address
|
||||
<var>Func</var>, where <var>Frame</var> is the frame of the wrapping
|
||||
function.
|
||||
</descr>
|
||||
<errors>
|
||||
If the local function expects parameters, the stack may become corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidMethod"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerConstructor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallPointerLocal">
|
||||
<short>Call a local nested function with a pointer argument</short>
|
||||
<descr>
|
||||
<var>CallPointerLocal</var> calls the local procedure with address
|
||||
<var>Func</var>, where <var>Frame</var> is the frame of the wrapping
|
||||
function. It passes <var>Param1</var> to the local function.
|
||||
</descr>
|
||||
<errors>
|
||||
If the local function expects other parameters than a pointer, the stack may become corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidMethod"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerConstructor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallVoidMethodLocal">
|
||||
<short>Call a local procedure of a method</short>
|
||||
<descr>
|
||||
<var>CallVoidMethodLocal</var> calls the local procedure with address
|
||||
<var>Func</var>, where <var>Frame</var> is the frame of the wrapping
|
||||
method.
|
||||
</descr>
|
||||
<errors>
|
||||
If the local function expects parameters, the stack may become corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidMethod"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallPointerMethodLocal"/>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerConstructor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="CallPointerMethodLocal">
|
||||
<short>Call a local procedure of a method with a pointer argument</short>
|
||||
<var>CallPointerMethodLocal</var> calls the local procedure with address
|
||||
<var>Func</var>, where <var>Frame</var> is the frame of the wrapping
|
||||
method. It passes <var>Param1</var> to the local function.
|
||||
</descr>
|
||||
<errors>
|
||||
If the local function expects other parameters than a pointer, the stack may become corrupted.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="CallPointerMethod"/>
|
||||
<link id="CallVoidMethod"/>
|
||||
<link id="CallPointerLocal"/>
|
||||
<link id="CallVoidLocal"/>
|
||||
<link id="CallVoidMethodLocal"/>
|
||||
<link id="CallVoidConstructor"/>
|
||||
<link id="CallPointerConstructor"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="DefaultTPCompatible">
|
||||
<short>Default value for <link id="#rtl.objects.tstream.tpcompatible">tstream.tpcompatible</link></short>
|
||||
<descr>
|
||||
<var>DefaultTPCompatible</var> is used to initialize <link
|
||||
id="tstream.tpcompatible">tstream.tpcompatible</link>.
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
</package>
|
||||
|
||||
278
docs/sockets.xml
278
docs/sockets.xml
@ -1503,6 +1503,284 @@ machinen, and returns the correctly ordered result.
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="UnixType">
|
||||
<short>Basic Unix types</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- alias type Visibility: default -->
|
||||
<element name="TIn_addr">
|
||||
<short>Alias for <link id="#rtl.sockets.In_addr">in_addr</link> record type.</short>
|
||||
</element>
|
||||
|
||||
<!-- pointer type Visibility: default -->
|
||||
<element name="pin_addr">
|
||||
<short>Pointer to <link id="#rtl.sockets.In_addr">in_addr</link> record.</short>
|
||||
</element>
|
||||
|
||||
<!-- alias type Visibility: default -->
|
||||
<element name="TInAddr">
|
||||
<short>Alias for <link id="#rtl.sockets.In_addr">in_addr</link> record type.</short>
|
||||
</element>
|
||||
|
||||
<!-- array type Visibility: default -->
|
||||
<element name="in_addrbytes">
|
||||
<short>Array with same length as <link id="#rtl.sockets.In_addr">in_addr</link> record</short>
|
||||
<descr>
|
||||
<var>in_addrbytes</var> is used to typecast a <link id="in_addr"/> record to
|
||||
an array of bytes.
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
<!-- alias type Visibility: default -->
|
||||
<element name="Sockaddr">
|
||||
<short>Alias for <link id="#rtl.sockets.TSockAddr">TSockAddr</link> record type.</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="NetAddrToStr">
|
||||
<short>Convert a network address to a string.</short>
|
||||
<descr>
|
||||
<var>NetAddrToStr</var> converts the network address in <var>Entry</var> to
|
||||
a string representation in human-readable form (a dotted quad).
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="HostAddrToStr"/>
|
||||
<link id="StrToNetAddr"/>
|
||||
<link id="StrToHostAddr"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="HostAddrToStr">
|
||||
<short>Convert a host address to a string.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HostAddrToStr</var> converts the host address in <var>Entry</var> to
|
||||
a string representation in human-readable form (a dotted quad).
|
||||
</p>
|
||||
<p>
|
||||
Basically, it is the same as <link id="NetAddrToStr"/>, but with the bytes
|
||||
in correct order.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr"/>
|
||||
<link id="StrToHostAddr"/>
|
||||
<link id="StrToNetAddr"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="StrToHostAddr">
|
||||
<short>Convert a string to a host address.</short>
|
||||
<descr>
|
||||
<var>StrToHostAddr</var> converts the string representation in <var>IP</var>
|
||||
to a host address and returns the host address.
|
||||
</descr>
|
||||
<errors>
|
||||
On error, the host address is filled with zeroes.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr"/>
|
||||
<link id="HostAddrToStr"/>
|
||||
<link id="StrToNetAddr"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="StrToNetAddr">
|
||||
<short>Convert a string to a network address.</short>
|
||||
<descr>
|
||||
<var>StrToNetAddr</var> converts the string representation in <var>IP</var>
|
||||
to a network address and returns the network address.
|
||||
</descr>
|
||||
<errors>
|
||||
On error, the network address is filled with zeroes.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr"/>
|
||||
<link id="HostAddrToStr"/>
|
||||
<link id="StrToHostAddr"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="HostToNet">
|
||||
<short>Convert a host address to a network address</short>
|
||||
<descr>
|
||||
<var>HostToNet</var> converts a host address to a network address.
|
||||
It takes care of endianness of the host machine. The address can be
|
||||
specified as a dotted quad or as a longint.
|
||||
</descr>
|
||||
<errors>
|
||||
None.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="NetToHost"/>
|
||||
<link id="NToHS"/>
|
||||
<link id="HToNS"/>
|
||||
<link id="ShortHostToNet"/>
|
||||
<link id="ShortNetToHost"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="NetToHost">
|
||||
<short>Convert a network address to a host address.</short>
|
||||
<descr>
|
||||
<var>NetToHost</var> converts a network address to a host address.
|
||||
It takes care of endianness of the host machine. The address can be
|
||||
specified as a dotted quad or as a longint.
|
||||
</descr>
|
||||
<errors>
|
||||
None.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="HostToNet"/>
|
||||
<link id="NToHS"/>
|
||||
<link id="HToNS"/>
|
||||
<link id="ShortHostToNet"/>
|
||||
<link id="ShortNetToHost"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="ShortHostToNet">
|
||||
<short>Convert a host port number to a network port number</short>
|
||||
<descr>
|
||||
<var>ShortHostToNet</var> converts a host port number to a network port
|
||||
number. It takes care of endianness of the host machine.
|
||||
</descr>
|
||||
<errors>
|
||||
None.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="ShortNetToHost"/>
|
||||
<link id="HostToNet"/>
|
||||
<link id="NToHS"/>
|
||||
<link id="HToNS"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="ShortNetToHost">
|
||||
<short>Convert a network port number to a host port number</short>
|
||||
<descr>
|
||||
<var>ShortNetToHost</var> converts a network port number to a host port
|
||||
number. It takes care of endianness of the host machine.
|
||||
</descr>
|
||||
<errors>
|
||||
None.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="ShortNetToHost"/>
|
||||
<link id="HostToNet"/>
|
||||
<link id="NToHS"/>
|
||||
<link id="HToNS"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="HostAddrToStr6">
|
||||
<short>Convert a IPV6 host address to a string representation.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HostAddrToStr6</var> converts the IPV6 host address in <var>Entry</var> to
|
||||
a string representation in human-readable form.
|
||||
</p>
|
||||
<p>
|
||||
Basically, it is the same as <link id="NetAddrToStr6"/>, but with the bytes
|
||||
in correct order.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr"/>
|
||||
<link id="StrToHostAddr"/>
|
||||
<link id="StrToNetAddr"/>
|
||||
<link id="StrToHostAddr6"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="StrToHostAddr6">
|
||||
<short>Convert a string to a IPV6 host address.</short>
|
||||
<descr>
|
||||
<var>StrToHostAddr6</var> converts the string representation in <var>IP</var>
|
||||
to a IPV6 host address and returns the host address.
|
||||
</descr>
|
||||
<errors>
|
||||
On error, the address is filled with zeroes.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr6"/>
|
||||
<link id="HostAddrToStr6"/>
|
||||
<link id="StrToHostAddr"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="NetAddrToStr6">
|
||||
<short>Convert a IPV6 network address to a string.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>NetAddrToStr6</var> converts the IPV6 network address in <var>Entry</var> to
|
||||
a string representation in human-readable form.
|
||||
</p>
|
||||
<p>
|
||||
Basically, it is the same as <link id="NetAddrToStr6"/>, but with the bytes
|
||||
in correct order.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr"/>
|
||||
<link id="StrToHostAddr"/>
|
||||
<link id="StrToNetAddr"/>
|
||||
<link id="StrToHostAddr6"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="StrToNetAddr6">
|
||||
<short>Convert a string to a IPV6 network address</short>
|
||||
<descr>
|
||||
<var>StrToNetAddr6</var> converts the string representation in <var>IP</var>
|
||||
to a IPV6 network address and returns the network address.
|
||||
</descr>
|
||||
<errors>
|
||||
On error, the address is filled with zeroes.
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="NetAddrToStr6"/>
|
||||
<link id="HostAddrToStr6"/>
|
||||
<link id="StrToHostAddr6"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="NoAddress">
|
||||
<short>Constant indicating invalid (no) network address.</short>
|
||||
</element>
|
||||
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="NoNet">
|
||||
<short>Constant indicating invalid (no) network address.</short>
|
||||
</element>
|
||||
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="NoAddress6">
|
||||
<short>Constant indicating invalid (no) IPV6 network address.</short>
|
||||
</element>
|
||||
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="NoNet6">
|
||||
<short>Constant indicating invalid (no) IPV6 network address.</short>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
</package>
|
||||
</fpdoc-descriptions>
|
||||
Loading…
Reference in New Issue
Block a user