Class FileLists

Namespace

DuetAPI.Utility

Assembly

DuetAPI.dll

Helper class to generate RRF-style file lists

public static class FileLists

Inheritance

object

FileLists

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

GetFileList(string, string, int, int, int, long?)

Get a /rr_filelist or M20 files response

public static string GetFileList(string directory, string physicalDirectory, int startAt = -1, int maxSize = -1, int maxItems = -1, long? explicitLineNumber = null)

Parameters

directory string

RRF path to the directory

physicalDirectory string

Physical directory

startAt int

First file index to return. Set startAt to -1 to omit error handling and the JSON object container

maxSize int

Maximum size of the file list in bytes or -1 if unset

maxItems int

Maximum number of items to send or -1 if unset

explicitLineNumber long?

Explicit line number (if any)

Returns

string

JSON list

GetFileListUtf8(string, string, int, int, int, long?)

Get a /rr_filelist, M20 files response, or a directory file enumeration

public static byte[] GetFileListUtf8(string directory, string physicalDirectory, int startAt = -1, int maxSize = -1, int maxItems = -1, long? explicitLineNumber = null)

Parameters

directory string

RRF path to the directory

physicalDirectory string

Physical directory

startAt int

First file index to return. Set startAt to -1 to omit error handling and the JSON object container

maxSize int

Maximum size of the file list in bytes or -1 if unset

maxItems int

Maximum number of items to send or -1 if unset

explicitLineNumber long?

Explicit line number (if any). Ignored if startAt is negative

Returns

byte[]

UTF8-encoded JSON list

GetFiles(string, string, int, bool, int, int, long?)

Get a /rr_files or M20 files response

public static string GetFiles(string directory, string physicalDirectory, int startAt = 0, bool flagDirs = false, int maxSize = -1, int maxItems = -1, long? explicitLineNumber = null)

Parameters

directory string

RRF path to the directory

physicalDirectory string

Physical directory

startAt int

First item to send

flagDirs bool

Prefix directories with an asterisk

maxSize int

Maximum size of the file list in bytes or -1 if unset

maxItems int

Maximum number of items to send or -1 if unset

explicitLineNumber long?

Explicit line number (if any). Ignored if startAt is negative

Returns

string

JSON file list

GetFilesUtf8(string, string, int, bool, int, int, long?)

Get a /rr_files or M20 files response

public static byte[] GetFilesUtf8(string directory, string physicalDirectory, int startAt = 0, bool flagDirs = false, int maxSize = -1, int maxItems = -1, long? explicitLineNumber = null)

Parameters

directory string

RRF path to the directory

physicalDirectory string

Physical directory

startAt int

First item to send

flagDirs bool

Prefix directories with an asterisk

maxSize int

Maximum size of the file list in bytes or -1 if unset

maxItems int

Maximum number of items to send or -1 if unset

explicitLineNumber long?

Explicit line number (if any)

Returns

byte[]

UTF8-encoded JSON file list