Version: |
6.0 |
Description: |
Sets the erased flag for the current entity to true and does not change the redo level. |
Declaration: |
|
C/C++ |
extern "C" void WINAPI VCSetCurrentErasedNoRedo(short* iError); |
Delphi |
procedure VCSetCurrentErasedNoRedo(var iError: Smallint); stdcall; |
ActiveX/COM |
Sub SetCurrentErasedNoRedo() |
Parameters: |
None. |
Return Value: |
None. |
iError Code: |
0 - Success |
Notes: |
Most operations which erase an entity, such as the native command Erase or the API function VCSetCurrentErased, will set a current redo level for the erased entity on the assumption that the user may want the opportunity to Undo and Redo the erasure. However, some API tasks may require that the erased entity keep its original redo level. For example, if a tool has erased an entity and then the tool is aborted, it is probably desirable to be able to again unerase that entity with its original redo level instead of the new redo level. Use VCSetCurrentErasedNoRedo to erase the current entity and keep its existing redo level. If the entity must be restored later, use VCSetCurrentUnErased and it will be unerased with its original redo level. This technique is very useful for tools which modify existing entities and which may be aborted before their completion, thus requiring that the existing entities be restored to their original state. |
See Also: |
VCSetCurrentErased, VCSetCurrentUnErased, VCSetCurrentEntityUndo, VCSetCurrentEntityRedo |