<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.com.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.com-get-active-object.php',
    1 => 'com_get_active_object',
    2 => 'Retorna um identificador para uma inst&acirc;ncia j&aacute; em execu&ccedil;&atilde;o de um objeto COM',
  ),
  'up' => 
  array (
    0 => 'ref.com.php',
    1 => 'Fun&ccedil;&otilde;es de COM',
  ),
  'prev' => 
  array (
    0 => 'function.com-event-sink.php',
    1 => 'com_event_sink',
  ),
  'next' => 
  array (
    0 => 'function.com-load-typelib.php',
    1 => 'com_load_typelib',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/com/functions/com-get-active-object.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.com-get-active-object" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">com_get_active_object</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">com_get_active_object</span> &mdash; <span class="dc-title">Retorna um identificador para uma instância já em execução de um objeto COM</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.com-get-active-object-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>com_get_active_object</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$prog_id</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$codepage</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="class.variant.php" class="type variant">variant</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>com_get_active_object()</strong></span> é semelhante a criar uma nova
   instância de um objeto <a href="class.com.php" class="xref">com</a>, exceto que só
   retornará um objeto ao script se o objeto já estiver em execução.
   Os aplicativos OLE usam algo conhecido como &quot;<code class="literal">Running Object Table</code>&quot;
   para permitir que aplicativos bem conhecidos sejam iniciados apenas uma vez; esta função
   expõe a função GetActiveObject() da biblioteca COM para obter um identificador em uma
   instância em execução.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.com-get-active-object-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">prog_id</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">prog_id</code> deve ser o ProgID ou CLSID do
       objeto que a ser acessado (por exemplo
       <code class="literal">Word.Application</code>).
      </p>
     </dd>
    
    
     <dt><code class="parameter">codepage</code></dt>
     <dd>
      <p class="para">
       Atua exatamente da mesma maneira que para a classe <a href="class.com.php" class="xref">com</a>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.com-get-active-object-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Se o objeto solicitado estiver em execução, ele será retornado ao script
   como qualquer outro objeto COM.
  </p>
 </div>

 <div class="refsect1 errors" id="refsect1-function.com-get-active-object-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="para">
   Há vários motivos pelos quais essa função pode falhar, sendo o mais
   comum o fato de o objeto ainda não estar em execução.  Nessa situação,
   o código de erro de exceção será <strong><code><a href="com.constants.php#constant.mk-e-unavailable">MK_E_UNAVAILABLE</a></code></strong>;
   o método <code class="literal">getCode</code> do objeto de exceção pode ser usado
   para verificar o código da exceção.
  </p>
 </div>



 <div class="refsect1 changelog" id="refsect1-function.com-get-active-object-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">codepage</code> agora pode ser nulo.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 notes" id="refsect1-function.com-get-active-object-notes">
  <h3 class="title">Notas</h3>
  <div class="warning"><strong class="warning">Aviso</strong>
   <p class="para">
    Usar <span class="function"><strong>com_get_active_object()</strong></span> em um contexto de servidor
    web nem sempre é uma ideia inteligente. A maioria das aplicações COM/OLE não é projetada
    para lidar com mais de um cliente simultaneamente, mesmo (ou especialmente!) o
    Microsoft Office. Consulte as <a href="http://support.microsoft.com/kb/257757" class="link external">&raquo;&nbsp;Considerações para Automação do
    Office no Lado do Servidor</a> para obter mais informações sobre
    os problemas gerais envolvidos.
   </p>
  </div>
 </div>

</div><?php manual_footer($setup); ?>