Share

AcDbAbstractViewTableRecord::setSun (AcDbObjectId &, AcDbObject *, bool) Method

C++

Acad::ErrorStatus setSun(
    AcDbObjectId & retId, 
    AcDbObject * pSun, 
    bool eraseOldSun
);

Description

Sets the object Id of the AcDbSun object associated with this viewport.

Returns Acad::eOk if the object isn't already associated with another viewport.

Parameters

Parameters Description
retId Output object id of the sun object
pSun Input pointer to a sun object
eraseOldSun Input boolean as to whether the old sun object ought to be erased

Notes

There are times where other objects (such as backgrounds) also use the sun ID, so it may not be acceptable to erase the object on calling setSun(). If eraseOldSun is omitted (as in the othersetSun() call), the old sun object will be erased.

Links

AcDbAbstractViewTableRecord

Was this information helpful?