libxcks  0.1.0.1
xcksver.hpp File Reference

Versions of (Z)XCKS files. More...

#include "libxcks/export.hpp"
#include "types.hpp"
Include dependency graph for xcksver.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

LIBXCKS_SO_EXPORT const StringSet libxcks::getAvailableAlgorithmNames (const Version version)
 Gets the available names of algorithm for a version of (Z)XCKS file. More...
 
LIBXCKS_SO_EXPORT const ArrayString libxcks::getAvailableAlgorithmNamesAsArray (const Version version)
 Gets the available names of algorithm for a version of (Z)XCKS file. More...
 
LIBXCKS_SO_EXPORT const ArrayChecksumAlgoId libxcks::getAvailableAlgorithmIds (const Version version)
 Gets the available ids of algorithm for a version of (Z)XCKS file. More...
 
LIBXCKS_SO_EXPORT const std::string libxcks::getXCKSVersionName (const Version version)
 Gets the name of an (Z)XCKS file version. More...
 

Detailed Description

Versions of (Z)XCKS files.

Definition in file xcksver.hpp.

Function Documentation

◆ getAvailableAlgorithmIds()

const ArrayChecksumAlgoId libxcks::getAvailableAlgorithmIds ( const Version  version)

Gets the available ids of algorithm for a version of (Z)XCKS file.

Parameters
[in]versionThe version of (Z)XCKS file.
Returns
The available ids of algorithm for (Z)XCKS file version version. If the given version is incorrect, an empty array is returned.

Definition at line 69 of file xcksver.cpp.

◆ getAvailableAlgorithmNames()

const StringSet libxcks::getAvailableAlgorithmNames ( const Version  version)

Gets the available names of algorithm for a version of (Z)XCKS file.

Note
The returned names of algorithm are conform to the Specifications of XCKS and ZXCKS files.
Parameters
[in]versionThe version of (Z)XCKS file.
Returns
The available names of algorithm for (Z)XCKS file version version. If the given version is incorrect, an empty set is returned.

Definition at line 41 of file xcksver.cpp.

◆ getAvailableAlgorithmNamesAsArray()

LIBXCKS_SO_EXPORT const ArrayString libxcks::getAvailableAlgorithmNamesAsArray ( const Version  version)

Gets the available names of algorithm for a version of (Z)XCKS file.

Note
The returned names of algorithm are conform to the Specifications of XCKS and ZXCKS files.
Parameters
[in]versionThe version of (Z)XCKS file.
Returns
The available names of algorithm for (Z)XCKS file version version. If the given version is incorrect, an empty array is returned.

Definition at line 57 of file xcksver.cpp.

◆ getXCKSVersionName()

const string libxcks::getXCKSVersionName ( const Version  version)

Gets the name of an (Z)XCKS file version.

Parameters
[in]versionThe version of (Z)XCKS file.
Returns
The name of an (Z)XCKS file version or an empty string if the version is unknown.

Definition at line 90 of file xcksver.cpp.