QCA
Typedefs | |
| typedef QMultiMap< CertificateInfoType, QString > | CertificateInfo |
| typedef QList< ConstraintType > | Constraints |
| typedef QList< Provider * > | ProviderList |
| typedef QList< SecureMessageKey > | SecureMessageKeyList |
| typedef QList< SecureMessageSignature > | SecureMessageSignatureList |
Functions | |
| QCA_EXPORT void | appendPluginDiagnosticText (const QString &text) |
| QCA_EXPORT QString | appName () |
| QCA_EXPORT QString | arrayToBase64 (const QByteArray &array) |
| QCA_EXPORT QString | arrayToHex (const QByteArray &array) |
| QCA_EXPORT QByteArray | base64ToArray (const QString &base64String) |
| QCA_EXPORT void | clearPluginDiagnosticText () |
| QCA_EXPORT QStringList | defaultFeatures () |
| QCA_EXPORT Provider * | defaultProvider () |
| QCA_EXPORT void | deinit () |
| QCA_EXPORT QByteArray | emsa3Encode (const QString &hashName, const QByteArray &digest, int size=-1) |
| QCA_EXPORT Provider * | findProvider (const QString &name) |
| QCA_EXPORT QVariant | getProperty (const QString &name) |
| QCA_EXPORT QVariantMap | getProviderConfig (const QString &name) |
| QCA_EXPORT QString | globalRandomProvider () |
| QCA_EXPORT bool | haveSecureMemory () |
| QCA_EXPORT bool | haveSecureRandom () |
| QCA_EXPORT bool | haveSystemStore () |
| QCA_EXPORT QByteArray | hexToArray (const QString &hexString) |
| QCA_EXPORT void | init () |
| QCA_EXPORT void | init (MemoryMode m, int prealloc) |
| QCA_EXPORT bool | insertProvider (Provider *p, int priority=0) |
| QCA_EXPORT bool | invokeMethodWithVariants (QObject *obj, const QByteArray &method, const QVariantList &args, QVariant *ret, Qt::ConnectionType type=Qt::AutoConnection) |
| QCA_EXPORT bool | isSupported (const char *features, const QString &provider=QString()) |
| QCA_EXPORT bool | isSupported (const QStringList &features, const QString &provider=QString()) |
| QCA_EXPORT Logger * | logger () |
| QCA_EXPORT QStringList | makeFriendlyNames (const QList< Certificate > &list) |
| QCA_EXPORT int | methodReturnType (const QMetaObject *obj, const QByteArray &method, const QList< QByteArray > &argTypes) |
| QCA_EXPORT const SecureArray | operator+ (const SecureArray &a, const SecureArray &b) |
| QCA_EXPORT QTextStream & | operator<< (QTextStream &stream, const BigInteger &b) |
| QCA_EXPORT CertificateInfoOrdered | orderedDNOnly (const CertificateInfoOrdered &in) |
| QCA_EXPORT QString | orderedToDNString (const CertificateInfoOrdered &in) |
| QCA_EXPORT QString | pluginDiagnosticText () |
| QCA_EXPORT QStringList | pluginPaths () |
| QCA_EXPORT int | providerPriority (const QString &name) |
| QCA_EXPORT ProviderList | providers () |
| QCA_EXPORT void | saveProviderConfig (const QString &name) |
| QCA_EXPORT void | scanForPlugins () |
| QCA_EXPORT void | setAppName (const QString &name) |
| QCA_EXPORT void | setGlobalRandomProvider (const QString &provider) |
| QCA_EXPORT void | setProperty (const QString &name, const QVariant &value) |
| QCA_EXPORT void | setProviderConfig (const QString &name, const QVariantMap &config) |
| QCA_EXPORT void | setProviderPriority (const QString &name, int priority) |
| QCA_EXPORT QStringList | supportedFeatures () |
| QCA_EXPORT CertificateCollection | systemStore () |
| QCA_EXPORT void | unloadAllPlugins () |
| QCA_EXPORT bool | unloadProvider (const QString &name) |
Detailed Description
Typedef Documentation
◆ CertificateInfo
Certificate properties type.
With this container, the information is not necessarily stored in the same sequence as the certificate format itself. Use this container if the order the information is/was stored does not matter for you (this is the case with most applications).
Additionally, the EmailLegacy type should not be used with this container. Use Email instead.
Definition at line 535 of file qca_cert.h.
◆ Constraints
| typedef QList<ConstraintType> QCA::Constraints |
Certificate constraints type
Definition at line 590 of file qca_cert.h.
◆ ProviderList
| typedef QList<Provider *> QCA::ProviderList |
Convenience representation for the plugin providers.
You can get a list of providers using the providers() function
- See also
- ProviderListIterator
- providers()
Definition at line 111 of file qca_core.h.
◆ SecureMessageKeyList
A list of message keys.
Definition at line 175 of file qca_securemessage.h.
◆ SecureMessageSignatureList
A list of signatures.
Definition at line 263 of file qca_securemessage.h.
Enumeration Type Documentation
◆ CertificateInfoTypeKnown
Known types of information stored in certificates.
This enumerator offers a convenient way to work with common types.
| Enumerator | |
|---|---|
| CommonName | The common name (eg person), id = "2.5.4.3". |
Email address, id = "GeneralName.rfc822Name". | |
| EmailLegacy | PKCS#9 Email field, id = "1.2.840.113549.1.9.1". |
| Organization | An organisation (eg company), id = "2.5.4.10". |
| OrganizationalUnit | An part of an organisation (eg a division or branch), id = "2.5.4.11". |
| Locality | The locality (eg city, a shire, or part of a state), id = "2.5.4.7". |
| IncorporationLocality | The locality of incorporation (EV certificates), id = "1.3.6.1.4.1.311.60.2.1.1". |
| State | The state within the country, id = "2.5.4.8". |
| IncorporationState | The state of incorporation (EV certificates), id = "1.3.6.1.4.1.311.60.2.1.2". |
| Country | The country, id = "2.5.4.6". |
| IncorporationCountry | The country of incorporation (EV certificates), id = "1.3.6.1.4.1.311.60.2.1.3". |
| URI | Uniform Resource Identifier, id = "GeneralName.uniformResourceIdentifier". |
| DNS | DNS name, id = "GeneralName.dNSName". |
| IPAddress | IP address, id = "GeneralName.iPAddress". |
| XMPP | XMPP address (see http://www.ietf.org/rfc/rfc3920.txt), id = "1.3.6.1.5.5.7.8.5". |
Definition at line 64 of file qca_cert.h.
◆ CertificateRequestFormat
Certificate Request Format.
| Enumerator | |
|---|---|
| PKCS10 | standard PKCS#10 format |
| SPKAC | Signed Public Key and Challenge (Netscape) format. |
Definition at line 53 of file qca_cert.h.
◆ ConstraintTypeKnown
Known types of certificate constraints.
This enumerator offers a convenient way to work with common types.
Definition at line 316 of file qca_cert.h.
◆ ConvertResult
| enum QCA::ConvertResult |
Return value from a format conversion.
Note that if you are checking for any result other than ConvertGood, then you may be introducing a provider specific dependency.
Definition at line 118 of file qca_publickey.h.
◆ Direction
| enum QCA::Direction |
Direction settings for symmetric algorithms.
For some algorithms, it makes sense to have a "direction", such as Cipher algorithms which can be used to encrypt or decrypt.
| Enumerator | |
|---|---|
| Encode | Operate in the "forward" direction; for example, encrypting. |
| Decode | Operate in the "reverse" direction; for example, decrypting. |
Definition at line 140 of file qca_core.h.
◆ DLGroupSet
| enum QCA::DLGroupSet |
Well known discrete logarithm group sets.
These sets are derived from three main sources: Java Cryptographic Extensions, RFC2412 and RFC3526.
Definition at line 134 of file qca_publickey.h.
◆ EncryptionAlgorithm
Encryption algorithms.
Definition at line 54 of file qca_publickey.h.
◆ MemoryMode
| enum QCA::MemoryMode |
Mode settings for memory allocation.
QCA can use secure memory, however most operating systems restrict the amount of memory that can be pinned by user applications, to prevent a denial-of-service attack.
QCA supports two approaches to getting memory - the mlock method, which generally requires root (administrator) level privileges, and the mmap method which is not as secure, but which should be able to be used by any process.
- See also
- Initializer
| Enumerator | |
|---|---|
| Practical | mlock and drop root if available, else mmap |
| Locking | mlock and drop root |
| LockingKeepPrivileges | mlock, retaining root privileges |
Definition at line 127 of file qca_core.h.
◆ PBEAlgorithm
| enum QCA::PBEAlgorithm |
Password-based encryption.
Definition at line 102 of file qca_publickey.h.
◆ SecurityLevel
| enum QCA::SecurityLevel |
Specify the lower-bound for acceptable TLS/SASL security layers.
For TLS, the interpretation of these levels is:
- Any cipher suite that provides non-authenticated communications (usually anonymous Diffie-Hellman) is SL_Integrity.
- Any cipher suite that is limited to 40 bits (export-version crippled forms of RC2, RC4 or DES) is SL_Export. Standard DES (56 bits) and some forms of RC4 (64 bits) are also SL_Export.
- Any normal cipher (AES, Camellia, RC4 or similar) with 128 bits, or Elliptic Curve Ciphers with 283 bits, is SL_Baseline
- AES or Camellia at least 192 bits, triple-DES and similar ciphers are SL_High. ECC with 409 or more bits is also SL_High.
- Highest does not have an equivalent strength. It indicates that the provider should use the strongest ciphers available (but not less than SL_High).
Definition at line 59 of file qca_securelayer.h.
◆ SignatureAlgorithm
Signature algorithm variants.
Note that most signature algorithms follow a process of first hashing the plaintext data to be signed, creating a payload format that wraps the hash value (among other things), and then signing the payload with the private key. So, for example, an EMSA3(SHA1) signature outputted by QCA cannot be verified by merely performing RSA and SHA1 operations (e.g. "openssl rsautl -verify" and comparing with sha1sum), because that would not take the EMSA3 payload format into consideration.
Definition at line 73 of file qca_publickey.h.
◆ SignatureFormat
| enum QCA::SignatureFormat |
Signature formats (DSA only)
| Enumerator | |
|---|---|
| DefaultFormat | For DSA, this is the same as IEEE_1363. |
| IEEE_1363 | 40-byte format from IEEE 1363 (Botan/.NET) |
| DERSequence | Signature wrapped in DER formatting (OpenSSL/Java) |
Definition at line 92 of file qca_publickey.h.
◆ UsageMode
| enum QCA::UsageMode |
Specify the intended usage of a certificate.
| Enumerator | |
|---|---|
| UsageAny | Any application, or unspecified. |
| UsageTLSServer | server side of a TLS or SSL connection |
| UsageTLSClient | client side of a TLS or SSL connection |
| UsageCodeSigning | code signing certificate |
| UsageEmailProtection | email (S/MIME) certificate |
| UsageTimeStamping | time stamping certificate |
| UsageCRLSigning | certificate revocation list signing certificate |
Definition at line 482 of file qca_cert.h.
◆ ValidateFlags
| enum QCA::ValidateFlags |
The conditions to validate for a certificate.
Definition at line 516 of file qca_cert.h.
◆ Validity
| enum QCA::Validity |
The validity (or otherwise) of a certificate.
| Enumerator | |
|---|---|
| ValidityGood | The certificate is valid. |
| ErrorRejected | The root CA rejected the certificate purpose. |
| ErrorUntrusted | The certificate is not trusted. |
| ErrorSignatureFailed | The signature does not match. |
| ErrorInvalidCA | The Certificate Authority is invalid. |
| ErrorInvalidPurpose | The purpose does not match the intended usage. |
| ErrorSelfSigned | The certificate is self-signed, and is not found in the list of trusted certificates. |
| ErrorRevoked | The certificate has been revoked. |
| ErrorPathLengthExceeded | The path length from the root CA to this certificate is too long. |
| ErrorExpired | The certificate has expired, or is not yet valid (e.g. current time is earlier than notBefore time) |
| ErrorExpiredCA | The Certificate Authority has expired. |
| ErrorValidityUnknown | Validity is unknown. |
Definition at line 496 of file qca_cert.h.
Function Documentation
◆ appendPluginDiagnosticText()
| QCA_EXPORT void QCA::appendPluginDiagnosticText | ( | const QString & | text | ) |
Add plugin diagnostic text.
This function should only be called by providers.
- Parameters
-
text the diagnostic message to append
◆ appName()
| QCA_EXPORT QString QCA::appName | ( | ) |
◆ arrayToBase64()
| QCA_EXPORT QString QCA::arrayToBase64 | ( | const QByteArray & | array | ) |
Convert a byte array to printable base64 representation.
This is a convenience function to convert an arbitrary QByteArray to a printable representation.
- Parameters
-
array the array to be converted
- Returns
- a printable representation
◆ arrayToHex()
| QCA_EXPORT QString QCA::arrayToHex | ( | const QByteArray & | array | ) |
Convert a byte array to printable hexadecimal representation.
This is a convenience function to convert an arbitrary QByteArray to a printable representation.
- Parameters
-
array the array to be converted
- Returns
- a printable representation
- Examples
- aes-cmac.cpp, ciphertest.cpp, hashtest.cpp, mactest.cpp, and rsatest.cpp.
◆ base64ToArray()
| QCA_EXPORT QByteArray QCA::base64ToArray | ( | const QString & | base64String | ) |
Convert a QString containing a base64 representation of a byte array into a QByteArray.
This is a convenience function to convert a printable representation into a QByteArray - effectively the inverse of QCA::arrayToBase64.
- Parameters
-
base64String the string containing a printable representation to be converted
- Returns
- the equivalent QByteArray
◆ clearPluginDiagnosticText()
| QCA_EXPORT void QCA::clearPluginDiagnosticText | ( | ) |
Clear plugin diagnostic text.
◆ defaultFeatures()
| QCA_EXPORT QStringList QCA::defaultFeatures | ( | ) |
Generate a list of the built in features.
This differs from supportedFeatures() in that it does not include features provided by plugins.
- Returns
- a list containing the names of the features
The following code writes a list of features to standard out
- See also
- isSupported
- supportedFeatures()
- Examples
- providertest.cpp.
◆ defaultProvider()
| QCA_EXPORT Provider * QCA::defaultProvider | ( | ) |
Return the default provider.
◆ deinit()
| QCA_EXPORT void QCA::deinit | ( | ) |
Clean up routine.
This routine cleans up QCA, including memory allocations This call is not normally required, because it is cleaner to use an Initializer
◆ emsa3Encode()
| QCA_EXPORT QByteArray QCA::emsa3Encode | ( | const QString & | hashName, |
| const QByteArray & | digest, | ||
| int | size = -1 ) |
Encode a hash result in EMSA3 (PKCS#1) format.
This is a convenience function for providers that only have access to raw RSA signing (mainly smartcard providers). This is a built-in function of QCA and does not utilize a provider. SHA1, MD5, MD2, and RIPEMD160 are supported.
- Parameters
-
hashName the hash type used to create the digest digest the digest to encode in EMSA3 format size the desired size of the encoding output (-1 for automatic size)
◆ findProvider()
Return the named provider, or 0 if not found.
- Parameters
-
name the name of the provider to search for.
◆ getProperty()
◆ getProviderConfig()
| QCA_EXPORT QVariantMap QCA::getProviderConfig | ( | const QString & | name | ) |
Retrieve provider configuration.
- Parameters
-
name the name of the provider to retrieve the configuration of
◆ globalRandomProvider()
| QCA_EXPORT QString QCA::globalRandomProvider | ( | ) |
Return the name of the global random number provider.
◆ haveSecureMemory()
| QCA_EXPORT bool QCA::haveSecureMemory | ( | ) |
Test if secure storage memory is available.
- Returns
- true if secure storage memory is available
◆ haveSecureRandom()
| QCA_EXPORT bool QCA::haveSecureRandom | ( | ) |
Test if secure random is available.
Secure random is considered available if the global random provider is not the default provider.
- Returns
- true if secure random is available
◆ haveSystemStore()
| QCA_EXPORT bool QCA::haveSystemStore | ( | ) |
Test if QCA can access the root CA certificates.
If root certificates are available, this function returns true, otherwise it returns false.
- See also
- systemStore
- Examples
- certtest.cpp, and ssltest.cpp.
◆ hexToArray()
| QCA_EXPORT QByteArray QCA::hexToArray | ( | const QString & | hexString | ) |
Convert a QString containing a hexadecimal representation of a byte array into a QByteArray.
This is a convenience function to convert a printable representation into a QByteArray - effectively the inverse of QCA::arrayToHex.
- Parameters
-
hexString the string containing a printable representation to be converted
- Returns
- the equivalent QByteArray
- Examples
- aes-cmac.cpp.
◆ init() [1/2]
| QCA_EXPORT void QCA::init | ( | ) |
Initialise QCA.
This call is not normally required, because it is cleaner to use an Initializer.
◆ init() [2/2]
| QCA_EXPORT void QCA::init | ( | MemoryMode | m, |
| int | prealloc ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Parameters
-
m the MemoryMode to use prealloc the amount of memory in kilobytes to allocate for secure storage
◆ insertProvider()
| QCA_EXPORT bool QCA::insertProvider | ( | Provider * | p, |
| int | priority = 0 ) |
Add a provider to the current list of providers.
This function allows you to add a provider to the current plugin providers at a specified priority. If a provider with the name already exists, this call fails.
QCA takes ownership of the provider.
- Parameters
-
p a pointer to a Provider object, which must be set up. priority the priority level to set the provider to
- Returns
- true if the provider is added, and false if the provider is not added (failure)
- See also
- unloadProvider for unloading specified providers
- setProviderPriority for a description of the provider priority system
- Examples
- aes-cmac.cpp.
◆ isSupported() [1/2]
Test if a capability (algorithm) is available.
Since capabilities are made available at runtime, you should always check before using a capability the first time, as shown below.
- Parameters
-
features the name of the capability to test for provider if specified, only check for the capability in that specific provider. If not provided, or provided as an empty string, then check for capabilities in all available providers
- Returns
- true if the capability is available, otherwise false
Note that you can test for a combination of capabilities, using a comma delimited list:
which will return true if all of the capabilities listed are present.
◆ isSupported() [2/2]
| QCA_EXPORT bool QCA::isSupported | ( | const QStringList & | features, |
| const QString & | provider = QString() ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
- Parameters
-
features a list of features to test for provider if specified, only check for the capability in that specific provider. If not provided, or provided as an empty string, then check for capabilities in all available providers
◆ logger()
| QCA_EXPORT Logger * QCA::logger | ( | ) |
◆ makeFriendlyNames()
| QCA_EXPORT QStringList QCA::makeFriendlyNames | ( | const QList< Certificate > & | list | ) |
Create a list of unique friendly names among a list of certificates.
- Parameters
-
list the list of certificates for which a friendly name is required.
◆ operator+()
| QCA_EXPORT const SecureArray QCA::operator+ | ( | const SecureArray & | a, |
| const SecureArray & | b ) |
Returns an array that is the result of concatenating a and b.
- Parameters
-
a the string to put at the start of the result b the string to put at the end of the result
◆ orderedDNOnly()
| QCA_EXPORT CertificateInfoOrdered QCA::orderedDNOnly | ( | const CertificateInfoOrdered & | in | ) |
Return a new CertificateInfoOrdered that only contains the Distinguished Name (DN) types found in the input object.
- Parameters
-
in the certificate info to extract from
◆ orderedToDNString()
| QCA_EXPORT QString QCA::orderedToDNString | ( | const CertificateInfoOrdered & | in | ) |
Convert to RFC 1779 string format.
- Parameters
-
in the certificate info to convert
◆ pluginDiagnosticText()
| QCA_EXPORT QString QCA::pluginDiagnosticText | ( | ) |
Retrieve plugin diagnostic text.
◆ pluginPaths()
| QCA_EXPORT QStringList QCA::pluginPaths | ( | ) |
Retrieve plugin paths.
It consists of:
- QCA_PLUGIN_PATH environment if set.
QCoreApplication::libraryPaths() .- Directory where plugins were installed.
QCA_PLUGIN_PATH is paths list like PATH or QT_PLUGIN_PATH. It uses system path separator. ";" on Windows and ":" on Unix.
This function was introduced in QCA 2.1.
◆ providerPriority()
| QCA_EXPORT int QCA::providerPriority | ( | const QString & | name | ) |
Return the priority of a specified provider.
The name of the provider (eg "qca-ossl") is used to look up the current priority associated with that provider. If the provider is not found (or something else went wrong), -1 is returned.
- Parameters
-
name the name of the provider
- Returns
- the current priority level
- See also
- setProviderPriority for a description of the provider priority system
◆ providers()
| QCA_EXPORT ProviderList QCA::providers | ( | ) |
Return a list of the current providers.
The current plugin providers are provided as a list, which you can iterate over using ProviderListIterator.
- See also
- ProviderList
- ProviderListIterator
- Examples
- providertest.cpp.
◆ saveProviderConfig()
| QCA_EXPORT void QCA::saveProviderConfig | ( | const QString & | name | ) |
Save provider configuration to persistent storage.
- Parameters
-
name the name of the provider to have its configuration saved
◆ scanForPlugins()
| QCA_EXPORT void QCA::scanForPlugins | ( | ) |
Scan for new plugins.
- Examples
- providertest.cpp.
◆ setAppName()
| QCA_EXPORT void QCA::setAppName | ( | const QString & | name | ) |
Set the application name that will be used by SASL server mode.
The application name is used by SASL in server mode, as some systems might have different security policies depending on the app. This should be set before using SASL objects, and it cannot be changed later.
- Parameters
-
name the name string to use for SASL server mode
- Examples
- saslserver.cpp.
◆ setGlobalRandomProvider()
| QCA_EXPORT void QCA::setGlobalRandomProvider | ( | const QString & | provider | ) |
Change the global random number provider.
The Random capabilities of QCA are provided as part of the built in capabilities, however the generator can be changed if required.
- Parameters
-
provider the name of the provider to use as the global random provider.
◆ setProperty()
Set a global property.
- Parameters
-
name the name of the property value the value to set the property to
- See also
- getProperty
◆ setProviderConfig()
| QCA_EXPORT void QCA::setProviderConfig | ( | const QString & | name, |
| const QVariantMap & | config ) |
Set provider configuration.
Allowed value types: QString, int, bool
- Parameters
-
name the name of the provider to set the configuration to config the configuration
◆ setProviderPriority()
| QCA_EXPORT void QCA::setProviderPriority | ( | const QString & | name, |
| int | priority ) |
Change the priority of a specified provider.
QCA supports a number of providers, and if a number of providers support the same algorithm, it needs to choose between them. You can do this at object instantiation time (by specifying the name of the provider that should be used). Alternatively, you can provide a relative priority level at an application level, using this call.
Priority is used at object instantiation time. The provider is selected according to the following logic:
- if a particular provider is nominated, and that provider supports the required algorithm, then the nominated provider is used
- if no provider is nominated, or it doesn't support the required algorithm, then the provider with the lowest priority number will be used, if that provider supports the algorithm.
- if the provider with the lowest priority number doesn't support the required algorithm, the provider with the next lowest priority number will be tried, and so on through to the provider with the largest priority number
- if none of the plugin providers support the required algorithm, then the default (built-in) provider will be tried.
- Parameters
-
name the name of the provider priority the new priority of the provider. As a special case, if you pass in -1, then this provider gets the same priority as the the last provider that was added or had its priority set using this call.
- See also
- providerPriority
◆ supportedFeatures()
| QCA_EXPORT QStringList QCA::supportedFeatures | ( | ) |
Generate a list of all the supported features in plugins, and in built in capabilities.
- Returns
- a list containing the names of the features
The following code writes a list of features to standard out
- See also
- isSupported(const char *features)
- isSupported(const QStringList &features)
- defaultFeatures()
◆ systemStore()
| QCA_EXPORT CertificateCollection QCA::systemStore | ( | ) |
Get system-wide root Certificate Authority (CA) certificates.
Many operating systems (or distributions, on Linux-type systems) come with some trusted certificates. Typically, these include the root certificates for major Certificate Authorities (for example, Verisign, Comodo) and some additional certificates that are used for system updates. They are provided in different ways for different systems.
This function provides an common way to access the system certificates. There are other ways to access certificates - see the various I/O methods (such as fromDER() and fromPEM()) in the Certificate and CertificateCollection classes.
- Note
- Availability of the system certificates depends on how QCA was built. You can test whether the system certificates are available using the haveSystemStore() function.
- Examples
- certtest.cpp, ssltest.cpp, and tlssocket.cpp.
◆ unloadAllPlugins()
| QCA_EXPORT void QCA::unloadAllPlugins | ( | ) |
Unload the current plugins.
◆ unloadProvider()
| QCA_EXPORT bool QCA::unloadProvider | ( | const QString & | name | ) |
Unload specified provider.
The specified provider is removed from the list of providers and deleted. If no provider with the name is found, this call fails.
- Parameters
-
name the name of the provider
- Returns
- true if the provider is unloaded, and false if the provider cannot be found
- See also
- insertProvider for adding providers
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:03:55 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.