Functions providing information about the Archicad product and license. More...

Namespaces
namespace	API_SSALevels
	Constants of API_SSALevel.

Classes
class	ACAPI::LicenseInfo::LicenseInfoManager
	LicenseInfoManager is the entry point of the license or product-related informations. More...

class	ACAPI::LicenseInfo::ProductVersionInfo
	ProductVersionInfo is the central point of the product-related informations. More...

Typedefs
typedef GSErrCode	APILicenseBorrowStatusChangeHandlerProc(API_LicenseBorrowStatusTypeID licenseBorrowStatus)
	User supplied callback procedure for handling license borrowing status changes.

using	API_SSALevel = UInt32
	This is a numeric value representing an SSA subscription level. Use the named constants from the API_SSALevels namespace: NoSSA, SSA, Forward.

Enumerations
enum	API_LicenseBorrowStatusTypeID { API_LicenseBorrowed , API_LicenseReturned }
	Indicates the status of a borrowed license. More...

Functions
ProductVersionInfo	ACAPI::LicenseInfo::LicenseInfoManager::GetProductVersionInfo () const
	Returns an instance of ProductVersionInfo.

Result< LicenseInfoManager >	ACAPI::LicenseInfo::GetLicenseInfoManager ()
	Creates a LicenseInfoManager instance.

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetProductFamilyId () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetProductName () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetGSLanguageCode () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetGSProductType () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetAppVersionString () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetMainVersionString () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetUpdateVersionString () const

GS::UniString	ACAPI::LicenseInfo::ProductVersionInfo::GetHotfixVersionString () const

Int32	ACAPI::LicenseInfo::ProductVersionInfo::GetBuildNum () const

void	ACAPI_Licensing_InvokeForwardDialog ()
	Invoke generic SSA Forward dialog that warn that the user don't have SSA license.

GSErrCode	ACAPI_Licensing_CatchLicenseBorrowStatusChange (APILicenseBorrowStatusChangeHandlerProc *handlerProc)
	Catches notifications on license borrowing status changes.

UInt32	ACAPI_Licensing_GetProtectionMode ()
	Retrieves information about the protection mode.

UInt32	ACAPI_Licensing_GetSerialNumber ()
	Retrieves the unique serial number of the current license.

UInt16	ACAPI_Licensing_GetBoxMask ()
	Retrieves the box mask of the current license.

GS::UniString	ACAPI_Licensing_GetConfigurationNumber ()
	Retrieves the configuration number of the current license.

UInt32	ACAPI_Licensing_GetNumberOfLicenses ()
	Retrieves the number of current licenses.

GSTime	ACAPI_Licensing_GetExpirationTime ()
	Retrieves the expiration time of the current license (if any).

GS::UniString	ACAPI_Licensing_GetPartnerId ()
	When Archicad runs on an SSA license, this string contains the internal identifier of the reseller.

bool	ACAPI_Licensing_IsSSALevelAtLeast (API_SSALevel requiredLevel)
	Returns whether the SSA subscription passed in the parameter is available.

Detailed Description

Functions providing information about the Archicad product and license.

Typedef Documentation

◆ API_SSALevel

using API_SSALevel = UInt32

This is a numeric value representing an SSA subscription level. Use the named constants from the API_SSALevels namespace: NoSSA, SSA, Forward.

Since: Archicad 26

Remarks: The ACAPI_Licensing_IsSSALevelAtLeast function can be used to query the availability of a certain SSA subscription.

◆ APILicenseBorrowStatusChangeHandlerProc

typedef GSErrCode APILicenseBorrowStatusChangeHandlerProc(API_LicenseBorrowStatusTypeID licenseBorrowStatus)

User supplied callback procedure for handling license borrowing status changes.

Parameters

licenseBorrowStatus [out] The status of license borrowing, can be API_LicenseBorrowed or API_LicenseReturned.

Returns

NoError - The function has completed with success.

Remarks: This notification comes when the user borrows or returns a license, and allows you to act accordingly.

Enumeration Type Documentation

◆ API_LicenseBorrowStatusTypeID

