<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qcryptographichash.cpp --> <title>QCryptographicHash Class | Qt Core 5.12.6</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.12</td><td ><a href="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >QCryptographicHash</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right"><a href="qtcore-index.html">Qt 5.12.6 Reference Documentation</a></td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-types">Public Types</a></li> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#static-public-members">Static Public Members</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QCryptographicHash Class</h1> <!-- $$$QCryptographicHash-brief --> <p>The <a href="qcryptographichash.html">QCryptographicHash</a> class provides a way to generate cryptographic hashes. <a href="#details">More...</a></p> <!-- @@@QCryptographicHash --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QCryptographicHash></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += core</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 4.3</td></tr></table></div><ul> <li><a href="qcryptographichash-members.html">List of all members, including inherited members</a></li> </ul> <p><b>Note:</b> All functions in this class are reentrant.</p> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#Algorithm-enum">Algorithm</a></b> { Md4, Md5, Sha1, Sha224, ..., Keccak_512 }</td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#QCryptographicHash">QCryptographicHash</a></b>(QCryptographicHash::Algorithm <i>method</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#dtor.QCryptographicHash">~QCryptographicHash</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#addData">addData</a></b>(const char *<i>data</i>, int <i>length</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#addData-1">addData</a></b>(const QByteArray &<i>data</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#addData-2">addData</a></b>(QIODevice *<i>device</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#reset">reset</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#result">result</a></b>() const</td></tr> </table></div> <a name="static-public-members"></a> <h2 id="static-public-members">Static Public Members</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#hash">hash</a></b>(const QByteArray &<i>data</i>, QCryptographicHash::Algorithm <i>method</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#hashLength">hashLength</a></b>(QCryptographicHash::Algorithm <i>method</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qcryptographichash.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QCryptographicHash-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qcryptographichash.html">QCryptographicHash</a> class provides a way to generate cryptographic hashes.</p> <p><a href="qcryptographichash.html">QCryptographicHash</a> can be used to generate cryptographic hashes of binary or text data.</p> <p>Refer to the documentation of the <a href="qcryptographichash.html#Algorithm-enum">QCryptographicHash::Algorithm</a> enum for a list of the supported algorithms.</p> </div> <!-- @@@QCryptographicHash --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$Algorithm$$$Md4$$$Md5$$$Sha1$$$Sha224$$$Sha256$$$Sha384$$$Sha512$$$Keccak_224$$$Keccak_256$$$Keccak_384$$$Keccak_512$$$RealSha3_224$$$RealSha3_256$$$RealSha3_384$$$RealSha3_512$$$Sha3_224$$$Sha3_256$$$Sha3_384$$$Sha3_512 --> <h3 class="fn" id="Algorithm-enum"><a name="Algorithm-enum"></a>enum QCryptographicHash::<span class="name">Algorithm</span></h3> <p><b>Note: </b>In Qt versions before 5.9, when asked to generate a SHA3 hash sum, <a href="qcryptographichash.html">QCryptographicHash</a> actually calculated Keccak. If you need compatibility with SHA-3 hashes produced by those versions of Qt, use the <code>Keccak_</code> enumerators. Alternatively, if source compatibility is required, define the macro <code>QT_SHA3_KECCAK_COMPAT</code>.</p><div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>QCryptographicHash::Md4</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">Generate an MD4 hash sum</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Md5</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">Generate an MD5 hash sum</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha1</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">Generate an SHA-1 hash sum</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha224</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">Generate an SHA-224 hash sum (SHA-2). Introduced in Qt 5.0</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha256</code></td><td class="topAlign tblval"><code>4</code></td><td class="topAlign">Generate an SHA-256 hash sum (SHA-2). Introduced in Qt 5.0</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha384</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">Generate an SHA-384 hash sum (SHA-2). Introduced in Qt 5.0</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha512</code></td><td class="topAlign tblval"><code>6</code></td><td class="topAlign">Generate an SHA-512 hash sum (SHA-2). Introduced in Qt 5.0</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha3_224</code></td><td class="topAlign tblval"><code>RealSha3_224</code></td><td class="topAlign">Generate an SHA3-224 hash sum. Introduced in Qt 5.1</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha3_256</code></td><td class="topAlign tblval"><code>RealSha3_256</code></td><td class="topAlign">Generate an SHA3-256 hash sum. Introduced in Qt 5.1</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha3_384</code></td><td class="topAlign tblval"><code>RealSha3_384</code></td><td class="topAlign">Generate an SHA3-384 hash sum. Introduced in Qt 5.1</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Sha3_512</code></td><td class="topAlign tblval"><code>RealSha3_512</code></td><td class="topAlign">Generate an SHA3-512 hash sum. Introduced in Qt 5.1</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Keccak_224</code></td><td class="topAlign tblval"><code>7</code></td><td class="topAlign">Generate a Keccak-224 hash sum. Introduced in Qt 5.9.2</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Keccak_256</code></td><td class="topAlign tblval"><code>8</code></td><td class="topAlign">Generate a Keccak-256 hash sum. Introduced in Qt 5.9.2</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Keccak_384</code></td><td class="topAlign tblval"><code>9</code></td><td class="topAlign">Generate a Keccak-384 hash sum. Introduced in Qt 5.9.2</td></tr> <tr><td class="topAlign"><code>QCryptographicHash::Keccak_512</code></td><td class="topAlign tblval"><code>10</code></td><td class="topAlign">Generate a Keccak-512 hash sum. Introduced in Qt 5.9.2</td></tr> </table></div> <!-- @@@Algorithm --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QCryptographicHash[overload1]$$$QCryptographicHashQCryptographicHash::Algorithm --> <h3 class="fn" id="QCryptographicHash"><a name="QCryptographicHash"></a>QCryptographicHash::<span class="name">QCryptographicHash</span>(<span class="type"><a href="qcryptographichash.html#Algorithm-enum">QCryptographicHash::Algorithm</a></span> <i>method</i>)</h3> <p>Constructs an object that can be used to create a cryptographic hash from data using <i>method</i>.</p> <!-- @@@QCryptographicHash --> <!-- $$$~QCryptographicHash[overload1]$$$~QCryptographicHash --> <h3 class="fn" id="dtor.QCryptographicHash"><a name="dtor.QCryptographicHash"></a>QCryptographicHash::<span class="name">~QCryptographicHash</span>()</h3> <p>Destroys the object.</p> <!-- @@@~QCryptographicHash --> <!-- $$$addData[overload1]$$$addDataconstchar*int --> <h3 class="fn" id="addData"><a name="addData"></a><span class="type">void</span> QCryptographicHash::<span class="name">addData</span>(const <span class="type">char</span> *<i>data</i>, <span class="type">int</span> <i>length</i>)</h3> <p>Adds the first <i>length</i> chars of <i>data</i> to the cryptographic hash.</p> <!-- @@@addData --> <!-- $$$addData$$$addDataconstQByteArray& --> <h3 class="fn" id="addData-1"><a name="addData-1"></a><span class="type">void</span> QCryptographicHash::<span class="name">addData</span>(const <span class="type"><a href="qbytearray.html">QByteArray</a></span> &<i>data</i>)</h3> <p>This function overloads <a href="qcryptographichash.html#addData">addData</a>().</p> <!-- @@@addData --> <!-- $$$addData$$$addDataQIODevice* --> <h3 class="fn" id="addData-2"><a name="addData-2"></a><span class="type">bool</span> QCryptographicHash::<span class="name">addData</span>(<span class="type"><a href="qiodevice.html">QIODevice</a></span> *<i>device</i>)</h3> <p>Reads the data from the open <a href="qiodevice.html">QIODevice</a> <i>device</i> until it ends and hashes it. Returns <code>true</code> if reading was successful.</p> <p>This function was introduced in Qt 5.0.</p> <!-- @@@addData --> <!-- $$$hash[overload1]$$$hashconstQByteArray&QCryptographicHash::Algorithm --> <h3 class="fn" id="hash"><a name="hash"></a><code>[static] </code><span class="type"><a href="qbytearray.html">QByteArray</a></span> QCryptographicHash::<span class="name">hash</span>(const <span class="type"><a href="qbytearray.html">QByteArray</a></span> &<i>data</i>, <span class="type"><a href="qcryptographichash.html#Algorithm-enum">QCryptographicHash::Algorithm</a></span> <i>method</i>)</h3> <p>Returns the hash of <i>data</i> using <i>method</i>.</p> <!-- @@@hash --> <!-- $$$hashLength[overload1]$$$hashLengthQCryptographicHash::Algorithm --> <h3 class="fn" id="hashLength"><a name="hashLength"></a><code>[static] </code><span class="type">int</span> QCryptographicHash::<span class="name">hashLength</span>(<span class="type"><a href="qcryptographichash.html#Algorithm-enum">QCryptographicHash::Algorithm</a></span> <i>method</i>)</h3> <p>Returns the size of the output of the selected hash <i>method</i> in bytes.</p> <p>This function was introduced in Qt 5.12.</p> <!-- @@@hashLength --> <!-- $$$reset[overload1]$$$reset --> <h3 class="fn" id="reset"><a name="reset"></a><span class="type">void</span> QCryptographicHash::<span class="name">reset</span>()</h3> <p>Resets the object.</p> <!-- @@@reset --> <!-- $$$result[overload1]$$$result --> <h3 class="fn" id="result"><a name="result"></a><span class="type"><a href="qbytearray.html">QByteArray</a></span> QCryptographicHash::<span class="name">result</span>() const</h3> <p>Returns the final hash value.</p> <p><b>See also </b><a href="qbytearray.html#toHex">QByteArray::toHex</a>().</p> <!-- @@@result --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>