<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mcrypt.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.mcrypt-get-key-size.php',
    1 => 'mcrypt_get_key_size',
    2 => '指定した暗号のキーの長さを得る',
  ),
  'up' => 
  array (
    0 => 'ref.mcrypt.php',
    1 => 'Mcrypt 関数',
  ),
  'prev' => 
  array (
    0 => 'function.mcrypt-get-iv-size.php',
    1 => 'mcrypt_get_iv_size',
  ),
  'next' => 
  array (
    0 => 'function.mcrypt-list-algorithms.php',
    1 => 'mcrypt_list_algorithms',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/mcrypt/functions/mcrypt-get-key-size.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mcrypt-get-key-size" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mcrypt_get_key_size</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7 &lt; 7.2.0, PECL mcrypt &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">mcrypt_get_key_size</span> &mdash; <span class="dc-title">指定した暗号のキーの長さを得る</span></p>

 </div>
 <div id="function.mcrypt-get-key-size-refsynopsisdiv">
  <div class="warning"><strong class="warning">警告</strong><p class="simpara">この関数は PHP 7.1.0 で
<em>非推奨</em>となり、PHP 7.2.0 で<em>削除</em>
されました。この関数に頼らないことを強く推奨します。</p></div>
 </div>
 <div class="refsect1 description" id="refsect1-function.mcrypt-get-key-size-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>mcrypt_get_key_size</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$cipher</code></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <div class="methodsynopsis dc-description"><span class="methodname"><strong>mcrypt_get_key_size</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$cipher</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$mode</code></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   最初のプロトタイプは libmcrypt 2.2.x とリンクした場合であり、2 番目の
   ものは libmcrypt 2.4.x あるいは 2.5.x とリンクした場合です。
  </p>
  <p class="simpara">
   <span class="function"><strong>mcrypt_get_key_size()</strong></span> は、
   <code class="parameter">cipher</code> で(暗号化モードとあわせて)指定した
   キーの長さを得るために使用されます。
  </p>
  <p class="simpara">
   <span class="function"><a href="function.mcrypt-enc-get-key-size.php" class="function">mcrypt_enc_get_key_size()</a></span> 関数を使用するほうが
   より有用です。これは <span class="function"><a href="function.mcrypt-module-open.php" class="function">mcrypt_module_open()</a></span>
   が返すリソースを使用します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.mcrypt-get-key-size-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">cipher</code></dt>
    <dd>
     <p class="para"><strong><code>MCRYPT_暗号名</code></strong> 定数のいずれか、
あるいはアルゴリズム名をあらわす文字列。</p>
    </dd>
   
   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <p class="para">定数 <strong><code>MCRYPT_MODE_モード名</code></strong>、あるいは文字列
&quot;ecb&quot;, &quot;cbc&quot;, &quot;cfb&quot;, &quot;ofb&quot;, &quot;nofb&quot; ,&quot;stream&quot; のいずれか。</p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mcrypt-get-key-size-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   そのアルゴリズムでサポートする最長のキーサイズをバイト数で返します。
   失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.mcrypt-get-key-size-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>mcrypt_get_key_size()</strong></span> の例</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: #007700">echo </span><span style="color: #0000BB">mcrypt_get_key_size</span><span style="color: #007700">(</span><span style="color: #DD0000">'tripledes'</span><span style="color: #007700">, </span><span style="color: #DD0000">'ecb'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>
    この例では、libmcrypt 2.4.x および 2.5.x とリンクした場合の
    この関数の使用法を示します。
   </p></div>
   <div class="example-contents"><p>上の例の出力は以下となります。</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">24</pre>
</div>
   </div>
  </div>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.mcrypt-get-key-size-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.mcrypt-get-block-size.php" class="function" rel="rdfs-seeAlso">mcrypt_get_block_size()</a> - 指定した暗号のブロックサイズを得る</span></li>
   <li><span class="function"><a href="function.mcrypt-enc-get-key-size.php" class="function" rel="rdfs-seeAlso">mcrypt_enc_get_key_size()</a> - オープンされたモードでサポートされる最大キー長を返す</span></li>
   <li><span class="function"><a href="function.mcrypt-encrypt.php" class="function" rel="rdfs-seeAlso">mcrypt_encrypt()</a> - 指定したパラメータでプレーンテキストを暗号化する</span></li>
  </ul>
 </div>


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