• Article

IDTSCustomProperty100.EncryptionRequired Property

Gets or sets a value indicating whether the Value in an IDTSCustomProperty100 object must be encrypted.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
Property EncryptionRequired As Boolean
    Get
    Set
'Usage
Dim instance As IDTSCustomProperty100
Dim value As Boolean

value = instance.EncryptionRequired

instance.EncryptionRequired = value

bool EncryptionRequired { get; set; }

property bool EncryptionRequired {
    bool get ();
    void set (bool value);
}

abstract EncryptionRequired : bool with get, set

function get EncryptionRequired () : boolean
function set EncryptionRequired (value : boolean)

Property Value

Type: System.Boolean
true if the IDTSCustomProperty100 should be encrypted; otherwise, false. The default is false.

Remarks

Use the EncryptionRequired property to protect sensitive information contained in the values of IDTSCustomProperty100 objects. When you set this property to true, the Value property of the custom property is either encrypted or removed completely when you save the package, depending on the DTSProtectionLevel property of the package. When the DTSProtectionLevel is DontSaveSensitive, the Value of custom properties where EncryptionRequired is true are not persisted with the package. When DTSProtectionLevel has any value other than DontSaveSensitive, the Value of custom properties where EncryptionRequired is true are saved with encryption in the persisted package.