enum API_LicenseBorrowStatusTypeID

Indicates the status of a borrowed license.

Enumerator
API_LicenseBorrowed	The license is currently borrowed.
API_LicenseReturned	The license has been returned.

Function Documentation

◆ ACAPI_Licensing_CatchLicenseBorrowStatusChange()

GSErrCode ACAPI_Licensing_CatchLicenseBorrowStatusChange ( APILicenseBorrowStatusChangeHandlerProc * handlerProc )

Catches notifications on license borrowing status changes.

Parameters

handlerProc [in] The callback function which receives the notifications.

Returns

NoError - The function has completed with success.

Remarks: This function allows you to act on license borrowing and returning.

◆ ACAPI_Licensing_GetBoxMask()

UInt16 ACAPI_Licensing_GetBoxMask ( )

Retrieves the box mask of the current license.

Since: Archicad 26

Returns

Remarks: The box mask is applicable only in the case of hardware and software licenses.

◆ ACAPI_Licensing_GetConfigurationNumber()

GS::UniString ACAPI_Licensing_GetConfigurationNumber ( )

Retrieves the configuration number of the current license.

Remarks: The configuration number is applicable only in the case of hardware and software licenses.

Since: Archicad 26

Returns: The current license's configuration number (also known as the container code).

◆ ACAPI_Licensing_GetExpirationTime()

GSTime ACAPI_Licensing_GetExpirationTime ( )

Retrieves the expiration time of the current license (if any).

Since: Archicad 26

Returns

GSTime - The expiration time of the current license.

◆ ACAPI_Licensing_GetNumberOfLicenses()

UInt32 ACAPI_Licensing_GetNumberOfLicenses ( )

Retrieves the number of current licenses.

Since: Archicad 26

Returns: The number of licenses.

◆ ACAPI_Licensing_GetPartnerId()

GS::UniString ACAPI_Licensing_GetPartnerId ( )

When Archicad runs on an SSA license, this string contains the internal identifier of the reseller.

Since: Archicad 26

Returns

◆ ACAPI_Licensing_GetProtectionMode()

UInt32 ACAPI_Licensing_GetProtectionMode ( )

Retrieves information about the protection mode.

Since: Archicad 26

Returns

Remarks

You can use the following predefined masks to retrieve information about the protection type.

APIPROT_SITE_MASK: More license (full version)
APIPROT_NFR_MASK: Not For Resale version (full version)
APIPROT_SCHOOL_MASK: School version (full version)
APIPROT_PPU_MASK:?PPU version (full version)
APIPROT_NET_MASK: Network licensing
APIPROT_TW_MASK: TeamWork functionality is on
APIPROT_PROTEDU_MASK: Education version
APIPROT_START_MASK : Start edition Usable masks in case of no hardware or software key:
APIPROT_EDU_MASK: Education version
APIPROT_DEMO_MASK: Demo version
APIPROT_TRIAL_MASK: Trial version
APIPROT_BTC_MASK : BIM Cloud Team Client version This information can be used to restrict the functionality of your Add-On for certain Archicad editions and license types (use the bitwise-AND operator to find out your license parameters).

Example: bool IsInDemoMode ()

{

return ACAPI_Licensing_GetProtectionMode () & APIPROT_DEMO_MASK;

}

◆ ACAPI_Licensing_GetSerialNumber()

UInt32 ACAPI_Licensing_GetSerialNumber ( )

Retrieves the unique serial number of the current license.

Since: Archicad 26

Returns

Remarks: The serial number of hardware and software licenses can be queried with this function.

◆ ACAPI_Licensing_InvokeForwardDialog()

void ACAPI_Licensing_InvokeForwardDialog ( )

Invoke generic SSA Forward dialog that warn that the user don't have SSA license.

Since: Archicad 26

◆ ACAPI_Licensing_IsSSALevelAtLeast()

bool ACAPI_Licensing_IsSSALevelAtLeast ( API_SSALevel requiredLevel )

Returns whether the SSA subscription passed in the parameter is available.

Since: Archicad 26

