From dda16735b94661b798d6c0fd3e41af944de0a1fe Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周日, 13 10月 2019 15:02:19 +0800 Subject: [PATCH] refactoring - locators --- src/library/api/license++.h | 25 ++++++++++++++++--------- 1 files changed, 16 insertions(+), 9 deletions(-) diff --git a/src/library/api/license++.h b/src/library/api/license++.h index faece34..185a3f3 100644 --- a/src/library/api/license++.h +++ b/src/library/api/license++.h @@ -35,14 +35,21 @@ */ void identify_pc(IDENTIFICATION_STRATEGY pc_id_method, char chbuffer[PC_IDENTIFIER_SIZE + 1]); -/* - * The optional parameter License contains the information the program that uses the library - * should display: + + +/** + * 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. + * [In case of network licenses this will decrease the count of the available + * licenses] * - * @return true if successful. False if there are errors. - * @param licenseLocation[in] licenseLocation, either the name of the file + * @return LICENSE_OK(0) if successful. Other values if there are errors. + * @param productName[in] + * a vendor defined string containing the name of the product we want to request. + * @param licenseLocation[in] otpional, can be NULL. + * licenseLocation, either the name of the file * or the name of the environment variable should be !='\0' - * @param license[out] optional, can be NULL. + * @param license[out] optional, can be NULL, if set it will return extra informations about the license. */ EVENT_TYPE acquire_license(const char * productName, @@ -51,14 +58,14 @@ /** * Do nothing for now, useful for network licenses. * Should be called from time to time to confirm we're still using the - * slicense. + * license. */ -EVENT_TYPE confirm_license(char * productName, +EVENT_TYPE confirm_license(char * featureName, LicenseLocation licenseLocation); /** * Do nothing for now, useful for network licenses. */ -EVENT_TYPE release_license(char * productName, +EVENT_TYPE release_license(char * featureName, LicenseLocation licenseLocation); #ifdef __cplusplus -- Gitblit v1.9.1