Software / API Bindings / C# / API Referenz und Beispiele / Bricks / RED Brick

C# - RED Brick¶

Dies ist die Beschreibung der C# API Bindings für den RED Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RED Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

API¶

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Bemerkung

Die API Dokumentation für den RED Brick ist noch nicht vollständig.

Fortgeschrittene Funktionen¶

void BrickRED.CreateSession(long lifetime, out byte errorCode, out int sessionId)¶

Parameter:	lifetime – Typ: long, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.ExpireSession(int sessionId)¶

Parameter:	sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.ExpireSessionUnchecked(int sessionId)¶

Parameter:	sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

byte BrickRED.KeepSessionAlive(int sessionId, long lifetime)¶

Parameter:	sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] lifetime – Typ: long, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.ReleaseObject(int objectId, int sessionId)¶

Parameter:	objectId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.ReleaseObjectUnchecked(int objectId, int sessionId)¶

Parameter:	objectId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

void BrickRED.AllocateString(long lengthToReserve, string buffer, int sessionId, out byte errorCode, out int stringId)¶

Parameter:	lengthToReserve – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] buffer – Typ: string, Länge: bis zu 58 sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten stringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.TruncateString(int stringId, long length)¶

Parameter:	stringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] length – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetStringLength(int stringId, out byte errorCode, out long length)¶

Parameter:	stringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten length – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.SetStringChunk(int stringId, long offset, string buffer)¶

Parameter:	stringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] buffer – Typ: string, Länge: bis zu 58
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetStringChunk(int stringId, long offset, out byte errorCode, out string buffer)¶

Parameter:	stringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten buffer – Typ: string, Länge: bis zu 63

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.AllocateList(int lengthToReserve, int sessionId, out byte errorCode, out int listId)¶

Parameter:	lengthToReserve – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten listId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetListLength(int listId, out byte errorCode, out int length)¶

Parameter:	listId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten length – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetListItem(int listId, int index, int sessionId, out byte errorCode, out int itemObjectId, out byte type)¶

Parameter:	listId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] index – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten itemObjectId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] type – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für type:

BrickRED.OBJECT_TYPE_STRING = 0
BrickRED.OBJECT_TYPE_LIST = 1
BrickRED.OBJECT_TYPE_FILE = 2
BrickRED.OBJECT_TYPE_DIRECTORY = 3
BrickRED.OBJECT_TYPE_PROCESS = 4
BrickRED.OBJECT_TYPE_PROGRAM = 5

byte BrickRED.AppendToList(int listId, int itemObjectId)¶

Parameter:	listId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] itemObjectId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.RemoveFromList(int listId, int index)¶

Parameter:	listId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] index – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.OpenFile(int nameStringId, long flags, int permissions, long uid, long gid, int sessionId, out byte errorCode, out int fileId)¶

