GetAll Method (ItemFile)
- Last UpdatedMar 17, 2026
- 3 minute read
The GetAll() method retrieves one or more item file records from the Item_File table, as specified by the filter parameters. Passing no filter parameters will retrieve all standard item records from the table.
'Declaration
Public Shared Function GetAll( _
ByVal itemId As String, _
ByVal filePath As String, _
ByVal fileDesc As String, _
ByVal fileType As String, _
ByVal lastModified As Nullable(Of Date), _
ByVal fileSize As Nullable(Of Integer), _
ByVal author As String, _
ByVal lastEditBy As String, _
ByVal lastEditAt As Nullable(Of Date) _
) As DataSet
'Usage
Dim itemId As String
Dim filePath As String
Dim fileDesc As String
Dim fileType As String
Dim lastModified As Nullable(Of Date)
Dim fileSize As Nullable(Of Integer)
Dim author As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
value = ItemFile.GetAll(itemId, filePath, fileDesc, fileType, lastModified, fileSize, author, lastEditBy, lastEditAt)
public static DataSet GetAll(
string itemId,
string filePath,
string fileDesc,
string fileType,
Nullable<DateTime> lastModified,
Nullable<int> fileSize,
string author,
string lastEditBy,
Nullable<DateTime> lastEditAt
)
Parameters
- itemId
- Optional filter parameter. Holds the ID of the item to which the file belong.
- filePath
- Optional filter parameter. Holds the path and file name of the file associated with the item.
- fileDesc
- Optional filter parameter. Holds the description of the file.
- fileType
- Optional filter parameter. Holds the file extension of the file that is associated with the item.
- lastModified
- Optional filter parameter. Holds the date/time of the last time the file was modified.
- fileSize
- Optional filter parameter. Holds the size of the file in bytes.
- author
- Optional filter parameter. Holds the name of the author of the file.
- lastEditBy
- Optional filter parameter. Holds the ID of a user who added or last updated a item.
- lastEditAt
- Optional filter parameter. Holds a date/time when a item file record was added or last updated.
Return Value
Returns a DataSet that contains all the records in the Item_File 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.
|
ColumnName |
Description |
|---|---|
|
item_id |
A string that is the ID of the item to which the file belongs. |
|
file_path |
A string that is path and file name of the associated file. |
|
item_desc |
A string that is description of the item (from the Item table. |
|
file_desc |
A string that is description of the file (may be null). |
|
file_type |
A string that is the file extension of the associated file. The file extension is pulled from the filename in the file_path column. |
|
last_modified |
A DateTime that is last time the file was modified (may be null). |
|
file_size |
An integer that is the size of the file in bytes (may be null). |
|
author |
A string that is the name of the author of the file (may be null). |
|
user_desc |
A string that is the description of the author if the author is valid user ID (may be null). |
|
spare1 |
A user defined string value (may be null). |
|
spare2 |
A user defined string value (may be null). |
|
spare3 |
A user defined string value (may be null). |
|
spare4 |
A user defined string value (may be null). |
|
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). |
|
last_edit_comment |
A string that contains comments about why the record was added or 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. |
|
mod_id |
The current modification ID of the record in the 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. |