IDTSCustomProperty90.EncryptionRequired Property

Article
12/03/2008

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

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

Syntax

'Declaration
<DispIdAttribute(103)> _
Property EncryptionRequired As Boolean

[DispIdAttribute(103)] 
bool EncryptionRequired { get; set; }

[DispIdAttribute(103)] 
property bool EncryptionRequired {
    bool get ();
    void set ([InAttribute] bool pbEnryptionRequired);
}

/** @property */
/** @attribute DispIdAttribute(103) */ 
boolean get_EncryptionRequired ()

/** @property */
/** @attribute DispIdAttribute(103) */ 
void set_EncryptionRequired (/** @attribute InAttribute() */ boolean pbEnryptionRequired)

DispIdAttribute(103) 
function get EncryptionRequired () : boolean

DispIdAttribute(103) 
function set EncryptionRequired (pbEnryptionRequired : boolean)

Property Value

true if the IDTSCustomProperty90 should be encrypted; otherwise, false. The default is false.

Remarks

Use the EncryptionRequired property to protect sensitive information contained in the values of IDTSCustomProperty90 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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms