From 289886021add9711c052ccf66859b6370a9193a5 Mon Sep 17 00:00:00 2001
From: Gabriele Contini <contini.mailing@gmail.com>
Date: 周六, 01 2月 2020 18:00:58 +0800
Subject: [PATCH] Merge remote-tracking branch 'origin/develop' into feature/pc_identifiers
---
include/licensecc/licensecc.h | 27 +++++++++++++++++----------
1 files changed, 17 insertions(+), 10 deletions(-)
diff --git a/include/licensecc/licensecc.h b/include/licensecc/licensecc.h
index 749cf7b..dd0d9c6 100644
--- a/include/licensecc/licensecc.h
+++ b/include/licensecc/licensecc.h
@@ -1,3 +1,6 @@
+/** \addtogroup api
+ * @{
+ */
#ifndef LICENSEPP_H_
#define LICENSEPP_H_
@@ -8,19 +11,22 @@
extern "C" {
#endif
+#include <licensecc_properties.h>
+
#include "datatypes.h"
-/*
+/**
* Method used to convert the LicenseInfo into a human readable
* representation.
*/
-void print_error(char out_buffer[256], LicenseInfo* licenseInfo);
+void print_error(char out_buffer[LCC_API_ERROR_BUFFER_SIZE], LicenseInfo* licenseInfo);
/**
- * This method calculate the pc identifier. The string has to be shown
- * to the user in order to calculate the license.
+ * This method calculates the pc identifier. The string need to be shown to the user and given back to the software
+ * editor when issuing a license.
+ * pc_id_method = STRATEGY_DEFAULT usually works.
*/
-bool identify_pc(IDENTIFICATION_STRATEGY pc_id_method, char* identifier_out, size_t* bufSize);
+bool identify_pc(LCC_API_IDENTIFICATION_STRATEGY pc_id_method, char* identifier_out, size_t* bufSize);
/**
* This method is used to request the use of one license for a product.
@@ -35,7 +41,7 @@
* @param license[out] optional, can be NULL, if set it will return extra informations about the license.
*/
-EVENT_TYPE acquire_license(const CallerInformations* callerInformation, const LicenseLocation* licenseLocation,
+LCC_EVENT_TYPE acquire_license(const CallerInformations* callerInformation, const LicenseLocation* licenseLocation,
LicenseInfo* license_out);
/**
@@ -43,16 +49,17 @@
* Should be called from time to time to confirm we're still using the
* license.
*/
-EVENT_TYPE confirm_license(char * featureName,
- LicenseLocation* licenseLocation);
+LCC_EVENT_TYPE confirm_license(char* featureName, LicenseLocation* licenseLocation);
/**
* Do nothing for now, useful for network licenses.
*/
-EVENT_TYPE release_license(char * featureName,
- LicenseLocation licenseLocation);
+LCC_EVENT_TYPE release_license(char* featureName, LicenseLocation licenseLocation);
#ifdef __cplusplus
}
#endif
#endif
+/**
+ * @}
+ */
--
Gitblit v1.9.1