# CSpell Win32 Dictionary
Win32 dictionary for cspell.
This is a pre-built dictionary for use with cspell.
## Requirements
| Tool | Version |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
## Local Installation
```sh
npm install -D @cspell/dict-win32
```
## Configuration
VSCode Settings
Add the following to your VSCode settings:
**`.vscode/settings.json`**
```jsonc
{
"cSpell.import": ["@cspell/dict-win32/cspell-ext.json"],
"cSpell.dictionaries": ["win32"],
}
```
CSpell Settings cspell.json
**`cspell.json`**
```jsonc
{
"import": ["@cspell/dict-win32/cspell-ext.json"],
"dictionaries": ["win32"],
}
```
CSpell Settings cspell.config.yaml
**`cspell.config.yaml`**
```yaml
import:
- '@cspell/dict-win32/cspell-ext.json'
dictionaries:
- win32
```
## Local Installation using CDN
## CDN Configuration
VSCode Settings
Add the following to your VSCode settings:
**`.vscode/settings.json`**
```jsonc
{
"cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-win32/cspell-ext.json"],
"cSpell.dictionaries": ["win32"],
}
```
CSpell Settings cspell.json
**`cspell.json`**
```jsonc
{
"import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-win32/cspell-ext.json"],
"dictionaries": ["win32"],
}
```
CSpell Settings cspell.config.yaml
**`cspell.config.yaml`**
```yaml
import:
- https://cdn.jsdelivr.net/npm/@cspell/dict-win32/cspell-ext.json
dictionaries:
- win32
```
## Dictionary Information
| Name | Enabled | Description |
| ------- | ------- | ----------------- |
| `win32` | | Win32 dictionary. |
## Language Settings
| Name | Locale | File Type |
| ------- | ------ | ---------- |
| `win32` | `*` | `c`, `cpp` |
## Enable the Dictionary
By default the `win32` dictionary is enabled for `C` and `C++` file types. To enable it for other file types, it is necessary to add it to the `dictionaries` section of the configuration or include it as an inline CSpell directive: `cspell:dictionaries win32`.
Example: `example.md`
````markdown
Sample Code:
```cpp
// Parse the command line parameters
int argc;
LPWSTR* argv = CommandLineToArgvW(GetCommandLineW(), &argc);
pSample->ParseCommandLineArgs(argv, argc);
LocalFree(argv);
```
````
## Contributing
Please help correct any mistakes in the dictionaries.
See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
Special thanks to all of our amazing contributors!
### Dictionary Development
See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
## License
MIT
> Some packages may have other licenses included.
---
Brought to you by
Street Side Software