<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.yaz.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.yaz-connect.php',
    1 => 'yaz_connect',
    2 => 'Prepara para uma conex&atilde;o com um servidor Z39.50',
  ),
  'up' => 
  array (
    0 => 'ref.yaz.php',
    1 => 'Fun&ccedil;&otilde;es de YAZ',
  ),
  'prev' => 
  array (
    0 => 'function.yaz-close.php',
    1 => 'yaz_close',
  ),
  'next' => 
  array (
    0 => 'function.yaz-database.php',
    1 => 'yaz_database',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/yaz/functions/yaz-connect.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.yaz-connect" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">yaz_connect</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PECL yaz &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_connect</span> &mdash; <span class="dc-title">
   Prepara para uma conexão com um servidor Z39.50
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.yaz-connect-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>yaz_connect</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$zurl</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$options</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="para rdfs-comment">
   Esta função retorna um recurso de conexão em caso de sucesso, zero em caso de
   falha.
  </p>
  <p class="para">
   <span class="function"><strong>yaz_connect()</strong></span> prepara uma conexão com um
   servidor Z39.50.
   Esta função não é bloqueante e não tenta estabelecer
   uma conexão - ela apenas prepara uma conexão para ser executada posteriormente quando
   <span class="function"><a href="function.yaz-wait.php" class="function">yaz_wait()</a></span> for chamado.
  </p>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    O <a href="http://www.indexdata.dk/yazproxy/" class="link external">&raquo;&nbsp;proxy YAZ</a> é um
    proxy Z39.50 disponível gratuitamente.
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.yaz-connect-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">zurl</code></dt>
     <dd>
      <p class="para">
       Uma string que assume o formato <code class="literal">host[:porta][/banco_de_dados]</code>.
       Se a porta for omitida, a porta 210 será usada. Se o banco de dados for omitido,
       <code class="literal">Default</code> será usado.
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       Se fornecido como uma string, será tratado como a string de autenticação Z39.50 V2
       (OpenAuth).
      </p>
      <p class="para">
       Se fornecido como um array, o conteúdo do array serve como opções.
       <dl>
        
         <dt>user</dt>
         <dd>
          <p class="para">
           Nome de usuário para autenticação.
          </p>
         </dd>
        
        
         <dt>group</dt>
         <dd>
          <p class="para">
           Grupo para autenticação.
          </p>
         </dd>
        
        
         <dt>password</dt>
          <dd>
           <p class="para">
            Senha para autenticação.
           </p>
          </dd>
        
        
         <dt>cookie</dt>
         <dd>
          <p class="para">
           Cookie para sessão (proxy YAZ).
          </p>
         </dd>
        
        
         <dt>proxy</dt>
         <dd>
          <p class="para">
           Proxy para conexão (proxy YAZ).
          </p>
         </dd>
        
        
         <dt>persistent</dt>
         <dd>
          <p class="para">
           Um booleano. Se <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> a conexão é persistente; se <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> a
           conexão não é persistente. Por padrão, as conexões são persistentes.
          </p>
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <p class="para">
            Se uma conexão persistente for aberta, não será possível fechá-la
            mais tarde com <span class="function"><a href="function.yaz-close.php" class="function">yaz_close()</a></span>.
           </p>
          </p></blockquote>
         </dd>
        
        
         <dt>piggyback</dt>
         <dd>
          <p class="para">
           Um booleano. Se <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, piggyback estará habilitado para pesquisas; Se <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
           piggyback estará desabilitado. Por padrão, o piggyback está habilitado.
          </p>
          <p class="para">
           Habilitar o piggyback é mais eficiente e geralmente economiza
           uma viagem de ida e volta pela rede para as primeiras buscas de registros. No entanto,
           alguns servidores Z39.50 não suportam piggyback ou ignoram
           nomes de conjuntos de elementos. Para esses, o piggyback deve ser desabilitado.
          </p>
         </dd>
        
        
         <dt>charset</dt>
         <dd>
          <p class="para">
           Uma string que especifica o conjunto de caracteres a ser usado na linguagem Z39.50
           e a negociação do conjunto de caracteres. Use strings como:
           <code class="literal">ISO-8859-1</code>, <code class="literal">UTF-8</code> ou
           <code class="literal">UTF-16</code>.
          </p>
          <p class="para">
           A maioria dos servidores Z39.50 não oferece suporte a esse recurso (e, portanto, ele é
           ignorado). Muitos servidores usam a codificação ISO-8859-1 para consultas e
           mensagens. Registros MARC21/USMARC não são afetados por esta configuração.
          </p>
         </dd>
        

        
         <dt>preferredMessageSize</dt>
         <dd>
          <p class="para">
           Um inteiro que especifica o tamanho máximo em bytes de todos os registros
           a serem retornados por um destino durante a recuperação. Consulte o
           <a href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.1.1.4" class="link external">&raquo;&nbsp;padrão Z39.50</a> para mais
           informações.
          </p>
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <p class="para">
            Esta opção é suportada no PECL YAZ 1.0.5 ou posterior.
           </p>
          </p></blockquote>
         </dd>
        

        
         <dt>maximumRecordSize</dt>
         <dd>
          <p class="para">
           Um inteiro que especifica o tamanho máximo em bytes de um único registro
           a ser retornado por um destino durante a recuperação. Esta
           entidade é chamada de Exceptional-record-size (tamanho de registro excepcional) no
           <a href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.1.1.4" class="link external">&raquo;&nbsp;padrão Z39.50</a>.
          </p>
          <blockquote class="note"><p><strong class="note">Nota</strong>: 
           <p class="para">
            Esta opção é suportada no PECL YAZ 1.0.5 ou posterior.
           </p>
          </p></blockquote>
         </dd>
        

       </dl>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.yaz-connect-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Um recurso de conexão em caso de sucesso, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de erro.
  </p>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.yaz-connect-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.yaz-close.php" class="function" rel="rdfs-seeAlso">yaz_close()</a> - Fecha a conex&atilde;o YAZ</span></li>
   </ul>
  </p>
 </div>

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