GetAll Method (SamplePlan)
- Last UpdatedNov 06, 2025
- 3 minute read
The GetAll() method retrieves one or more sample plan records from the Sample_Plan table, as specified by the filter parameters. Passing no filter parameters will retrieve all sample plan records from the table.
'Declaration
Public Shared Function GetAll( _
ByVal planId As Nullable(Of Integer), _
ByVal planName As String, _
ByVal planDesc As String, _
ByVal categoryId As Nullable(Of Integer), _
ByVal verifiedWrite As Nullable(Of Boolean), _
ByVal sampleName As String, _
ByVal resetOption As Nullable(Of Integer), _
ByVal spare1 As String, _
ByVal spare2 As String, _
ByVal spare3 As String, _
ByVal spare4 As String, _
ByVal lastEditBy As String, _
ByVal lastEditAt As Nullable(Of Date) _
) As DataSet
'Usage
Dim planId As Nullable(Of Integer)
Dim planName As String
Dim planDesc As String
Dim categoryId As Nullable(Of Integer)
Dim verifiedWrite As Nullable(Of Boolean)
Dim sampleName As String
Dim resetOption As Nullable(Of Integer)
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
value = SamplePlan.GetAll(planId, planName, planDesc, categoryId, verifiedWrite, sampleName, resetOption, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)
public static DataSet GetAll(
Nullable<int> planId,
string planName,
string planDesc,
Nullable<int> categoryId,
Nullable<bool> verifiedWrite,
string sampleName,
Nullable<int> resetOption,
string spare1,
string spare2,
string spare3,
string spare4,
string lastEditBy,
Nullable<DateTime> lastEditAt
)
Parameters
- planId
- Optional filter parameter. Holds the ID of the sample plan.
- planName
- Optional filter parameter. Holds the unique name of the sample plan.
- planDesc
- Optional filter parameter. Holds a description of the sample plan.
- categoryId
- Optional filter parameter. Holds the ID of the category the sample plan belongs to.
- verifiedWrite
- Optional filter parameter. Holds a flag indicating if an operator confirmation of manually entered values is required.
- sampleName
- Optional filter parameter. Holds the pattern sample names are to follow.
- resetOption
Optional. Holds the option for reseting the octothorpe part(#) of a sample plan name back to 1. Default is Never. 0 (default) = nothing (never resets), 1 = change in local date.
- spare1
- Optional filter parameter. Holds the contents of the user-defined spare1 field.
- spare2
- Optional filter parameter. Holds the contents of the user-defined spare2 field.
- spare3
- Optional filter parameter. Holds the contents of the user-defined spare3 field.
- spare4
- Optional filter parameter. Holds the contents of the user-defined spare4 field.
- lastEditBy
- Optional filter parameter. Holds the ID of a user who added or last updated a sample plan record.
- lastEditAt
- Optional filter parameter. Holds the datetime when a sample plan record was added or last updated.
Return Value
Returns a DataSet that contains all the records in the Sample_Plan table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned.
The columns of the returned DataSet are described below.
| Column Name | Description |
|---|---|
| plan_name | A string that is the name of the sample plan. |
| plan_desc | A string that is a description of the sample plan. |
| category_id | An integer that identifies the category that the sample plan belongs to. |
| verified_write | A flag that indicates whether or not an operator confirmation of manually entered values is required. |
| sample_name | A string that defines a pattern sample names are to follow. Default is "SamplePlanNameYYYYMMDD####". |
| reset_option | An integer that indicates when an octothorpe values within the sample plan name should be reset to 1. |
| spare1 | A string that is the contents of the user-defined spare1 field. |
| spare2 | A string that is the contents of the user-defined spare2 field. |
| spare3 | A string that is the contents of the user-defined spare3 field. |
| spare4 | A string that is the contents of the user-defined spare4 field. |
| last_edit_comment | A string that contains comments about why the record was updated. |
| last_edit_by | A string that is the ID of the user who added or last updated this record. |
| last_edit_at | A date/time that indicates when the record was added or last updated. |
| plan_id | An integer that is the ID of the sample plan. |