Parameter:	nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: long, Wertebereich: Siehe Konstanten permissions – Typ: int, Wertebereich: Siehe Konstanten uid – Typ: long, Wertebereich: [0 bis 2³² - 1] gid – Typ: long, Wertebereich: [0 bis 2³² - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für flags:

BrickRED.FILE_FLAG_READ_ONLY = 1
BrickRED.FILE_FLAG_WRITE_ONLY = 2
BrickRED.FILE_FLAG_READ_WRITE = 4
BrickRED.FILE_FLAG_APPEND = 8
BrickRED.FILE_FLAG_CREATE = 16
BrickRED.FILE_FLAG_EXCLUSIVE = 32
BrickRED.FILE_FLAG_NON_BLOCKING = 64
BrickRED.FILE_FLAG_TRUNCATE = 128
BrickRED.FILE_FLAG_TEMPORARY = 256
BrickRED.FILE_FLAG_REPLACE = 512

Für permissions:

BrickRED.FILE_PERMISSION_USER_ALL = 448
BrickRED.FILE_PERMISSION_USER_READ = 256
BrickRED.FILE_PERMISSION_USER_WRITE = 128
BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
BrickRED.FILE_PERMISSION_GROUP_ALL = 56
BrickRED.FILE_PERMISSION_GROUP_READ = 32
BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
BrickRED.FILE_PERMISSION_OTHERS_READ = 4
BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.CreatePipe(long flags, long length, int sessionId, out byte errorCode, out int fileId)¶

Parameter:	flags – Typ: long, Wertebereich: Siehe Konstanten length – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für flags:

BrickRED.PIPE_FLAG_NON_BLOCKING_READ = 1
BrickRED.PIPE_FLAG_NON_BLOCKING_WRITE = 2

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetFileInfo(int fileId, int sessionId, out byte errorCode, out byte type, out int nameStringId, out long flags, out int permissions, out long uid, out long gid, out long length, out long accessTimestamp, out long modificationTimestamp, out long statusChangeTimestamp)¶

Parameter:

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten type – Typ: byte, Wertebereich: Siehe Konstanten nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: long, Wertebereich: Siehe Konstanten permissions – Typ: int, Wertebereich: Siehe Konstanten uid – Typ: long, Wertebereich: [0 bis 2³² - 1] gid – Typ: long, Wertebereich: [0 bis 2³² - 1] length – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] accessTimestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1] modificationTimestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1] statusChangeTimestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1]

fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Ausgabeparameter:

errorCode – Typ: byte, Wertebereich: Siehe Konstanten
type – Typ: byte, Wertebereich: Siehe Konstanten
nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
flags – Typ: long, Wertebereich: Siehe Konstanten
permissions – Typ: int, Wertebereich: Siehe Konstanten
uid – Typ: long, Wertebereich: [0 bis 2³² - 1]
gid – Typ: long, Wertebereich: [0 bis 2³² - 1]
length – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]
accessTimestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1]
modificationTimestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1]
statusChangeTimestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für type:

BrickRED.FILE_TYPE_UNKNOWN = 0
BrickRED.FILE_TYPE_REGULAR = 1
BrickRED.FILE_TYPE_DIRECTORY = 2
BrickRED.FILE_TYPE_CHARACTER = 3
BrickRED.FILE_TYPE_BLOCK = 4
BrickRED.FILE_TYPE_FIFO = 5
BrickRED.FILE_TYPE_SYMLINK = 6
BrickRED.FILE_TYPE_SOCKET = 7
BrickRED.FILE_TYPE_PIPE = 8

Für flags:

BrickRED.FILE_FLAG_READ_ONLY = 1
BrickRED.FILE_FLAG_WRITE_ONLY = 2
BrickRED.FILE_FLAG_READ_WRITE = 4
BrickRED.FILE_FLAG_APPEND = 8
BrickRED.FILE_FLAG_CREATE = 16
BrickRED.FILE_FLAG_EXCLUSIVE = 32
BrickRED.FILE_FLAG_NON_BLOCKING = 64
BrickRED.FILE_FLAG_TRUNCATE = 128
BrickRED.FILE_FLAG_TEMPORARY = 256
BrickRED.FILE_FLAG_REPLACE = 512

Für permissions:

BrickRED.FILE_PERMISSION_USER_ALL = 448
BrickRED.FILE_PERMISSION_USER_READ = 256
BrickRED.FILE_PERMISSION_USER_WRITE = 128
BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
BrickRED.FILE_PERMISSION_GROUP_ALL = 56
BrickRED.FILE_PERMISSION_GROUP_READ = 32
BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
BrickRED.FILE_PERMISSION_OTHERS_READ = 4
BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1

void BrickRED.ReadFile(int fileId, byte lengthToRead, out byte errorCode, out byte[] buffer, out byte lengthRead)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] lengthToRead – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten buffer – Typ: byte[], Länge: 62, Wertebereich: [0 bis 255] lengthRead – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.ReadFileAsync(int fileId, long lengthToRead)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] lengthToRead – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]

