Instance.EncryptArguments Property

Article
12/03/2008

Gets or sets the argument encryption setting for the instance of Notification Services.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Property EncryptArguments As Boolean

public bool EncryptArguments { get; set; }

public:
property bool EncryptArguments {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_EncryptArguments ()

/** @property */
public void set_EncryptArguments (boolean value)

public function get EncryptArguments () : boolean

public function set EncryptArguments (value : boolean)

Property Value

true if Notification Services encrypts delivery channel and event provider arguments before storing them in the database; otherwise, false.

Remarks

The EncryptArguments property specifies whether the instance encrypts delivery channel and event provider arguments before storing the values in the instance and application databases. These arguments can contain user names and passwords, so encrypting these values prevents anyone from reading the values from the databases.

Before you create the instance, you must determine the value for the ArgumentKey property, which is a string of up to 2500 characters that Notification Services uses to encrypt the data. You must supply this key value when you create, register, and update the instance.

Example

The following examples show how to enable argument encryption and set the argument key:

myInstance.EncryptArguments = true;
myInstance.ArgumentKey = "MyKey135711";

myInstance.EncryptArguments = True
myInstance.ArgumentKey = "MyKey135711"

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