<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.yaz-connect.php',
    1 => 'yaz_connect',
    2 => 'Z39.50 サーバーへの接続を準備する',
  ),
  'up' => 
  array (
    0 => 'ref.yaz.php',
    1 => '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' => 'ja',
    '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">
   Z39.50 サーバーへの接続を準備する
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.yaz-connect-description">
  <h3 class="title">説明</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">
   この関数は、成功した場合に接続リソース、失敗した場合にゼロを返します。
  </p>
  <p class="para">
   <span class="function"><strong>yaz_connect()</strong></span> は Z39.50 サーバーへの接続を準備します。
   この関数は非ブロックモードで動作し、接続を確立しようとしません
   - 単にあとで <span class="function"><a href="function.yaz-wait.php" class="function">yaz_wait()</a></span> がコールされた際に
   接続を実行する準備を行うだけです。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    <a href="http://www.indexdata.dk/yazproxy/" class="link external">&raquo;&nbsp;YAZ プロキシ</a>
    は、フリーで使用可能な Z39.50 のプロキシです。
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.yaz-connect-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">zurl</code></dt>
     <dd>
      <p class="para">
       <code class="literal">host[:port][/database]</code> という形式の文字列です。
       port が省略された場合、210 が使用されます。database が省略された
       場合、<code class="literal">Default</code> が使用されます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       文字列が指定された場合、
       Z39.50 V2 認証文字列(OpenAuth)として処理されます。
      </p>
      <p class="para">
       配列が指定された場合、その配列の内容はオプションとして処理されます。
       <dl>
        
         <dt>user</dt>
         <dd>
          <p class="para">
           認証用のユーザー名
          </p>
         </dd>
        
        
         <dt>group</dt>
         <dd>
          <p class="para">
           認証用のグループ
          </p>
         </dd>
        
        
         <dt>password</dt>
          <dd>
           <p class="para">
            認証用のパスワード
           </p>
          </dd>
        
        
         <dt>cookie</dt>
         <dd>
          <p class="para">
           セッションクッキー（YAZ プロキシ）
          </p>
         </dd>
        
        
         <dt>proxy</dt>
         <dd>
          <p class="para">
           接続用プロキシ（YAZ プロキシ）
          </p>
         </dd>
        
        
         <dt>persistent</dt>
         <dd>
          <p class="para">
           論理値。<strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> の場合、接続は持続的となります。<strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> の
           場合、接続は持続的ではありません。デフォルトでは
           接続は持続的です。
          </p>
          <blockquote class="note"><p><strong class="note">注意</strong>: 
           <p class="para">
            持続的な接続をオープンした場合、後でそれを
            <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">
           論理値。<strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> の場合、検索時の piggyback が有効になります。
           <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> の場合、piggyback が無効になります。デフォルトでは
           piggyback は有効です。
          </p>
          <p class="para">
           piggyback を有効にするとより効率的となり、
           通常、レコードを最初に取得する際のネットワーク往復時間を
           節約することが可能です。しかし、少数の Z39.50 ターゲットは
           piggyback をサポートしていないか、エレメント集合名を無視します。
           この場合、piggyback を無効とする必要があります。
          </p>
         </dd>
        
        
         <dt>charset</dt>
         <dd>
          <p class="para">
           Z39.50 の言語および文字セットネゴシエーションに使用する
           文字セットを指定する文字列。以下のような文字列を使用します。
           <code class="literal">ISO-8859-1</code>、<code class="literal">UTF-8</code>、
           <code class="literal">UTF-16</code> 。
          </p>
          <p class="para">
           ほとんどの Z39.50 サーバーはこの機能をサポートしません（そのため、
           無視されます）。ほとんどのサーバーは、クエリやメッセージに
           ISO-8859-1 エンコーディングを使用します。MARC21/USMARC レコードは
           この設定の影響を受けません。
          </p>
         </dd>
        

        
         <dt>preferredMessageSize</dt>
         <dd>
          <p class="para">
           ターゲットから取得される全レコードの最大バイト数を指定する整数値。
           詳細な情報は
           <a href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.1.1.4" class="link external">&raquo;&nbsp;Z39.50 standard</a>
           を参照ください。
          </p>
          <blockquote class="note"><p><strong class="note">注意</strong>: 
           <p class="para">
            このオプションは PECL YAZ 1.0.5 以降でサポートされます。
           </p>
          </p></blockquote>
         </dd>
        

        
         <dt>maximumRecordSize</dt>
         <dd>
          <p class="para">
           ターゲットから取得される単一のレコードの最大バイト数を指定する
           整数値。この項目は、
          <a href="http://www.loc.gov/z3950/agency/markup/04.html#3.2.1.1.4" class="link external">&raquo;&nbsp;Z39.50 standard</a>
           の Exceptional-record-size として参照されます。
          </p>
          <blockquote class="note"><p><strong class="note">注意</strong>: 
           <p class="para">
            このオプションは PECL YAZ 1.0.5 以降でサポートされます。
           </p>
          </p></blockquote>
         </dd>
        

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

 <div class="refsect1 returnvalues" id="refsect1-function.yaz-connect-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に接続リソース、エラー時に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.yaz-connect-seealso">
  <h3 class="title">参考</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> - YAZ 接続をクローズする</span></li>
   </ul>
  </p>
 </div>

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