Method: Add for ContextParameters

Download PDF

Updated2024-09-12
2 minute(s) read

Adds a context parameter to the collection of context parameters.

Set oContextParameter = Object.Add(Name, Value, DataType)

Object

ContextParameters
Object with this method

Name

String
Specifies the name of the context parameter.

Value

Variant
Specifies the name of the context parameter.

DataType

Specifies the data type of the context parameter.
Enumeration with the following selection terms:

0	DataTypeUnknown	Not defined
1	DataTypeInt8	8-bit integer values
2	DataTypeInt16	16-bit integer values
3	DataTypeInt32	32-bit integer values
4	DataTypeInt64	64-bit integer values
5	DataTypeUInt8	Unsigned 8-bit integer values
6	DataTypeUInt16	Unsigned 16-bit integer values
7	DataTypeUInt32	Unsigned 32-bit integer values
8	DataTypeUInt64	Unsigned 64-bit integer values
9	DataTypeFloat32	32-bit real values
10	DataTypeFloat64	64-bit real values
23	DataTypeString	Text
24	DataTypeEnum	Enumeration
30	DataTypeDate	Time values

oContextParameter

ContextParameter
Returned object

The following example generates several context parameters and writes these parameters to an ASAM server:

VBScript

Python

Copy script

Dim oMyDataStore
Set oMyDataStore = Navigator.ConnectDataStore("MyASAMServer")
'Generating parameter set
Dim oMyParameterSet
Set oMyParameterSet = Navigator.Settings.CreateContextParameterSet
oMyParameterSet.Name = "MyParameterSet"
'Generating parameters and writing parameters into parameter set
Dim OMyParameters
Set oMyParameters = oMyParameterSet.Parameters
Call oMyParameters.Add("DoubleParameter",1.2345,DataTypeFloat64)
Call oMyParameters.Add("StringParameter","Parameter",DataTypeString)
'Reading all parameters from parameter set
Dim MyParameter
For Each MyParameter in oMyParameterSet.Parameters
  Call MsgBoxDisp("Name: " & MyParameter.Name & VBCrLf _ 
  & "Value: " & MyParameter.Value & VBCrLf _
  & "Data type: " & MyParameter.DataType)
Next
'Saving, removing and loading parameter set
Call Navigator.Settings.SaveContextParameterSet("d:\MyParameterSet.tdp",oMyParameterSet)
oMyParameterSet.Parameters.RemoveAll
Set oMyParameterSet = Navigator.Settings.LoadContextParameterSet("d:\MyParameterSet.tdp")
'Writing parameter set to server
Dim oContext
Set oContext = oMyDataStore.GetContext
Call oContext.SetParameters(oMyParameterSet)
'Writing another single parameter to server
Call oContext.SetParameter("AnotherParam","ParamValue",DataTypeString)
'Reading single parameter from server
Dim MyValue
MyValue = oContext.GetParameter("AnotherParam")

oMyDataStore = dd.Navigator.ConnectDataStore("MyASAMServer") 
#Generating parameter set
oMyParameterSet = dd.Navigator.Settings.CreateContextParameterSet() 
oMyParameterSet.Name = "MyParameterSet" 
#Generating parameters and writing parameters into parameter set
oMyParameters = oMyParameterSet.Parameters 
oMyParameters.Add("DoubleParameter",1.2345,dd.DataTypeFloat64) 
oMyParameters.Add("StringParameter","Parameter",dd.DataTypeString) 
#Reading all parameters from parameter set
for MyParameter in oMyParameterSet.Parameters: 
    dd.MsgBoxDisp("Name: " + MyParameter.Name + "\r\n" + "Value: " + MyParameter.Value + "\r\n" + "Data type: " + MyParameter.DataType) 
#Saving, removing and loading parameter set
dd.Navigator.Settings.SaveContextParameterSet("d:\\MyParameterSet.tdp",oMyParameterSet) 
oMyParameterSet.Parameters.RemoveAll() 
oMyParameterSet = dd.Navigator.Settings.LoadContextParameterSet("d:\\MyParameterSet.tdp") 
#Writing parameter set to server
oContext = oMyDataStore.GetContext() 
oContext.SetParameters(oMyParameterSet) 
#Writing another single parameter to server
oContext.SetParameter("AnotherParam","ParamValue",dd.DataTypeString) 
#Reading single parameter from server
MyValue = oContext.GetParameter("AnotherParam")

DIAdem Help

Table of Contents

Method: Add for ContextParameters

See Also