putPrivateString

Add or replace a string in a private lookup table.

Note: Use the putPrivateString function if the lookup table has an ID. If the lookup table has no ID, use the putString function. For more information about the putString function, see putString on page 172.

Syntax

ogscript.putPrivateString (Lookup ID, Key, Value);

Parameters

Parameter

Type

Required

Description

Lookup ID

String

Yes

ID of the string to create or replace in the specified lookup table.

Key

String

Yes

Private lookup table in which to create or replace the specified string.

Value

String

Yes

New value for the specified string.

Returns

N/A

Example

This example uses the putPrivateString function to replace a datum in a lookup table. The lookup table definition for this example is as follows:

<lookupid="hosts">

<entry key="XPression.host">10.0.2.210</entry>

<entry key="XPression.port">9999</entry>

</lookup>


 

The script to replace an entry in the lookup table is as follows:

//Replacethe port numberassociated with entrykey XPression.host ogscript.putPrivateString('hosts',' XPression.port ', '7788');