spiegel-keyman/windows/docs/engine/api/IKeymanPackagesInstalled/Install.md
2024-10-31 10:17:54 +07:00

44 lines
1.3 KiB
Markdown

---
title: IKeymanPackagesInstalled::Install Method
---
## Introduction
The `IKeymanPackagesInstalled::Install` installs the package file (.kmp)
into Keyman Engine for Windows. This includes decompressing the archive,
copying the files contained into the Keyman Engine package store, adding
registry settings, installing fonts, and keyboard layouts with default
languages.
Fonts are copied and installed into the Windows Fonts folder, if an
existing font with the same name is not already present.
This method requires elevated privileges.
## Specification
``` clike
void Install(string Filename, bool Force)
```
## Parameters
`Filename`
: The fully-qualified path to the .kmp file to be installed. This file
will be copied to the Keyman package store.
`Force`
: If `True`, overwrites an existing package entry.
## See also
[`IKeymanPackagesInstalled::Install2`](../IKeymanPackagesInstalled2/Install2)
: Installs a package file, optionally with input method for default
language
[`IKeymanPackageFile::Install`](../IKeymanPackageFile/Install)
: Installs a package file and input method for default language
[`IKeymanPackageFile2::Install2`](../IKeymanPackageFile2/Install2)
: Installs a package file, optionally with input method for default
language