Add(Int32,Int32,Int32,String,Nullable<Int32>,Nullable<Boolean>,DBString,DBString,DBInt,DBInt,DBString,DBString,DBString,DBString,DBString,String) Method
- Last UpdatedNov 06, 2025
- 3 minute read
The Add() method adds a new data log value record to the Data_Log_Value table.
This overload of the method includes the lastEditComment input parameter.
'Declaration
Public Overloads Shared Sub Add( _
ByVal sessionId As Integer, _
ByVal grpId As Integer, _
ByVal valueIndex As Integer, _
ByVal valueName As String, _
ByVal valueType As Nullable(Of Integer), _
ByVal editable As Nullable(Of Boolean), _
ByVal curValue As DBString, _
ByVal specId As DBString, _
ByVal meaning As DBInt, _
ByVal meaningToValueIndex As DBInt, _
ByVal spare1 As DBString, _
ByVal spare2 As DBString, _
ByVal spare3 As DBString, _
ByVal spare4 As DBString, _
ByVal lastEditComment As DBString, _
ByRef modId As String _
)
'Usage
Dim sessionId As Integer
Dim grpId As Integer
Dim valueIndex As Integer
Dim valueName As String
Dim valueType As Nullable(Of Integer)
Dim editable As Nullable(Of Boolean)
Dim curValue As DBString
Dim specId As DBString
Dim meaning As DBInt
Dim meaningToValueIndex As DBInt
Dim spare1 As DBString
Dim spare2 As DBString
Dim spare3 As DBString
Dim spare4 As DBString
Dim lastEditComment As DBString
Dim modId As String
DataLogValue.Add(sessionId, grpId, valueIndex, valueName, valueType, editable, curValue, specId, meaning, meaningToValueIndex, spare1, spare2, spare3, spare4, lastEditComment, modId)
public static void Add(
int sessionId,
int grpId,
int valueIndex,
string valueName,
Nullable<int> valueType,
Nullable<bool> editable,
DBString curValue,
DBString specId,
DBInt meaning,
DBInt meaningToValueIndex,
DBString spare1,
DBString spare2,
DBString spare3,
DBString spare4,
DBString lastEditComment,
out string modId
)
Parameters
- sessionId
- Required. Holds the session ID and thus the user who is making this method call.
- grpId
- Required. Holds the ID of the data log group.
- valueIndex
- Required. Holds the index to the value.
- valueName
- Required. Holds the column heading for the value.
- valueType
- Optional. Holds an enumeration of the value type. The default is 0.
- editable
- Optional. Holds a flag that, if set to true, specifies that the user can manually enter or modify the value. The default is true.
- curValue
- Optional. Holds the current value for this value record.
- specId
- Optional. Holds the spec ID for the current running job.
- meaning
- This parameter is not used by the system.
- meaningToValueIndex
- This parameter is not used by the system.
- spare1
- Optional. Holds the contents of the user-defined spare1 field.
- spare2
- Optional. Holds the contents of the user-defined spare2 field.
- spare3
- Optional. Holds the contents of the user-defined spare3 field.
- spare4
- Optional. Holds the contents of the user-defined spare4 field.
- lastEditComment
Optional. Holds comments that describes why this record is being added.
- modId
Output. Holds the returned modification ID to identify the addition instance of this record. The modId parameter is used by other methods that modify or delete this type of record for optimistic concurrency control.
Observe the following input parameter rules:
- Required non-DB* parameters: Must pass a value. Cannot be empty or null.
- Optional non-DB* parameters: Either enter a value or pass a null. If passing a null and a default value has been defined, the default value will be used for the parameter.
- Required DB* parameters: Must pass a value. To enter an empty value for the parameter, pass DB*.null (e.g., DBInt.null).
- Optional DB* parameters: To enter no value for the parameter, pass DB*.null (e.g., DBInt.null). To use the default value for the parameter if one has been defined for the object being added, pass a null.