Retrieves information of the given database.
GSErrCode ACAPI_Database ( APIDb_GetDatabaseInfoID, API_DatabaseInfo* databaseInfo );
Parameters
- databaseInfo
- [in/out] parameters of the database
Return Values
NoError
- The function has completed with success.
APIERR_BADPARS
databaseInfo
isnullptr
APIERR_BADDATABASE
- the passed database reference is not valid
For other common API errors see the API Errors document.
Remarks
This function is used to retrieve information about a database specified with databaseUnId
.
Example
GS::Array<API_DatabaseUnId> dbases; GSErrCode err = ACAPI_Database (APIDb_GetLayoutDatabasesID, nullptr, &dbases); if (err == NoError) { for (const auto& dbUnId : dbases) { API_DatabaseInfo dbPars = {}; dbPars.databaseUnId = dbUnId; err = ACAPI_Database (APIDb_GetDatabaseInfoID, &dbPars, nullptr); if (err == NoError) { char msgStr[1024]; sprintf (msgStr, "Layout database [%d] unId:(%d-%d) title:\"%s\" name:\"%s\" ref:\"%s\"", dbPars.index, dbPars.databaseUnId.id1, dbPars.databaseUnId.id2, dbPars.title, dbPars.name, dbPars.ref); ACAPI_WriteReport (msgStr, false); } } }
Requirements
- Version: API 10 or later
- Header: APIdefs_Database.h
See Also
API_DatabaseInfo
APIDb_NewDatabaseID, APIDb_ModifyDatabaseID, APIDb_DeleteDatabaseID
APIDb_GetCurrentDatabaseID, APIDb_ChangeCurrentDatabaseID, APIDb_NewWindowID
ACAPI_Database, API Functions