API Reference > OdDb Classes > OdDbLayerStateManager Class > OdDbLayerStateManager Methods > restoreLayerState Method > OdDbLayerStateManager::restoreLayerState Method (OdString&, OdDbObjectId&, int, LayerStateMask*)
OdDbLayerStateManager::restoreLayerState Method (OdString&, OdDbObjectId&, int, LayerStateMask*)
Syntax
C++
OdResult restoreLayerState(const OdString& sName, const OdDbObjectId& idVp, int nRestoreFlags = 0, const LayerStateMask* pClientMask = NULL);
Parameters 
Description 
const OdString& sName 
[in] Name of the layer state to be restored.  
const OdDbObjectId& idVp 
[in] ID of the viewport to restore the layer state for.  
int nRestoreFlags = 0 
[in] Restore flags.  
const LayerStateMask* pClientMask = NULL 
[in] Layer state mask of the target viewport. 

eOk if operation succeeded; error code otherwise.

Restores the specified layer state. 

 

Layer state mask determines which layer attributes are restored from the layer state. Layer state mask must be a combination of one or more of the following: 

 

Name 
Value 
kNone 
0x0000 
kOn 
0x0001 
kFrozen 
0x0002 
kLocked 
0x0004 
kPlot 
0x0008 
kNewViewport 
0x0010 
kColor 
0x0020 
kLineType 
0x0040 
kLineWeight 
0x0080 
kPlotStyle 
0x0100 
kCurrentViewport 
0x0200 
kTransparency 
0x0400 
kAll 
kOn | kFrozen | kLocked | kPlot | kNewViewport | 
 
kColor | kLineType | kLineWeight | kPlotStyle | 
 
kCurrentViewport | kTransparency 
kHidden 
0x8000 

 

Restore flags determine what to do with layers that are missing in the layer state being restored, but are present in the viewport. The kRestoreAsOverrides flag determines whether the properties that can be overriden in a viewport (such as color) will be restored as overrides. The nRestoreFlags flags parameter must be a combination of one or more of the following flags: 

 

Name 
Value 
kUndefDoNothing 
0x0000 
kUndefTurnOff 
0x0001 
kUndefFreeze 
0x0002 
kRestoreAsOverrides 
0x0004 

 

Copyright © 2002–2021. Open Design Alliance. All rights reserved.