Returns information on the current project file.
GSErrCode ACAPI_Environment ( APIEnv_ProjectID, API_ProjectInfo* projectInfo );
- [out] Project file and teamwork project specific data.
- No error occurred.
- No open project.
- Low memory condition.
For other common API errors see the API Errors document.
This function is used to get information on the project file. In teamwork mode, the teamwork related data are also available. See the definitions of the returned parameters at API_ProjectInfo.
The file specification is available only if the project file has been saved before. For ‘untitled’ project no data is returned.
Do not forget to delete the IO::Location objects created by the function.
API_ProjectInfo projectInfo; ACAPI_Environment (APIEnv_ProjectID, &projectInfo, nullptr); if (projectInfo.location != nullptr) delete projectInfo.location; if (projectInfo.location_team != nullptr) delete projectInfo.location_team;
- Version: API 2.1 or later
- Header: APIdefs_Environment.h