UnZipFile.UsePassword
---------------------

Sets the password to use for uncompressing.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [Compression](component_Compression.md) | [5.1](newinversion51.md) | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |

MBS( "UnZipFile.UsePassword"; Password { ; Encoding } ) 

**MBS**( **"UnZipFile.UsePassword";** /\* Sets the password to use for uncompressing. \*/  
**$Password**; /\* The password text.e.g. "pass123" \*/   
**$Encoding**) /\* Optional; The text encoding for password parameter.   
Default is native.e.g. "native" \*/ 

### Parameters

| Parameter | Description | Example | Flags |
|---|---|---|---|
| Password | The password text. | "pass123" |  |
| Encoding | The text encoding for password parameter.    Default is native.   Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the [FAQ](https://www.monkeybreadsoftware.com/filemaker/faq.shtml). | "native" | Optional |

### Result

Returns OK or error.

### Description

Sets the password to use for uncompressing.  
The password is needed to open encrypted files in archive.  
Each item in archive could have its own password, but normally all have the same.  
### See also

- [UnZipFile.ReadAsFileContainer](UnZipFileReadAsFileContainer.md)
- [UnZipFile.ReadAsGIFContainer](UnZipFileReadAsGIFContainer.md)
- [UnZipFile.ReadAsHex](UnZipFileReadAsHex.md)
- [UnZipFile.ReadAsJPEGContainer](UnZipFileReadAsJPEGContainer.md)
- [UnZipFile.ReadAsPNGContainer](UnZipFileReadAsPNGContainer.md)
- [UnZipFile.ReadAsText](UnZipFileReadAsText.md)
- [UnZipFile.ReadToFile](UnZipFileReadToFile.md)
- [ZipFile.UsePassword](ZipFileUsePassword.md)

### Example Databases

- [Archives/Show Zip File Content](https://www.mbsplugins.eu/MBS-FileMaker-Plugin-Examples/Archives/Show%20Zip%20File%20Content.shtml#4ScriptAnchor_)

### Blog Entries

- [MBS FileMaker Plugin, version 5.1pr1](https://www.mbsplugins.de/archive/2015-03-16/MBS_FileMaker_Plugin_version_5/monkeybreadsoftware_blog_filemaker)

This function checks for a license.

Created 26th February 2015 , last changed 12nd November 2015

  
[UnZipFile.ReadToFile](UnZipFileReadToFile.md) - [Unregister](Unregister.md)

[HTML Version](UnZipFileUsePassword.shtml)