byte BrickRED.AbortAsyncFileRead(int fileId)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.WriteFile(int fileId, byte[] buffer, byte lengthToWrite, out byte errorCode, out byte lengthWritten)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: byte[], Länge: 61, Wertebereich: [0 bis 255] lengthToWrite – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten lengthWritten – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.WriteFileUnchecked(int fileId, byte[] buffer, byte lengthToWrite)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: byte[], Länge: 61, Wertebereich: [0 bis 255] lengthToWrite – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]

void BrickRED.WriteFileAsync(int fileId, byte[] buffer, byte lengthToWrite)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: byte[], Länge: 61, Wertebereich: [0 bis 255] lengthToWrite – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]

void BrickRED.SetFilePosition(int fileId, long offset, byte origin, out byte errorCode, out long position)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: long, Einheit: 1 B, Wertebereich: [-2⁶³ bis 2⁶³ - 1] origin – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten position – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für origin:

BrickRED.FILE_ORIGIN_BEGINNING = 0
BrickRED.FILE_ORIGIN_CURRENT = 1
BrickRED.FILE_ORIGIN_END = 2

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetFilePosition(int fileId, out byte errorCode, out long position)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten position – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.SetFileEvents(int fileId, int events)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] events – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für events:

BrickRED.FILE_EVENT_READABLE = 1
BrickRED.FILE_EVENT_WRITABLE = 2

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetFileEvents(int fileId, out byte errorCode, out int events)¶

Parameter:	fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten events – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für events:

BrickRED.FILE_EVENT_READABLE = 1
BrickRED.FILE_EVENT_WRITABLE = 2

void BrickRED.OpenDirectory(int nameStringId, int sessionId, out byte errorCode, out int directoryId)¶

Parameter:	nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten directoryId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetDirectoryName(int directoryId, int sessionId, out byte errorCode, out int nameStringId)¶

Parameter:	directoryId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetNextDirectoryEntry(int directoryId, int sessionId, out byte errorCode, out int nameStringId, out byte type)¶

Parameter:	directoryId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] type – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für type:

BrickRED.DIRECTORY_ENTRY_TYPE_UNKNOWN = 0
BrickRED.DIRECTORY_ENTRY_TYPE_REGULAR = 1
BrickRED.DIRECTORY_ENTRY_TYPE_DIRECTORY = 2
BrickRED.DIRECTORY_ENTRY_TYPE_CHARACTER = 3
BrickRED.DIRECTORY_ENTRY_TYPE_BLOCK = 4
BrickRED.DIRECTORY_ENTRY_TYPE_FIFO = 5
BrickRED.DIRECTORY_ENTRY_TYPE_SYMLINK = 6
BrickRED.DIRECTORY_ENTRY_TYPE_SOCKET = 7

byte BrickRED.RewindDirectory(int directoryId)¶

Parameter:	directoryId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.CreateDirectory(int nameStringId, long flags, int permissions, long uid, long gid)¶

Parameter:	nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: long, Wertebereich: Siehe Konstanten permissions – Typ: int, Wertebereich: Siehe Konstanten uid – Typ: long, Wertebereich: [0 bis 2³² - 1] gid – Typ: long, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für flags:

BrickRED.DIRECTORY_FLAG_RECURSIVE = 1
BrickRED.DIRECTORY_FLAG_EXCLUSIVE = 2

Für permissions:

BrickRED.FILE_PERMISSION_USER_ALL = 448
BrickRED.FILE_PERMISSION_USER_READ = 256
BrickRED.FILE_PERMISSION_USER_WRITE = 128
BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
BrickRED.FILE_PERMISSION_GROUP_ALL = 56
BrickRED.FILE_PERMISSION_GROUP_READ = 32
BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
BrickRED.FILE_PERMISSION_OTHERS_READ = 4
BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProcesses(int sessionId, out byte errorCode, out int processesListId)¶

Parameter:	sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten processesListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.SpawnProcess(int executableStringId, int argumentsListId, int environmentListId, int workingDirectoryStringId, long uid, long gid, int stdinFileId, int stdoutFileId, int stderrFileId, int sessionId, out byte errorCode, out int processId)¶

