php-doc-en/reference/strings/functions/sha1-file.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
  <refentry id="function.sha1-file">
   <refnamediv>
    <refname>sha1_file</refname>
    <refpurpose>Calculate the sha1 hash of a file</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>sha1_file</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam choice='opt'><type>bool</type><parameter>raw_output</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Calculates the sha1 hash of <parameter>filename</parameter> using the
     <ulink url="&url.rfc;3174">US Secure Hash Algorithm 1</ulink>,
     and returns that hash. The hash is a 40-character hexadecimal number.
     Upon failure, &false; is returned.  If the optional 
     <parameter>raw_output</parameter> is set to &true;, then the sha1 digest 
     is instead returned in raw binary format with a length of 20.
    </simpara>
    <note>
     <simpara>
      The optional <parameter>raw_output</parameter> parameter was added in
      PHP 5.0.0 and defaults to &false;
     </simpara>
    </note>
    <simpara>
     See also <function>sha1</function>, <function>crc32</function>,
     and <function>md5_file</function> 
    </simpara>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->