<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ibm-db2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.db2-get-option.php',
    1 => 'db2_get_option',
    2 => 'Recupera um valor de op&ccedil;&atilde;o para um recurso de instru&ccedil;&atilde;o ou um recurso de conex&atilde;o',
  ),
  'up' => 
  array (
    0 => 'ref.ibm-db2.php',
    1 => 'Fun&ccedil;&otilde;es de IBM DB2',
  ),
  'prev' => 
  array (
    0 => 'function.db2-free-stmt.php',
    1 => 'db2_free_stmt',
  ),
  'next' => 
  array (
    0 => 'function.db2-last-insert-id.php',
    1 => 'db2_last_insert_id',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/ibm_db2/functions/db2-get-option.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.db2-get-option" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">db2_get_option</h1>
  <p class="verinfo">(PECL ibm_db2 &gt;= 1.6.0)</p><p class="refpurpose"><span class="refname">db2_get_option</span> &mdash; <span class="dc-title">Recupera um valor de opção para um recurso de instrução ou um recurso de conexão</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.db2-get-option-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>db2_get_option</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$resource</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$option</code></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Recupera o valor de uma opção especificada para um recurso de instrução
   ou um recurso de conexão.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.db2-get-option-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">resource</code></dt>
    <dd>
    <span class="simpara">
     Um recurso de instrução válido conforme retornado de
     <span class="function"><a href="function.db2-prepare.php" class="function">db2_prepare()</a></span> ou um recurso de conexão válido conforme
     retornado por <span class="function"><a href="function.db2-connect.php" class="function">db2_connect()</a></span> ou
     <span class="function"><a href="function.db2-pconnect.php" class="function">db2_pconnect()</a></span>.
    </span>
   </dd>
  
  
   <dt><code class="parameter">option</code></dt>
   <dd>
    <p class="para">
     Uma instrução válida ou opções de conexão. As seguintes novas opções estão disponíveis
     a partir do ibm_db2 versão 1.6.0. Elas fornecem informações úteis de rastreamento
     que podem ser definidas durante a execução com <span class="function"><strong>db2_get_option()</strong></span>.
     <blockquote class="note"><p><strong class="note">Nota</strong>: 
      <span class="simpara">
       Versões anteriores do ibm_db2 não oferecem suporte a essas novas opções.
      </span>
      <span class="simpara">
       Quando o valor em cada opção está sendo definido, alguns servidores podem não lidar
       com todo o comprimento fornecido e podem truncar o valor.
      </span>
      <span class="simpara">
       Para garantir que os dados especificados em cada opção sejam convertidos corretamente
       quando transmitidos para um sistema host, use apenas os caracteres de A a Z,
       de 0 a 9 e o sublinhado (_) ou ponto (.).
      </span>
     </p></blockquote>
     <dl>
      
       <dt><code class="parameter">userid</code></dt>
        <dd>
         <p class="para">
          <code class="literal">SQL_ATTR_INFO_USERID</code> - Um ponteiro para uma string terminada em nulo
          usada para identificar o ID do usuário cliente enviado ao servidor de banco de dados host
          ao usar o DB2 Connect.
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <span class="simpara">
            Os servidores DB2 para z/OS e OS/390 suportam até 16 caracteres.
            Este ID do usuário não deve ser confundido com o ID do usuário de autenticação, ele é para
            propósitos de identificação apenas e não é usado para nenhuma autorização.
           </span>
          </p></blockquote>
         </p>
        </dd>
       
       
        <dt><code class="parameter">acctstr</code></dt>
        <dd>
         <p class="para">
          <code class="literal">SQL_ATTR_INFO_ACCTSTR</code> - Um ponteiro para uma string
          terminada em nulo usada para identificar a sequência de contabilidade do cliente enviada ao
          servidor de banco de dados host ao usar o DB2 Connect.
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <span class="simpara">
            Os servidores DB2 para z/OS e OS/390 suportam até 200 caracteres.
           </span>
          </p></blockquote>
         </p>
        </dd>
       
       
        <dt><code class="parameter">applname</code></dt>
        <dd>
         <p class="para">
          <code class="literal">SQL_ATTR_INFO_APPLNAME</code> - Um ponteiro para uma string terminada em nulo
          usada para identificar o nome do aplicativo cliente enviado ao
          servidor de banco de dados host ao usar o DB2 Connect.
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <span class="simpara">
            Os servidores DB2 para z/OS e OS/390 suportam até 32 caracteres.
           </span>
          </p></blockquote>
         </p>
        </dd>
       
       
        <dt><code class="parameter">wrkstnname</code></dt>
        <dd>
         <p class="para">
          <code class="literal">SQL_ATTR_INFO_WRKSTNNAME</code> - Um ponteiro para uma string terminada em nulo
          usada para identificar o nome da estação de trabalho do cliente enviado para o
          servidor de banco de dados host ao usar o DB2 Connect.
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <span class="simpara">
            Os servidores DB2 para z/OS e OS/390 suportam até 18 caracteres.
           </span>
          </p></blockquote>
         </p>
        </dd>
       
      </dl>
     </p>
    </dd>
   
  </dl>
  <p class="para">
   A tabela a seguir especifica quais opções são compatíveis com
   os tipos de recursos disponíveis:
   <table class="doctable table">
    <caption><strong>Matriz Recurso-Parâmetro</strong></caption>
    
     <col style="text-align: center;" />
     <col style="text-align: center;" />
     <col style="text-align: center;" />
     <col style="text-align: center;" />
     <col style="text-align: center;" />
     <thead>
      <tr>
       <th>Chave</th>
       <th>Valor</th>
       <th colspan="3">Tipo de recurso</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td class="empty">&nbsp;</td><td class="empty">&nbsp;</td><td>Conexão</td>
       <td>Instrução</td>
       <td>Conjunto de Resultados</td>
      </tr>

      <tr>
       <td>userid</td>
       <td><code class="literal">SQL_ATTR_INFO_USERID</code></td>
       <td>X</td>
       <td>X</td>
       <td>-</td>
      </tr>

      <tr>
       <td>acctstr</td>
       <td><code class="literal">SQL_ATTR_INFO_ACCTSTR</code></td>
       <td>X</td>
       <td>X</td>
       <td>-</td>
      </tr>

      <tr>
       <td>applname</td>
       <td><code class="literal">SQL_ATTR_INFO_APPLNAME</code></td>
       <td>X</td>
       <td>X</td>
       <td>-</td>
      </tr>

      <tr>
       <td>wrkstnname</td>
       <td><code class="literal">SQL_ATTR_INFO_WRKSTNNAME</code></td>
       <td>X</td>
       <td>X</td>
       <td>-</td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.db2-get-option-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="simpara">
   Retorna a configuração atual do atributo de conexão fornecido em caso de sucesso
    ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.db2-get-option-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Definindo e recuperando parâmetros por meio de um recurso de conexão</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">/* Parâmetros de conexão do banco de dados */<br /></span><span style="color: #0000BB">$database </span><span style="color: #007700">= </span><span style="color: #DD0000">'SAMPLE'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$user     </span><span style="color: #007700">= </span><span style="color: #DD0000">'db2inst1'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$password </span><span style="color: #007700">= </span><span style="color: #DD0000">'ibmdb2'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Obtém Recurso de Conexão */<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Atributos do cliente passados ​​pela string de conexão:\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Cria o array associativo de opções com pares de chave-valor válidos */<br />/* Atribui os atributos por meio da string de conexão */<br />/* Acessa as opções especificadas */<br /></span><span style="color: #0000BB">$options1 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'userid' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'db2inst1'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn1 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$options1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn1</span><span style="color: #007700">, </span><span style="color: #DD0000">'userid'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options2 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'acctstr' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'account'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn2 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$options2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn2</span><span style="color: #007700">, </span><span style="color: #DD0000">'acctstr'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options3 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'applname' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'myapp'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn3 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$options3</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn3</span><span style="color: #007700">, </span><span style="color: #DD0000">'applname'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options4 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'wrkstnname' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'workstation'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn4 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$options4</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn4</span><span style="color: #007700">, </span><span style="color: #DD0000">'wrkstnname'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br />echo </span><span style="color: #DD0000">"Atributos do cliente transmitidos após a conexão:\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* Cria o array associativo de opções com pares de chave-valor válidos */<br />/* Atribui os atributos depois que a conexão é feita */<br />/* Acessa as opções especificadas */<br /></span><span style="color: #0000BB">$options5 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'userid' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'db2inst1'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn5 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn5</span><span style="color: #007700">, </span><span style="color: #0000BB">$options5</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn5</span><span style="color: #007700">, </span><span style="color: #DD0000">'userid'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options6 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'acctstr' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'account'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn6 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn6</span><span style="color: #007700">, </span><span style="color: #0000BB">$options6</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn6</span><span style="color: #007700">, </span><span style="color: #DD0000">'acctstr'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options7 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'applname' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'myapp'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn7 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn7</span><span style="color: #007700">, </span><span style="color: #0000BB">$options7</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn7</span><span style="color: #007700">, </span><span style="color: #DD0000">'applname'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$options8 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'wrkstnname' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'workstation'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn8 </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn8</span><span style="color: #007700">, </span><span style="color: #0000BB">$options8</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_get_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn8</span><span style="color: #007700">, </span><span style="color: #DD0000">'wrkstnname'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$val </span><span style="color: #007700">. </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Atributos do cliente passados ​​pela string de conexão:
db2inst1
account
myapp
workstation
Atributos do cliente transmitidos após a conexão:
db2inst1
account
myapp
workstation</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.db2-get-option-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.db2-connect.php" class="function" rel="rdfs-seeAlso">db2_connect()</a> - Retorna uma conex&atilde;o com um banco de dados</span></li>
   <li><span class="function"><a href="function.db2-cursor-type.php" class="function" rel="rdfs-seeAlso">db2_cursor_type()</a> - Retorna o tipo de cursor usado por um recurso de instru&ccedil;&atilde;o</span></li>
   <li><span class="function"><a href="function.db2-exec.php" class="function" rel="rdfs-seeAlso">db2_exec()</a> - Executa uma instru&ccedil;&atilde;o SQL diretamente</span></li>
   <li><span class="function"><a href="function.db2-set-option.php" class="function" rel="rdfs-seeAlso">db2_set_option()</a> - Define op&ccedil;&otilde;es para recursos de conex&atilde;o ou instru&ccedil;&atilde;o</span></li>
   <li><span class="function"><a href="function.db2-pconnect.php" class="function" rel="rdfs-seeAlso">db2_pconnect()</a> - Retorna uma conex&atilde;o persistente a um banco de dados</span></li>
   <li><span class="function"><a href="function.db2-prepare.php" class="function" rel="rdfs-seeAlso">db2_prepare()</a> - Prepara uma instru&ccedil;&atilde;o SQL para ser executada</span></li>
  </ul>
 </div>


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