GetByFilter Method (SampleFreq)
- Last UpdatedMar 17, 2026
- 3 minute read
The GetByFilter() method retrieves a set of sample frequency records based on the input filters.
'Declaration
Public Shared Function GetByFilter( _
ByVal freqName As String, _
ByVal freqDesc As String, _
ByVal freqType As Nullable(Of Integer) _
) As DataSet
'Usage
Dim freqName As String
Dim freqDesc As String
Dim freqType As Nullable(Of Integer)
Dim value As DataSet
value = SampleFreq.GetByFilter(freqName, freqDesc, freqType)
Parameters
- freqName
- Optional filter parameter. Holds the name of the sample plan frequency.
- freqDesc
- Optional filter parameter. Holds the description of the sample plan frequency.
- freqType
Optional filter parameter. Holds the type of the sample plan frequency.
0 = shift
1 (default) = calendar time
2 = run time
3 = production
4 = main item produced changes (job_bom.current_subst for bom_pos = 0)
5 = item consumed at any BOM position changes
6 = the lot number of the main item produced changes (job_bom.def_lot_no for bom_pos = 0)
7 = the lot number of an item consumed at any BOM position changes
8 = the job changes
9 = utilization changes from runtime to downtime
10 = utilization changes from runtime to idle time
11 = utilization changes from downtime to runtime
12 = utilization changes from downtime to idle time
13 = utilization changes from idle time to runtime
14 = utilization changes from idle time to downtime
15 = inventory is received
16 = a new specification value is downloaded for the job running on a job position
17 = a step with action_type 6 starts
18 = a step with action_type 6 finishes
Return Value
Returns a DataSet that contains all the records in the Sample_Freq 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 |
|---|---|
| freq_id | An integer is the ID of the sample frequency. |
| freq_name | A string that identifies the name of the sample plan frequency. |
| freq_desc | A string that contains the description of the sample plan frequency |
| freq_type | An integer that is an enumeration that indicates the sample plan frequency type. |
| interval | A double that is the amount of time or production between samples. |
| interval_unit | An integer that is an enumeration that indicates the units for the amount of time or production between samples. |
| prod_reset_option | An integer that is an enumeration that indicates what causes the count of production between samples to be reset. |
| start_delay | An integer that is the amount of time, in seconds, to delay the generation of the first sample after a job has started on an entity. Used only if freq_type = 1 (calendar time). This parameter is only applicable when offset_start is not being used to specify a time-of-day trigger. |
| offset_start | An integer that is the offset value from the start of the shift. |
| offset_start_unit | An integer that is an enumeration that indicates the units of the offset value from the start of the shift. |
| offset_end | An integer that is the offset value from the end of the shift. |
| offset_end_unit | An integer that is an enumeration that indicates the units of the offset value from the end of the shift. |
| samples_per_shift | An integer that is the number of times to ready an event between the offsets from the ends of a shift. |
| multiplier | An integer that is the sample size multiplier. |
| enabled | A Boolean that is a flag that indicates whether the sample frequency can be used at runtime. |
| expiry_time | An integer that is the amount of time to wait for the sample to be pulled before changing its status to READY WARNING. |
| expiry_unit | An integer that is an enumeration that indicates the units of expiry_time. |
| warning_time | An integer that is the amount of time to wait for a sample to be pulled before changing its status to READY WARNING. |
| warning_unit | An integer that is an enumeration that indicates the units of warning_time. |
| spare1 | A string that is user-defined content for the spare1 field, defined by language term 5157. |
| spare2 | A string that is user-defined content for the spare2 field, defined by language term 5158. |
| spare3 | A string that is user-defined content for the spare3 field, defined by language term 5159. |
| spare4 | A string that is user-defined content for the spare4 field, defined by language term 5160. |
| last_edit_comment | A string that describes why the record was added or changed. |
| last_edit_by | A string that is the ID of the user who created or last modified this record. |
| last_edit_at | A datetime that indicates when the record was added or last modified. |