mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
89 lines
2.5 KiB
XML
89 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.hw-mapid" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>hw_mapid</refname>
|
|
<refpurpose>Maps global id on virtual local id</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>hw_mapid</methodname>
|
|
<methodparam><type>int</type><parameter>connection</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>server_id</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>object_id</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Maps a global object id on any hyperwave server, even those you did not
|
|
connect to with <function>hw_connect</function>, onto a virtual object id.
|
|
</para>
|
|
<para>
|
|
This virtual object id can then be used as any other object id, e.g. to
|
|
obtain the object record with <function>hw_getobject</function>.
|
|
</para>
|
|
<para>
|
|
Note: In order to use this function you will have to set the F_DISTRIBUTED
|
|
flag, which can currently only be set at compile time in hg_comm.c. It is
|
|
not set by default. Read the comment at the beginning of hg_comm.c
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The connection identifier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>server_id</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The server id is the first part of the global object id (GOid) of the
|
|
object which is actually the IP number as an integer.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>object_id</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The object identifier.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the virtual object id.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|