Class FileLists
Helper class to generate RRF-style file lists
Inheritance
System.Object
FileLists
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: DuetAPI.Utility
Assembly: DuetAPI.dll
Syntax
public static class FileLists
Methods
GetFileList(String, String, Int32, Int32)
Get a /rr_filelist or M20 files response
Declaration
public static string GetFileList(string directory, string physicalDirectory, int startAt = -1, int maxSize = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | RRF path to the directory |
System.String | physicalDirectory | Physical directory |
System.Int32 | startAt | First file index to return. Set startAt to -1 to omit error handling and the JSON object container |
System.Int32 | maxSize | Maximum size of the file list in bytes or -1 if unset |
Returns
Type | Description |
---|---|
System.String | JSON list |
GetFiles(String, String, Int32, Boolean, Int32)
Get a /rr_files or M20 files response
Declaration
public static string GetFiles(string directory, string physicalDirectory, int startAt = 0, bool flagDirs = false, int maxSize = -1)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | RRF path to the directory |
System.String | physicalDirectory | Physical directory |
System.Int32 | startAt | First item to send |
System.Boolean | flagDirs | Prefix directories with an asterisk |
System.Int32 | maxSize | Maximum size of the file list in bytes or -1 if unset |
Returns
Type | Description |
---|---|
System.String | JSON file list |