Add(Int32,String,Int32,Int32,DBString,DateTime) Method
- Last UpdatedNov 06, 2025
- 2 minute read
The Add() method adds a new item state record to the Item_State table.
'Declaration
Public Overloads Shared Sub Add( _
ByVal sessionId As Integer, _
ByVal itemStatusDesc As String, _
ByVal color As Integer, _
ByVal pref As Integer, _
ByVal lastEditComment As DBString, _
ByRef lastEditAt As Date _
)
public static void Add(
int sessionId,
string itemStatusDesc,
int color,
int pref,
DBString lastEditComment,
out DateTime lastEditAt
)
Parameters
- sessionId
- Required. Holds the session ID and thus the user who is making this method call.
- itemStatusDesc
- Required. Holds the description of the item state.
- color
- Required. Holds an integer that indicates the state's RGB background color in the user interface.
- pref
- Holds a number that indicates the preference ordering of the state. Used in shipping and consumption. Must be greater than 0. The default is 1.
- lastEditComment
- Optional. Holds comments that describe why this record is being added.
- lastEditAt
- Output. Holds the returned date/time when this record was added. The lastEditAt 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.