Restore method
- Last UpdatedJul 23, 2024
- 1 minute read
Restores a Galaxy from a backup file.
Class
IGalaxy
Syntax
[C#]
void Restore(
int lProcessId,
string backupFilename,
string GRNodeName,
string Galaxy,
bool bRestoreOlderVersion
);
[Visual C++]
HRESULT Restore(
[in]LONG lProcessId,
[in] BSTR backupFilename,
[in, optional] BSTR GRNodeName,
[in, optional] BSTR Galaxy,
[in, optional] VARIANT_BOOL bRestoreOlderVersion
);
Parameters
lProcessId
Proccess ID of the calling process.
backupFilename
Name of the backup file. File extension cab is appended if not specified. If a folder name is specified, the Galaxy is restored from the contents of the folder.
GRNodeName
The name of the GR node (computer name). Blank or omitted means the current computer is the GR.
Galaxy
The name of an exiting Galaxy (application database) into which the backed up Galaxy is to be restored into.
bRestoreOlderVersion
Indicates whether to restore the database even if backup is an older version. If omitted, this field is set to false indicating an older database that should not be restored.
Remarks
User should not be logged in.