SetKeyValuePair method: PSEvent class

Syntax

SetKeyValuePair(key, value)

Description

Use the SetKeyValuePair method to add data in the form key-value pair to the notification.

Note:

Notification data can be represented as either key-value pairs or as a rowset, not both. The event definition on the Define Server Side Events page determines the type of data for the notification and therefore the Setxxx method to be used.

Parameters

Parameter Description

key

Specify the string representing the name of the key. Key names are defined in the Data Structure field on the Define Server Side Events page.

value

Specify the string representing the value.

Returns

A Boolean value: True if the method completes successfully, False otherwise.

Example

The following example sets the value for the key named "ID".

&Key = "ID";
&Value = "100";
&EventObject.SetKeyValuePair(&Key, &Value);