Parameter:

Parameter:	executableStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] argumentsListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environmentListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] workingDirectoryStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] uid – Typ: long, Wertebereich: [0 bis 2³² - 1] gid – Typ: long, Wertebereich: [0 bis 2³² - 1] stdinFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdoutFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stderrFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

executableStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
argumentsListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
environmentListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
workingDirectoryStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
uid – Typ: long, Wertebereich: [0 bis 2³² - 1]
gid – Typ: long, Wertebereich: [0 bis 2³² - 1]
stdinFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdoutFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stderrFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Ausgabeparameter:

errorCode – Typ: byte, Wertebereich: Siehe Konstanten
processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.KillProcess(int processId, byte signal)¶

Parameter:	processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] signal – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für signal:

BrickRED.PROCESS_SIGNAL_INTERRUPT = 2
BrickRED.PROCESS_SIGNAL_QUIT = 3
BrickRED.PROCESS_SIGNAL_ABORT = 6
BrickRED.PROCESS_SIGNAL_KILL = 9
BrickRED.PROCESS_SIGNAL_USER1 = 10
BrickRED.PROCESS_SIGNAL_USER2 = 12
BrickRED.PROCESS_SIGNAL_TERMINATE = 15
BrickRED.PROCESS_SIGNAL_CONTINUE = 18
BrickRED.PROCESS_SIGNAL_STOP = 19

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProcessCommand(int processId, int sessionId, out byte errorCode, out int executableStringId, out int argumentsListId, out int environmentListId, out int workingDirectoryStringId)¶

Parameter:	processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten executableStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] argumentsListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environmentListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] workingDirectoryStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProcessIdentity(int processId, out byte errorCode, out long pid, out long uid, out long gid)¶

Parameter:	processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten pid – Typ: long, Wertebereich: [0 bis 2³² - 1] uid – Typ: long, Wertebereich: [0 bis 2³² - 1] gid – Typ: long, Wertebereich: [0 bis 2³² - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProcessStdio(int processId, int sessionId, out byte errorCode, out int stdinFileId, out int stdoutFileId, out int stderrFileId)¶

Parameter:	processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten stdinFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdoutFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stderrFileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProcessState(int processId, out byte errorCode, out byte state, out long timestamp, out byte exitCode)¶

Parameter:	processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten state – Typ: byte, Wertebereich: Siehe Konstanten timestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1] exitCode – Typ: byte, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für state:

BrickRED.PROCESS_STATE_UNKNOWN = 0
BrickRED.PROCESS_STATE_RUNNING = 1
BrickRED.PROCESS_STATE_ERROR = 2
BrickRED.PROCESS_STATE_EXITED = 3
BrickRED.PROCESS_STATE_KILLED = 4
BrickRED.PROCESS_STATE_STOPPED = 5

void BrickRED.GetPrograms(int sessionId, out byte errorCode, out int programsListId)¶

Parameter:	sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten programsListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.DefineProgram(int identifierStringId, int sessionId, out byte errorCode, out int programId)¶

Parameter:	identifierStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.PurgeProgram(int programId, long cookie)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] cookie – Typ: long, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProgramIdentifier(int programId, int sessionId, out byte errorCode, out int identifierStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten identifierStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProgramRootDirectory(int programId, int sessionId, out byte errorCode, out int rootDirectoryStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten rootDirectoryStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.SetProgramCommand(int programId, int executableStringId, int argumentsListId, int environmentListId, int workingDirectoryStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] executableStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] argumentsListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environmentListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] workingDirectoryStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProgramCommand(int programId, int sessionId, out byte errorCode, out int executableStringId, out int argumentsListId, out int environmentListId, out int workingDirectoryStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten executableStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] argumentsListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] environmentListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] workingDirectoryStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.SetProgramStdioRedirection(int programId, byte stdinRedirection, int stdinFileNameStringId, byte stdoutRedirection, int stdoutFileNameStringId, byte stderrRedirection, int stderrFileNameStringId)¶

