php-doc-en/reference/hw/functions/hw-mapid.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/hw.xml, last change in rev 1.2 -->
  <refentry id="function.hw-mapid">
   <refnamediv>
    <refname>hw_mapid</refname>
    <refpurpose>Maps global id on virtual local id</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <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. 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>. 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>
    <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>
  </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:"../../../../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
-->