Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Document Class / Restore Method
Open as read only if the document is locked? If the document is not locked, this argument has no effect.
Restore document in background without showing it in UI. If document is opened with this parameter set to true the document has to be closed by API too. If the document is not closed by API the behavior of application is undefined.
In This Topic
    Restore Method
    In This Topic
    Restore this document from backup.
    Syntax
    public void Restore( 
   bool tryReadOnly,
   bool silent
)

    Parameters

    tryReadOnly
    Open as read only if the document is locked? If the document is not locked, this argument has no effect.
    silent
    Restore document in background without showing it in UI. If document is opened with this parameter set to true the document has to be closed by API too. If the document is not closed by API the behavior of application is undefined.
    Exceptions
    ExceptionDescription
    EPLAN.Harness.API.Exceptions.ObjectInvalidException The object is in invalid state. Obtain a new one.
    EPLAN.Harness.API.Exceptions.InternalErrorException

    Internal error of HpD or HpD API.

    IMPORTANT: Throwing this exception changes HpD Api's state to Failed.

    EPLAN.Harness.API.Exceptions.FileNotFoundException This file was not found.
    EPLAN.Harness.API.Exceptions.FileLockedException File you are trying to open is locked by another user.
    EPLAN.Harness.API.Exceptions.OperationFailedException The operation was not successful.
    Remarks

    If no backup of this document exists, this method acts as Open. To determine whether the backup exists, use BackupExists.

    If the document is locked by another user you can open a document in read only mode using tryReadOnly argument. As a result you won't be able to perform some actions such as Save.

    See Also

    Reference

    Document Class
    Document Members

    Send Feedback