C++
Acad::ErrorStatus SCENEDLLIMPEXP getBackgroundDictionary( AcDbDatabase* pDb, AcDbDictionary*& pDict, AcDb::OpenMode mode, bool createIfNonExist );
File
dbBackground.h
Description
Given the database pointer pDb, this function opens the background dictionary for given mode mode. If the dictionary does not exist, it will be created if createIfNonExist is true.
Returns Acad::eOk if successful. Returns Acad::eKeyNotFound if the background dictionary does not exists and if createIfNonExists is set to false.
Parameters
| Parameters | Description |
|---|---|
| pDb | Input pointer to the database from which to retrieve the background dictionary |
| pDict | Output pointer to result background dictionary pointer |
| mode | Input requested open mode |
| createIfNonExist | Input Boolean indicating whether the function should create the background dictionary if it does not currently exists in the specified database |