Parameter:

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdinRedirection – Typ: byte, Wertebereich: Siehe Konstanten stdinFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stdoutRedirection – Typ: byte, Wertebereich: Siehe Konstanten stdoutFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] stderrRedirection – Typ: byte, Wertebereich: Siehe Konstanten stderrFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdinRedirection – Typ: byte, Wertebereich: Siehe Konstanten
stdinFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdoutRedirection – Typ: byte, Wertebereich: Siehe Konstanten
stdoutFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stderrRedirection – Typ: byte, Wertebereich: Siehe Konstanten
stderrFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Rückgabe:

errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für stdinRedirection:

BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stdoutRedirection:

BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stderrRedirection:

BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProgramStdioRedirection(int programId, int sessionId, out byte errorCode, out byte stdinRedirection, out int stdinFileNameStringId, out byte stdoutRedirection, out int stdoutFileNameStringId, out byte stderrRedirection, out int stderrFileNameStringId)¶

Parameter:

programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Ausgabeparameter:

errorCode – Typ: byte, Wertebereich: Siehe Konstanten
stdinRedirection – Typ: byte, Wertebereich: Siehe Konstanten
stdinFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stdoutRedirection – Typ: byte, Wertebereich: Siehe Konstanten
stdoutFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
stderrRedirection – Typ: byte, Wertebereich: Siehe Konstanten
stderrFileNameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für stdinRedirection:

BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stdoutRedirection:

BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stderrRedirection:

BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

byte BrickRED.SetProgramSchedule(int programId, byte startMode, bool continueAfterError, long startInterval, int startFieldsStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] startMode – Typ: byte, Wertebereich: Siehe Konstanten continueAfterError – Typ: bool startInterval – Typ: long, Wertebereich: [0 bis 2³² - 1] startFieldsStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für startMode:

BrickRED.PROGRAM_START_MODE_NEVER = 0
BrickRED.PROGRAM_START_MODE_ALWAYS = 1
BrickRED.PROGRAM_START_MODE_INTERVAL = 2
BrickRED.PROGRAM_START_MODE_CRON = 3

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetProgramSchedule(int programId, int sessionId, out byte errorCode, out byte startMode, out bool continueAfterError, out long startInterval, out int startFieldsStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten startMode – Typ: byte, Wertebereich: Siehe Konstanten continueAfterError – Typ: bool startInterval – Typ: long, Wertebereich: [0 bis 2³² - 1] startFieldsStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für startMode:

BrickRED.PROGRAM_START_MODE_NEVER = 0
BrickRED.PROGRAM_START_MODE_ALWAYS = 1
BrickRED.PROGRAM_START_MODE_INTERVAL = 2
BrickRED.PROGRAM_START_MODE_CRON = 3

void BrickRED.GetProgramSchedulerState(int programId, int sessionId, out byte errorCode, out byte state, out long timestamp, out int messageStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten state – Typ: byte, Wertebereich: Siehe Konstanten timestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1] messageStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für state:

BrickRED.PROGRAM_SCHEDULER_STATE_STOPPED = 0
BrickRED.PROGRAM_SCHEDULER_STATE_RUNNING = 1

byte BrickRED.ContinueProgramSchedule(int programId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.StartProgram(int programId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetLastSpawnedProgramProcess(int programId, int sessionId, out byte errorCode, out int processId, out long timestamp)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] timestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetCustomProgramOptionNames(int programId, int sessionId, out byte errorCode, out int namesListId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten namesListId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.SetCustomProgramOptionValue(int programId, int nameStringId, int valueStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] valueStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetCustomProgramOptionValue(int programId, int nameStringId, int sessionId, out byte errorCode, out int valueStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] sessionId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten valueStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

byte BrickRED.RemoveCustomProgramOption(int programId, int nameStringId)¶

Parameter:	programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] nameStringId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	errorCode – Typ: byte, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

void BrickRED.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ['0' bis '8']
hardwareVersion – Typ: byte[], Länge: 3

0: major – Typ: byte, Wertebereich: [0 bis 255]
1: minor – Typ: byte, Wertebereich: [0 bis 255]
2: revision – Typ: byte, Wertebereich: [0 bis 255]

firmwareVersion – Typ: byte[], Länge: 3

0: major – Typ: byte, Wertebereich: [0 bis 255]
1: minor – Typ: byte, Wertebereich: [0 bis 255]
2: revision – Typ: byte, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickRED sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

red.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

event BrickRED.AsyncFileReadCallback(BrickRED sender, int fileId, byte errorCode, byte[] buffer, byte lengthRead)¶

Callback-Parameter:	sender – Typ: BrickRED fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] errorCode – Typ: byte, Wertebereich: Siehe Konstanten buffer – Typ: byte[], Länge: 60, Wertebereich: [0 bis 255] lengthRead – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

event BrickRED.AsyncFileWriteCallback(BrickRED sender, int fileId, byte errorCode, byte lengthWritten)¶

Callback-Parameter:	sender – Typ: BrickRED fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] errorCode – Typ: byte, Wertebereich: Siehe Konstanten lengthWritten – Typ: byte, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für errorCode:

