GetAll Method (FolderFile)
- Last UpdatedNov 06, 2025
- 4 minute read
The GetAll() method retrieves one or more file records from the Folder_File table, as specified by the filter parameters. Passing no filter parameters will retrieve all file 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 filePath As String, _
ByVal fileType As String, _
ByVal lastModified As Nullable(Of Date), _
ByVal author As String, _
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 filePath As String
Dim fileType As String
Dim lastModified As Nullable(Of Date)
Dim author As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
value = FolderFile.GetAll(itemId, operId, entId, verId, filePath, fileType, lastModified, author, lastEditBy, lastEditAt)
public static DataSet GetAll(
string itemId,
string operId,
Nullable<int> entId,
string verId,
string filePath,
string fileType,
Nullable<DateTime> lastModified,
string author,
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.
- filePath
- Optional filter parameter. Holds a path and file name of the file.
- fileType
- Optional filter parameter. Holds the file extension of the file.
- lastModified
- Optional filter parameter. Holds a date/time of the last time the file was modified.
- author
- Optional filter parameter. Holds the name of an author of the file.
- 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 all the records in the Folder_File table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned. The records contain columns from the Folder_File, File_Type, 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. |
| 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. |
| file_path | A string that is the path and file name of the file. |
| 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. |
| file_desc | A string that is the description of the file. |
| file_type | A string that is the file extension of the file. The file extension is pulled from the filename in the file_path column. |
| last_modified | A datetime that is the last modified date of the file. |
| file_size | An integer that is the size of the file in bytes. |
| author | A string that is the name of the author of the file. |
| spare1 | A string that is the content of the user-defined spare1 field. |
| spare2 | A string that is the content of the user-defined spare2 field. |
| spare3 | A string that is the content of the user-defined spare3 field. |
| spare4 | A string that is the content of the user-defined spare4 field. |
| user_desc | A string that is the description of the author if author is a valid user ID. |
| download | Note: This parameter is no longer used by the system. |
| edit_level_h | An integer that is the edit level required to edit the file. From the File_Type table. |
| view_level_h | An integer that is the view level required to view the file. From the File_Type table. |
| print_level_h | An integer that is the print level required to print the file. From the File_Type table. |
| down_level_h | Note: This parameter is no longer used by the system. |
| viewer_h | Note: This parameter is no longer used by the system. |
| editor_h | Note: This parameter is no longer used by the system. |
| url | Note: This parameter is no longer 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_File 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. |