Workbook.SetPasswordEncryptionOptions Method

  • Article
Excel Developer Reference

Sets the options for encrypting workbooks using passwords.

Syntax

expression.SetPasswordEncryptionOptions(PasswordEncryptionProvider, PasswordEncryptionAlgorithm, PasswordEncryptionKeyLength, PasswordEncryptionFileProperties)

expression   A variable that represents a Workbook object.

Parameters

Name Required/Optional Data Type Description
PasswordEncryptionProvider Optional Variant A case sensitive string of the encryption provider.
PasswordEncryptionAlgorithm Optional Variant A case sensitive string of the algorithmic short name (i.e. "RC4").
PasswordEncryptionKeyLength Optional Variant The encryption key length which is a multiple of 8 (40 or greater).
PasswordEncryptionFileProperties Optional Variant True (default) to encrypt file properties.

Remarks

The PasswordEncryptionProvider, PasswordEncryptionAlgorithm, and PasswordEncryptionKeyLength arguments are not independent of each other. A selected encryption provider limits the set of algorithms and key length that can be chosen.

For the PasswordEncryptionKeyLength argument there is no inherent limit on the range of the key length. The range is determined by the Cryptographic Service Provider which also determines the cryptographic algorithm.

Example

This example sets the password encryption options for the active workbook.

Visual Basic for Applications 
  Sub SetPasswordOptions()

ActiveWorkbook.<strong>SetPasswordEncryptionOptions</strong> _
    PasswordEncryptionProvider:="Microsoft RSA SChannel Cryptographic Provider", _
    PasswordEncryptionAlgorithm:="RC4", _
    PasswordEncryptionKeyLength:=56, _
    PasswordEncryptionFileProperties:=True



End Sub

Bb178065.vs_note(en-us,office.12).gif  Note
The code and this method do not do anything for the new Excel file formats (xlsx, xlsb, xlsm, etc...) as the workbook will always use AES 128 bit encryption. If a property is set using this method, it will appear set. When the file is reloaded, the properties will be reset to the AES setting.

See Also