openFile MethodStatic

Open a standalone iModel file.

openFile(filePath: string, openMode: OpenMode = OpenMode.ReadWrite, options?: OpenDbKey): StandaloneDb

throws IModelError if the file is not a standalone iModel.

see BriefcaseConnection.openStandalone to open a StandaloneDb from the frontend

Parameter Type Description
filePath string The path of the standalone iModel file.
openMode OpenMode Optional open mode for the standalone iModel. The default is read/write.
options OpenDbKey  

Returns - StandaloneDb

a new StandaloneDb if the file is not currently open, and the existing StandaloneDb if it is already

Defined in

Last Updated: 12 June, 2024