GetAll Method (Folder)
- Last UpdatedNov 06, 2025
- 3 minute read
The GetAll() method retrieves one or more folder records from the Folder table, as specified by the filter parameters. Passing no filter parameters will retrieve all folder records from the table.
'Declaration
Public Shared Function GetAll( _
ByVal itemId As String, _
ByVal operId As String, _
ByVal entId As Nullable(Of Integer), _
ByVal verId As String, _
ByVal udf1 As String, _
ByVal udf2 As String, _
ByVal preferredVer As Nullable(Of Boolean), _
ByVal designHold As Nullable(Of Boolean), _
ByVal lastEditBy As String, _
ByVal lastEditAt As Nullable(Of Date) _
) As DataSet
'Usage
Dim itemId As String
Dim operId As String
Dim entId As Nullable(Of Integer)
Dim verId As String
Dim udf1 As String
Dim udf2 As String
Dim preferredVer As Nullable(Of Boolean)
Dim designHold As Nullable(Of Boolean)
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
value = Folder.GetAll(itemId, operId, entId, verId, udf1, udf2, preferredVer, designHold, lastEditBy, lastEditAt)
public static DataSet GetAll(
string itemId,
string operId,
Nullable<int> entId,
string verId,
string udf1,
string udf2,
Nullable<bool> preferredVer,
Nullable<bool> designHold,
string lastEditBy,
Nullable<DateTime> lastEditAt
)
Parameters
- itemId
- Optional filter parameter. Holds the ID of an item associated with the folder.
- operId
- Optional filter parameter. Holds the ID of an operation associated with the folder.
- entId
- Optional filter parameter. Holds the ID of an entity associated with the folder.
- verId
- Optional filter parameter. Holds a folder version.
- udf1
- Optional filter parameter. Holds the contents of a user-defined field 1 of the folder.
- udf2
- Optional filter parameter. Holds the contents of a user-defined field 2 of the folder.
- preferredVer
- Optional filter parameter. Holds the flag that indicates whether this version of the folder is the preferred version.
- designHold
- Optional filter parameter. Holds the design hold flag of the folder.
- lastEditBy
- Optional filter parameter. Holds the ID of a user who added or last updated this type of record.
- lastEditAt
- Optional filter parameter. Holds a date/time when this type of record was added or last updated.
Return Value
Returns a DataSet that contains records for each folder that satisfy the specified filters. If no matching records are found, an empty DataSet is returned. The records contain columns from the Folder, Item, and Ent tables.
The columns of the returned DataSet are described below.
| Column Name | Description |
|---|---|
| item_id | A string that is the item ID. |
| item_display |
A string that is the display string for the item. The display string format is based on the value of the Item Display system attribute (attr_id = 210): 0 = item_id 1 = item_desc 2 = item_id(item_desc) 3 = item_desc(item_id) |
| oper_id | A string that is the operation ID. |
| ent_id | An integer that is the ID of the entity for which the folder is built. |
| ver_id | A string that is the folder version. |
| ent_name | A string that is the name of the entity for which the folder is built. From the Ent table. |
| item_desc | A string that is the description of item. From the Item table. |
| oper_desc | A string that is the description of the operation. |
| notes | A string that is the notes about the folder. |
| udf1 | A string that is the contents of the folder's user-defined field 1. |
| udf2 | A string that is the contents of the folder's user-defined field 2. |
| preferred_ver | A Boolean that is a flag that indicates whether the folder version in ver_id is the preferred version. |
| design_hold |
A Boolean that is a flag that indicates whether this folder is on a design hold. Note: This property is currently not used by the system. |
| last_edit_comment | A string that contains comments about why the folder record was added or updated. |
| last_edit_by | A string that is the ID of the user who added or last updated the folder record. |
| last_edit_at | A datetime that indicates when the folder record was added or last updated. |
|
mod_id |
The current modification ID of the record in the Folder table. This ID is binary number that increments each time the record’s table row is modified. Optionally used for optimistic concurrency control when performing updates or deletes. |