Instance.ArgumentKey Property

Article
12/03/2008

Gets or sets the argument key used to encrypt delivery channel and event provider arguments.

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

Syntax

'Declaration
Public Property ArgumentKey As String

public string ArgumentKey { get; set; }

public:
property String^ ArgumentKey {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_ArgumentKey ()

/** @property */
public void set_ArgumentKey (String value)

public function get ArgumentKey () : String

public function set ArgumentKey (value : String)

Property Value

A String of up to 2500 characters that is used to encrypt delivery channel and event provider arguments.

Remarks

Whether encryption is performed or not is based on the EncryptArguments property. If the EncryptArguments property value is true, Notification Services encrypts delivery channel and event provider arguments using the ArgumentKey value as the key. If encrypting arguments, you must provide this argument key when creating and updating the instance and to read delivery channel and event provider argument values from the database. If you do not provide the argument key value, Notification Services will throw an exception.

The argument key is an object-level property. It is not persisted to the database. When you instantiate an Instance object, and you are using argument encryption, you must specify the argument key. You can then use this argument key within that Instance object.

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