com-get-active-object.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 20216b916ed583938672cd09c2c2f430351430d1 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.com-get-active-object" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>com_get_active_object</refname>
  <refpurpose>Вернуть дескриптор на уже запущенный экземпляр объекта COM</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>variant</type><methodname>com_get_active_object</methodname>
   <methodparam><type>string</type><parameter>prog_id</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>codepage</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>com_get_active_object</function> - это то же самое, что и создание
   нового экземпляра объекта <xref linkend="class.com"/>, за исключением того, что
   объект будет возвращён, если он уже запущен. Приложения OLE используют так называемую
   "<literal>Таблицу Запущенных Объектов</literal>" для возможности запускать
   приложения единожды. Эта функция представляет обёртку над библиотечной
   COM-функцией GetActiveObject().
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>prog_id</parameter></term>
     <listitem>
      <para>
       <parameter>prog_id</parameter> должен быть или ProgID или CLSID объекта,
       к которому вы хотите получить доступ (к примеру, <literal>Word.Application</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>codepage</parameter></term>
     <listitem>
      <para>
       Делает то же самое, что и в классе <xref linkend="class.com"/>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Если запрошенный объект запущен, то он будет возвращён вашему скрипту как
   любой другой объект COM.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Есть множество причин, по которым эта функция может завершиться с ошибкой. Наиболее
   распространённая причина в том, что объект не запущен. В таком случае
   будет выброшено исключение <constant>MK_E_UNAVAILABLE</constant>;
   вы можете использовать метод <literal>getCode</literal> для проверки кода исключения.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>codepage</parameter> теперь допускает значение null.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
    Использование <function>com_get_active_object</function> в контексте веб-сервера -
    это не самая умная идея. Большинство приложений COM/OLE спроектированы так,
    что не могут работать одновременно с несколькими пользователями, даже (или особенно)
    Microsoft Office. Больше полезной информации читайте в <link
    xlink:href="&url.msoffice.serverside;">Considerations for Server-Side
    Automation of Office</link>.
   </para>
  </warning>
 </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
-->