Textual description of the add-on. More...

#include <APIdefs_Registration.h>

Public Attributes
GS::UniString	name
	The name of the add-on, in Unicode.

GS::UniString	description
	The description of the functionality of the add-on, in Unicode.

GS::UniString	version
	The version of the add-on in string format.

API_SSALevel	requiredSSALevel
	If the add-on requires an SSA subscription in order to function, set this member to the required minimum subscription level (see API_SSALevels).

Detailed Description

Textual description of the add-on.

Remarks: This is a member of the API_EnvirParams structure used in the CheckEnvironment function. The description appears in the Add-On Manager dialog of Archicad. Both strings should come from a localizable resource. When set, the requiredSSALevel field instructs Archicad to handle this add-on as dependent on Software Service Agreements. Note, however, that any restrictions in functionality (e.g., disabling commands) should be implemented separately in the add-on. From API 21 the name and description fields are in Unicode; you shouldn't call BNZeroMemory or memset. From API 30 you can also specify a version string. This is optional; the add-on version info appears in Add-On Manager only if the version string is not empty.

Public Attributes