gcontini
2021-05-20 5251b3df104c0bb210c88bd935a7cc1fd41e4537
include/licensecc/licensecc.h
@@ -11,8 +11,6 @@
extern "C" {
#endif
#include <licensecc_properties.h>
#include "datatypes.h"
/**
@@ -24,7 +22,7 @@
/**
 * \brief Calculates the hardware identifier associated with a specific pc.
 * \details
 * The software, when it doesn't find a valid license should show to the user the calculated identifier.
 * The caller, when it doesn't find a valid license (see `acquire_license` below) should show to the user the calculated identifier.
 * The user should report the pc_identifier to the software editor that will in turn use it to issue a license.
 *
 * pc_id_method = ::STRATEGY_DEFAULT is usually the best choice.
@@ -38,19 +36,22 @@
 * @param hw_id_method[in] specifies a preferred identification method. Usually #STRATEGY_DEFAULT works well. See the
 * wiki for more informations.
 * @param identifier_out[out] buffer where the identification string will be placed.
 * @param identifier_out[in-out] size of the buffer where the identification string will be placed.
 * @param buf_size[in-out] size of the buffer where the identification string will be placed.
 * @param execution_environment_info[out] if not null will contain the informations about the execution environment.
 */
bool identify_pc(LCC_API_HW_IDENTIFICATION_STRATEGY hw_id_method, char* identifier_out, size_t* buf_size);
bool identify_pc(LCC_API_HW_IDENTIFICATION_STRATEGY hw_id_method, char* identifier_out, size_t* buf_size,
             ExecutionEnvironmentInfo* execution_environment_info);
/**
 * This method is used to request the use of one license for a product.
 * In case of local license it's used to check if the product is licensed.
 *
 * @return ::LICENSE_OK(0) if successful. Other values if there are errors.
 *
 * @param callerInformation[in]
 *          a vendor defined string containing the name of the product we want to request.
 * @param licenseLocation[in] otpional, can be NULL.
 * @return LCC_EVENT_TYPE::LICENSE_OK(0) if successful. Other values if there are errors.
 *
 * @param callerInformation[in] optional, can be NULL.
 *          contains informations on the software that is requesting the license verification. Let the software
 *          specify its version or request verification for features that need to be enabled separately.
 * @param licenseLocation[in] optional, can be NULL.
 *                licenseLocation, either the name of the file
 *                         or the name of the environment variable should be !='\0'
 * @param license_out[out] optional, can be NULL, if set it will return extra informations about the license.