BrickRED.ERROR_CODE_SUCCESS = 0
BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
BrickRED.ERROR_CODE_INVALID_OPERATION = 2
BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
BrickRED.ERROR_CODE_NO_MORE_DATA = 10
BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
BrickRED.ERROR_CODE_ACCESS_DENIED = 121
BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
BrickRED.ERROR_CODE_INTERRUPTED = 134
BrickRED.ERROR_CODE_IS_DIRECTORY = 135
BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
BrickRED.ERROR_CODE_WOULD_BLOCK = 137
BrickRED.ERROR_CODE_OVERFLOW = 138
BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
BrickRED.ERROR_CODE_INVALID_SEEK = 142
BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

event BrickRED.FileEventsOccurredCallback(BrickRED sender, int fileId, int events)¶

Callback-Parameter:	sender – Typ: BrickRED fileId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] events – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für events:

BrickRED.FILE_EVENT_READABLE = 1
BrickRED.FILE_EVENT_WRITABLE = 2

event BrickRED.ProcessStateChangedCallback(BrickRED sender, int processId, byte state, long timestamp, byte exitCode)¶

Callback-Parameter:	sender – Typ: BrickRED processId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] state – Typ: byte, Wertebereich: Siehe Konstanten timestamp – Typ: long, Wertebereich: [0 bis 2⁶⁴ - 1] exitCode – Typ: byte, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state:

BrickRED.PROCESS_STATE_UNKNOWN = 0
BrickRED.PROCESS_STATE_RUNNING = 1
BrickRED.PROCESS_STATE_ERROR = 2
BrickRED.PROCESS_STATE_EXITED = 3
BrickRED.PROCESS_STATE_KILLED = 4
BrickRED.PROCESS_STATE_STOPPED = 5

event BrickRED.ProgramSchedulerStateChangedCallback(BrickRED sender, int programId)¶

Callback-Parameter:	sender – Typ: BrickRED programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

event BrickRED.ProgramProcessSpawnedCallback(BrickRED sender, int programId)¶

Callback-Parameter:	sender – Typ: BrickRED programId – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

byte[] BrickRED.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickRED.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

BrickRED.FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
BrickRED.FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
BrickRED.FUNCTION_READ_FILE_ASYNC = 21
BrickRED.FUNCTION_WRITE_FILE_UNCHECKED = 24
BrickRED.FUNCTION_WRITE_FILE_ASYNC = 25

void BrickRED.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

BrickRED.FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
BrickRED.FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
BrickRED.FUNCTION_READ_FILE_ASYNC = 21
BrickRED.FUNCTION_WRITE_FILE_UNCHECKED = 24
BrickRED.FUNCTION_WRITE_FILE_ASYNC = 25

void BrickRED.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

int BrickRED.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen RED Brick zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickRED.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RED Brick dar.