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.
In This Topic
    Restore Method
    In This Topic
    Restore this document from backup.
    Syntax
    public void Restore( 
       bool tryReadOnly
    )

    Parameters

    tryReadOnly
    Open as read only if the document is locked? If the document is not locked, this argument has no effect.
    Exceptions
    ExceptionDescription
    The object is in invalid state. Obtain a new one.

    Internal error of HpD or HpD API.

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

    This file was not found.
    File you are trying to open is locked by another user.
    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