<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qsslkey.cpp -->
<title>Qt 4.8: QSslKey Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtnetwork.html">QtNetwork</a></li>
<li>QSslKey</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QSslKey Class Reference</h1>
<!-- $$$QSslKey-brief -->
<p>The QSslKey class provides an interface for private and public keys. <a href="#details">More...</a></p>
<!-- @@@QSslKey -->
<pre class="cpp"> <span class="preprocessor">#include <QSslKey></span></pre><p><b>Note:</b> All functions in this class are <a href="threads-reentrancy.html#reentrant">reentrant</a>.</p>
<p>This class was introduced in Qt 4.3.</p>
<ul>
<li><a href="qsslkey-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#QSslKey">QSslKey</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#QSslKey-2">QSslKey</a></b> ( const QByteArray & <i>encoded</i>, QSsl::KeyAlgorithm <i>algorithm</i>, QSsl::EncodingFormat <i>encoding</i> = QSsl::Pem, QSsl::KeyType <i>type</i> = QSsl::PrivateKey, const QByteArray & <i>passPhrase</i> = QByteArray() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#QSslKey-3">QSslKey</a></b> ( QIODevice * <i>device</i>, QSsl::KeyAlgorithm <i>algorithm</i>, QSsl::EncodingFormat <i>encoding</i> = QSsl::Pem, QSsl::KeyType <i>type</i> = QSsl::PrivateKey, const QByteArray & <i>passPhrase</i> = QByteArray() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#QSslKey-4">QSslKey</a></b> ( const QSslKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#dtor.QSslKey">~QSslKey</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSsl::KeyAlgorithm </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#algorithm">algorithm</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::HANDLE </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#handle">handle</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#isNull">isNull</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#length">length</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#toDer">toDer</a></b> ( const QByteArray & <i>passPhrase</i> = QByteArray() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#toPem">toPem</a></b> ( const QByteArray & <i>passPhrase</i> = QByteArray() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSsl::KeyType </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#type">type</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#operator-not-eq">operator!=</a></b> ( const QSslKey & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QSslKey & </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#operator-eq">operator=</a></b> ( const QSslKey & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qsslkey.html#operator-eq-eq">operator==</a></b> ( const QSslKey & <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QSslKey-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QSslKey class provides an interface for private and public keys.</p>
<p>QSslKey provides a simple API for managing keys.</p>
</div>
<p><b>See also </b><a href="qsslsocket.html">QSslSocket</a>, <a href="qsslcertificate.html">QSslCertificate</a>, and <a href="qsslcipher.html">QSslCipher</a>.</p>
<!-- @@@QSslKey -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSslKey[overload1]$$$QSslKey -->
<h3 class="fn"><a name="QSslKey"></a>QSslKey::<span class="name">QSslKey</span> ()</h3>
<p>Constructs a null key.</p>
<p><b>See also </b><a href="qsslkey.html#isNull">isNull</a>().</p>
<!-- @@@QSslKey -->
<!-- $$$QSslKey$$$QSslKeyconstQByteArray&QSsl::KeyAlgorithmQSsl::EncodingFormatQSsl::KeyTypeconstQByteArray& -->
<h3 class="fn"><a name="QSslKey-2"></a>QSslKey::<span class="name">QSslKey</span> ( const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>encoded</i>, <span class="type"><a href="qssl.html#KeyAlgorithm-enum">QSsl::KeyAlgorithm</a></span> <i>algorithm</i>, <span class="type"><a href="qssl.html#EncodingFormat-enum">QSsl::EncodingFormat</a></span> <i>encoding</i> = QSsl::Pem, <span class="type"><a href="qssl.html#KeyType-enum">QSsl::KeyType</a></span> <i>type</i> = QSsl::PrivateKey, const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>passPhrase</i> = QByteArray() )</h3>
<p>Constructs a <a href="qsslkey.html">QSslKey</a> by decoding the string in the byte array <i>encoded</i> using a specified <i>algorithm</i> and <i>encoding</i> format. If the encoded key is encrypted, <i>passPhrase</i> is used to decrypt it. <i>type</i> specifies whether the key is public or private.</p>
<p>After construction, use <a href="qsslkey.html#isNull">isNull</a>() to check if <i>encoded</i> contained a valid key.</p>
<!-- @@@QSslKey -->
<!-- $$$QSslKey$$$QSslKeyQIODevice*QSsl::KeyAlgorithmQSsl::EncodingFormatQSsl::KeyTypeconstQByteArray& -->
<h3 class="fn"><a name="QSslKey-3"></a>QSslKey::<span class="name">QSslKey</span> ( <span class="type"><a href="qiodevice.html">QIODevice</a></span> * <i>device</i>, <span class="type"><a href="qssl.html#KeyAlgorithm-enum">QSsl::KeyAlgorithm</a></span> <i>algorithm</i>, <span class="type"><a href="qssl.html#EncodingFormat-enum">QSsl::EncodingFormat</a></span> <i>encoding</i> = QSsl::Pem, <span class="type"><a href="qssl.html#KeyType-enum">QSsl::KeyType</a></span> <i>type</i> = QSsl::PrivateKey, const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>passPhrase</i> = QByteArray() )</h3>
<p>Constructs a <a href="qsslkey.html">QSslKey</a> by reading and decoding data from a <i>device</i> using a specified <i>algorithm</i> and <i>encoding</i> format. If the encoded key is encrypted, <i>passPhrase</i> is used to decrypt it. <i>type</i> specifies whether the key is public or private.</p>
<p>After construction, use <a href="qsslkey.html#isNull">isNull</a>() to check if <i>device</i> provided a valid key.</p>
<!-- @@@QSslKey -->
<!-- $$$QSslKey$$$QSslKeyconstQSslKey& -->
<h3 class="fn"><a name="QSslKey-4"></a>QSslKey::<span class="name">QSslKey</span> ( const <span class="type">QSslKey</span> & <i>other</i> )</h3>
<p>Constructs an identical copy of <i>other</i>.</p>
<!-- @@@QSslKey -->
<!-- $$$~QSslKey[overload1]$$$~QSslKey -->
<h3 class="fn"><a name="dtor.QSslKey"></a>QSslKey::<span class="name">~QSslKey</span> ()</h3>
<p>Destroys the <a href="qsslkey.html">QSslKey</a> object.</p>
<!-- @@@~QSslKey -->
<!-- $$$algorithm[overload1]$$$algorithm -->
<h3 class="fn"><a name="algorithm"></a><span class="type"><a href="qssl.html#KeyAlgorithm-enum">QSsl::KeyAlgorithm</a></span> QSslKey::<span class="name">algorithm</span> () const</h3>
<p>Returns the key algorithm.</p>
<!-- @@@algorithm -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QSslKey::<span class="name">clear</span> ()</h3>
<p>Clears the contents of this key, making it a null key.</p>
<p><b>See also </b><a href="qsslkey.html#isNull">isNull</a>().</p>
<!-- @@@clear -->
<!-- $$$handle[overload1]$$$handle -->
<h3 class="fn"><a name="handle"></a><span class="type"><a href="qt.html#HANDLE-typedef">Qt::HANDLE</a></span> QSslKey::<span class="name">handle</span> () const</h3>
<p>Returns a pointer to the native key handle, if it is available; otherwise a null pointer is returned.</p>
<p>You can use this handle together with the native API to access extended information about the key.</p>
<p><b>Warning:</b> Use of this function has a high probability of being non-portable, and its return value may vary across platforms, and between minor Qt releases.</p>
<!-- @@@handle -->
<!-- $$$isNull[overload1]$$$isNull -->
<h3 class="fn"><a name="isNull"></a><span class="type">bool</span> QSslKey::<span class="name">isNull</span> () const</h3>
<p>Returns true if this is a null key; otherwise false.</p>
<p><b>See also </b><a href="qsslkey.html#clear">clear</a>().</p>
<!-- @@@isNull -->
<!-- $$$length[overload1]$$$length -->
<h3 class="fn"><a name="length"></a><span class="type">int</span> QSslKey::<span class="name">length</span> () const</h3>
<p>Returns the length of the key in bits, or -1 if the key is null.</p>
<!-- @@@length -->
<!-- $$$toDer[overload1]$$$toDerconstQByteArray& -->
<h3 class="fn"><a name="toDer"></a><span class="type"><a href="qbytearray.html">QByteArray</a></span> QSslKey::<span class="name">toDer</span> ( const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>passPhrase</i> = QByteArray() ) const</h3>
<p>Returns the key in DER encoding. The result is encrypted with <i>passPhrase</i> if the key is a private key and <i>passPhrase</i> is non-empty.</p>
<!-- @@@toDer -->
<!-- $$$toPem[overload1]$$$toPemconstQByteArray& -->
<h3 class="fn"><a name="toPem"></a><span class="type"><a href="qbytearray.html">QByteArray</a></span> QSslKey::<span class="name">toPem</span> ( const <span class="type"><a href="qbytearray.html">QByteArray</a></span> & <i>passPhrase</i> = QByteArray() ) const</h3>
<p>Returns the key in PEM encoding. The result is encrypted with <i>passPhrase</i> if the key is a private key and <i>passPhrase</i> is non-empty.</p>
<!-- @@@toPem -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qssl.html#KeyType-enum">QSsl::KeyType</a></span> QSslKey::<span class="name">type</span> () const</h3>
<p>Returns the type of the key (i.e., PublicKey or PrivateKey).</p>
<!-- @@@type -->
<!-- $$$operator!=[overload1]$$$operator!=constQSslKey& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QSslKey::<span class="name">operator!=</span> ( const <span class="type">QSslKey</span> & <i>other</i> ) const</h3>
<p>Returns true if this key is not equal to key <i>other</i>; otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQSslKey& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QSslKey</span> & QSslKey::<span class="name">operator=</span> ( const <span class="type">QSslKey</span> & <i>other</i> )</h3>
<p>Copies the contents of <i>other</i> into this key, making the two keys identical.</p>
<p>Returns a reference to this <a href="qsslkey.html">QSslKey</a>.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQSslKey& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QSslKey::<span class="name">operator==</span> ( const <span class="type">QSslKey</span> & <i>other</i> ) const</h3>
<p>Returns true if this key is equal to <i>other</i>; otherwise returns false.</p>
<!-- @@@operator== -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
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.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
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. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