Parameters

requiredLevel [in] The level to check the current level against.

Returns

Example: bool ShouldEnableFeatureInAddOn ()

{

return ACAPI_Licensing_IsSSALevelAtLeast (API_SSALevels::Forward);

}

◆ GetAppVersionString()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetAppVersionString ( ) const

Returns: Returns the version of the product as a string.

◆ GetBuildNum()

Int32 ACAPI::LicenseInfo::ProductVersionInfo::GetBuildNum ( ) const

Returns: Returns the build number of the product.

◆ GetGSLanguageCode()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetGSLanguageCode ( ) const

Returns

Returns the language of the application in a Graphisoft-specific format.

Graphisoft-specific format	Language
ARA	Arabic
AUS	Australian English
AUT	Austrian
BUL	Bulgarian
CHE	Swiss German
CHI	Simplified Chinese
CRO	Croatian
CZE	Czech
DEN	Danish
EST	Estonian
FIN	Finnish
FRA	French
GER	German
GRE	Greek
HUN	Hungarian
ICE	Icelandian
ITA	Italian
INT	International English
ISR	Israeli
JPN	Japanese
KOR	Korean
NED	Dutch
NZE	New Zealand English
NOR	Norwegian
POL	Polish
POR	Portuguese
ENG	British English
ROM	Romanian
RUS	Russian
SLO	Slovak
SPA	Spanish
SWE	Swedish
TAI	Traditional Chinese
TUR	Turkish
USA	USA English
IND	Indic
BRA	Brasil
UKI	United Kingdom & Ireland
IRN	Iran
UKR	Ukraine

◆ GetGSProductType()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetGSProductType ( ) const

Returns: Returns the type of the product as a string.

◆ GetHotfixVersionString()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetHotfixVersionString ( ) const

Returns: Returns the hotfix version as a string.

◆ GetLicenseInfoManager()

Result< LicenseInfoManager > ACAPI::LicenseInfo::GetLicenseInfoManager ( )

inline

Creates a LicenseInfoManager instance.

Returns: The new LicenseInfoManager instance.

Remarks: This is the entry point of the license information on the API.

◆ GetMainVersionString()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetMainVersionString ( ) const

Returns: Returns the main version as a string.

◆ GetProductFamilyId()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetProductFamilyId ( ) const

Returns: Returns the family of the product.

◆ GetProductName()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetProductName ( ) const

Returns: Returns the name of the product.

◆ GetProductVersionInfo()

ProductVersionInfo ACAPI::LicenseInfo::LicenseInfoManager::GetProductVersionInfo ( ) const

Returns an instance of ProductVersionInfo.

Returns: Returns the product version info or error.

◆ GetUpdateVersionString()

GS::UniString ACAPI::LicenseInfo::ProductVersionInfo::GetUpdateVersionString ( ) const

Returns: Returns the update version as a string.

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ API_SSALevel

◆ APILicenseBorrowStatusChangeHandlerProc

Enumeration Type Documentation

◆ API_LicenseBorrowStatusTypeID

Function Documentation

◆ ACAPI_Licensing_CatchLicenseBorrowStatusChange()

◆ ACAPI_Licensing_GetBoxMask()

◆ ACAPI_Licensing_GetConfigurationNumber()

◆ ACAPI_Licensing_GetExpirationTime()

◆ ACAPI_Licensing_GetNumberOfLicenses()

◆ ACAPI_Licensing_GetPartnerId()

◆ ACAPI_Licensing_GetProtectionMode()

◆ ACAPI_Licensing_GetSerialNumber()

◆ ACAPI_Licensing_InvokeForwardDialog()

◆ ACAPI_Licensing_IsSSALevelAtLeast()

◆ GetAppVersionString()

◆ GetBuildNum()

◆ GetGSLanguageCode()

◆ GetGSProductType()

◆ GetHotfixVersionString()

◆ GetLicenseInfoManager()

◆ GetMainVersionString()

◆ GetProductFamilyId()

◆ GetProductName()

◆ GetProductVersionInfo()

◆ GetUpdateVersionString()