Describes the current server application the add-on is running under.

    typedef struct {
        API_ApplicationTypeID     serverApplication;
        UInt16                    mainVersion;
        Int16                     releaseVersion;
        bool                      runningInBackground;
        Int32                     buildNum;
        GS::UniString             language;
        bool                      ssaEnabled;
        GS::UniString             partnerID;
    } API_ServerApplicationInfo;



The server application (ARCHICAD or the 3D Engine).
The main version of the server application.
The sub- (release) version of the server application.
runningInBackground 4.3
The server application was started in background mode.
buildNum New in API 12
The build number of the server application (not for the 3D Engine)
language New in API 12
The language of the server application as a C string (not for the 3D Engine). For example it contains “INT” for the international version, “JPN” for the Japanese version.
21 From API 21 this field is in Unicode.
ssaEnabled 21
The server application (ARCHICAD) is on Software Service Agreement (SSA). You can use this information to switch part of your add-on’s functionality on/off.
partnerID 21
When ARCHICAD runs on an SSA license this field contains the internal identifier of the reseller.



This is a read-only member of the API_EnvirParams structure, passed as a parameter to the CheckEnvironment function. It can be also obtained with the APIEnv_ApplicationID environment function.

From API 21 you shouldn’t call BNZeroMemory or memset on this structure.



Version: API 4.1 or later
Header: APIdefs_Registration.h


See Also

API Types