<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mongodb-bson-iterator.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'mongodb-bson-iterator.key.php',
    1 => 'MongoDB\\BSON\\Iterator::key',
    2 => 'Returns the key of the current element',
  ),
  'up' => 
  array (
    0 => 'class.mongodb-bson-iterator.php',
    1 => 'MongoDB\\BSON\\Iterator',
  ),
  'prev' => 
  array (
    0 => 'mongodb-bson-iterator.current.php',
    1 => 'MongoDB\\BSON\\Iterator::current',
  ),
  'next' => 
  array (
    0 => 'mongodb-bson-iterator.next.php',
    1 => 'MongoDB\\BSON\\Iterator::next',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mongodb/bson/iterator/key.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mongodb-bson-iterator.key" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB\BSON\Iterator::key</h1>
  <p class="verinfo">(mongodb &gt;=1.16.0)</p><p class="refpurpose"><span class="refname">MongoDB\BSON\Iterator::key</span> &mdash; <span class="dc-title">Returns the key of the current element</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb-bson-iterator.key-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\BSON\Iterator::key</strong></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.integer.php" class="type int">int</a></span></span></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb-bson-iterator.key-parameters">
  <h3 class="title">参数</h3>
  <p class="para">此函数没有参数。</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb-bson-iterator.key-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns the key of the current element. When iterating a BSON document, the
   key will always be a <span class="type"><a href="language.types.string.php" class="type string">string</a></span>. When iterating a BSON array, the
   key will be an <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mongodb-bson-iterator.key-errors">
  <h3 class="title">错误／异常</h3>
  <ul class="simplelist">
   <li>Throws <span class="classname"><a href="class.mongodb-driver-exception-invalidargumentexception.php" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a></span> on argument parsing errors.</li>
   <li>Throws <span class="classname"><a href="class.mongodb-driver-exception-logicexception.php" class="classname">MongoDB\Driver\Exception\LogicException</a></span> if the iterator is not valid.</li>
  </ul>
 </div>


 <div class="refsect1 seealso" id="refsect1-mongodb-bson-iterator.key-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="iterator.key.php" class="methodname" rel="rdfs-seeAlso">Iterator::key()</a> - 返回当前元素的键</span></li>
  </ul>
 </div>

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