Software / API Bindings / Visual Basic .NET / API Reference and Examples / Bricks / RED Brick

Visual Basic .NET - RED Brick¶

This is the description of the Visual Basic .NET API bindings for the RED Brick. General information and technical specifications for the RED Brick are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

API¶

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Note

The API documentation for the RED Brick is currently incomplete.

The RED Brick API is meant to be used by the Brick Viewer to implement the offered functionality (getting status information, managing programs etc.). Normal users will not need to use this API, it may only be interesting for power users.

FIXME: explain sessions

The RED Brick API operates on reference counted objects (strings, lists, files, directories, processes and programs) that are identified by their 16bit object ID. Functions that allocate or return an object ID (e.g. AllocateString() and GetNextDirectoryEntry()) increase the reference count of the returned object. If the object is no longer needed then ReleaseObject() has to be called to decrease the reference count of the object again. In contrast to allocation and getter functions, the reference count for an object returned by a callback is not increased and ReleaseObject() must not be called for such an object in response to a callback.

There are functions (e.g. GetFileInfo()) that only return valid objects under certain conditions. This conditions are documented for the specific functions. For invalid objects ReleaseObject() must not be called.

There are also function (e.g. SetProgramStdioRedirection()) that have conditionally unused object parameters. Under which conditions an object parameter is unused is documented for the specific functions. For unused object parameters 0 has to be passed as object ID.

The RED Brick API is more complex then the typical Brick API and requires more elaborate error reporting than the TCP/IP protocol can provide with its 2bit error code. Therefore, almost all functions of the RED Brick API return an 8bit error code. Possible error codes are:

Success = 0
UnknownError = 1
InvalidOperation = 2
OperationAborted = 3
InternalError = 4
UnknownSessionID = 5
NoFreeSessionID = 6
UnknownObjectID = 7
NoFreeObjectID = 8
ObjectIsLocked = 9
NoMoreData = 10
WrongListItemType = 11
ProgramIsPurged = 12
InvalidParameter = 128 (EINVAL)
NoFreeMemory = 129 (ENOMEM)
NoFreeSpace = 130 (ENOSPC)
AccessDenied = 131 (EACCES)
AlreadyExists = 132 (EEXIST)
DoesNotExist = 133 (ENOENT)
Interrupted = 134 (EINTR)
IsDirectory = 135 (EISDIR)
NotADirectory = 136 (ENOTDIR)
WouldBlock = 137 (EWOULDBLOCK)
Overflow = 138 (EOVERFLOW)
BadFileDescriptor = 139 (EBADF)
OutOfRange = 140 (ERANGE)
NameTooLong = 141 (ENAMETOOLONG)
InvalidSeek = 142 (ESPIPE)
NotSupported = 143 (ENOTSUP)
TooManyOpenFiles = 144 (EMFILE)

If a function returns an error code other than Success then its other return values (if any) are invalid and must not be used.

The error code InvalidOperation is returned if the requested operation cannot be performed because the current state of the object does not allow it. For example, trying to append an item to a full list object or trying to undefine an already undefined program.

The error code NotSupported is returned if the requested operation can never be performed. For example, trying to append a list object to itself, trying to get the name of a file object with type Pipe or trying to create a directory non-recursively with more than the last part of the directory name referring to non-existing directories.

String objects store UTF-8 encoded data.

Advanced Functions¶

Sub BrickRED.CreateSession(ByVal lifetime As Long, ByRef errorCode As Byte, ByRef sessionId As Integer)¶

Parameters:	lifetime – Type: Long, Range: [0 to 2³² - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Function BrickRED.ExpireSession(ByVal sessionId As Integer) As Byte¶

Parameters:	sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Sub BrickRED.ExpireSessionUnchecked(ByVal sessionId As Integer)¶

Parameters:	sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Function BrickRED.KeepSessionAlive(ByVal sessionId As Integer, ByVal lifetime As Long) As Byte¶

Parameters:	sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1] lifetime – Type: Long, Range: [0 to 2³² - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Function BrickRED.ReleaseObject(ByVal objectId As Integer, ByVal sessionId As Integer) As Byte¶

Parameters:	objectId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

Decreases the reference count of an object by one and returns the resulting error code. If the reference count reaches zero the object gets destroyed.

The following constants are available for this function:

For 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

Sub BrickRED.ReleaseObjectUnchecked(ByVal objectId As Integer, ByVal sessionId As Integer)¶

Parameters:	objectId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Sub BrickRED.AllocateString(ByVal lengthToReserve As Long, ByVal buffer As String, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef stringId As Integer)¶

Parameters:	lengthToReserve – Type: Long, Unit: 1 B, Range: [0 to 2³² - 1] buffer – Type: String, Length: up to 58 sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants stringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Allocates a new string object, reserves length_to_reserve bytes memory for it and sets up to the first 60 bytes. Set length_to_reserve to the length of the string that should be stored in the string object.

Returns the object ID of the new string object and the resulting error code.

The following constants are available for this function:

For 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

Function BrickRED.TruncateString(ByVal stringId As Integer, ByVal length As Long) As Byte¶

Parameters:	stringId – Type: Integer, Range: [0 to 2¹⁶ - 1] length – Type: Long, Unit: 1 B, Range: [0 to 2³² - 1]
Returns:	errorCode – Type: Byte, Range: See constants

Truncates a string object to length bytes and returns the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetStringLength(ByVal stringId As Integer, ByRef errorCode As Byte, ByRef length As Long)¶

Parameters:	stringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants length – Type: Long, Unit: 1 B, Range: [0 to 2³² - 1]

Returns the length of a string object and the resulting error code.

The following constants are available for this function:

For 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

Function BrickRED.SetStringChunk(ByVal stringId As Integer, ByVal offset As Long, ByVal buffer As String) As Byte¶

Parameters:	stringId – Type: Integer, Range: [0 to 2¹⁶ - 1] offset – Type: Long, Unit: 1 B, Range: [0 to 2³² - 1] buffer – Type: String, Length: up to 58
Returns:	errorCode – Type: Byte, Range: See constants

Sets a chunk of up to 58 bytes in a string object beginning at offset.

Returns the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetStringChunk(ByVal stringId As Integer, ByVal offset As Long, ByRef errorCode As Byte, ByRef buffer As String)¶

Parameters:	stringId – Type: Integer, Range: [0 to 2¹⁶ - 1] offset – Type: Long, Unit: 1 B, Range: [0 to 2³² - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants buffer – Type: String, Length: up to 63

Returns a chunk up to 63 bytes from a string object beginning at offset and returns the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.AllocateList(ByVal lengthToReserve As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef listId As Integer)¶

Parameters:	lengthToReserve – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants listId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Allocates a new list object and reserves memory for length_to_reserve items. Set length_to_reserve to the number of items that should be stored in the list object.

Returns the object ID of the new list object and the resulting error code.

When a list object gets destroyed then the reference count of each object in the list object is decreased by one.

The following constants are available for this function:

For 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

Sub BrickRED.GetListLength(ByVal listId As Integer, ByRef errorCode As Byte, ByRef length As Integer)¶

Parameters:	listId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants length – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the length of a list object in items and the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetListItem(ByVal listId As Integer, ByVal index As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef itemObjectId As Integer, ByRef type As Byte)¶

Parameters:	listId – Type: Integer, Range: [0 to 2¹⁶ - 1] index – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants itemObjectId – Type: Integer, Range: [0 to 2¹⁶ - 1] type – Type: Byte, Range: See constants

Returns the object ID and type of the object stored at index in a list object and returns the resulting error code.

Possible object types are:

String = 0
List = 1
File = 2
Directory = 3
Process = 4
Program = 5

The following constants are available for this function:

For 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

For 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

Function BrickRED.AppendToList(ByVal listId As Integer, ByVal itemObjectId As Integer) As Byte¶

Parameters:	listId – Type: Integer, Range: [0 to 2¹⁶ - 1] itemObjectId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

Appends an object to a list object and increases the reference count of the appended object by one.

Returns the resulting error code.

The following constants are available for this function:

For 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

Function BrickRED.RemoveFromList(ByVal listId As Integer, ByVal index As Integer) As Byte¶

Parameters:	listId – Type: Integer, Range: [0 to 2¹⁶ - 1] index – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

Removes the object stored at index from a list object and decreases the reference count of the removed object by one.

Returns the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.OpenFile(ByVal nameStringId As Integer, ByVal flags As Long, ByVal permissions As Integer, ByVal uid As Long, ByVal gid As Long, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef fileId As Integer)¶

Parameters:	nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] flags – Type: Long, Range: See constants permissions – Type: Integer, Range: See constants uid – Type: Long, Range: [0 to 2³² - 1] gid – Type: Long, Range: [0 to 2³² - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants fileId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Opens an existing file or creates a new file and allocates a new file object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the file object gets destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the file object holds a reference to it.

The flags parameter takes a ORed combination of the following possible file flags (in hexadecimal notation):

ReadOnly = 0x0001 (O_RDONLY)
WriteOnly = 0x0002 (O_WRONLY)
ReadWrite = 0x0004 (O_RDWR)
Append = 0x0008 (O_APPEND)
Create = 0x0010 (O_CREAT)
Exclusive = 0x0020 (O_EXCL)
NonBlocking = 0x0040 (O_NONBLOCK)
Truncate = 0x0080 (O_TRUNC)
Temporary = 0x0100
Replace = 0x0200

FIXME: explain Temporary and Replace flag

The permissions parameter takes a ORed combination of the following possible file permissions (in octal notation) that match the common UNIX permission bits:

UserRead = 00400
UserWrite = 00200
UserExecute = 00100
GroupRead = 00040
GroupWrite = 00020
GroupExecute = 00010
OthersRead = 00004
OthersWrite = 00002
OthersExecute = 00001

Returns the object ID of the new file object and the resulting error code.

The following constants are available for this function:

For 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

For 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

For 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

Sub BrickRED.CreatePipe(ByVal flags As Long, ByVal length As Long, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef fileId As Integer)¶

Parameters:	flags – Type: Long, Range: See constants length – Type: Long, Unit: 1 B, Range: [0 to 2⁶⁴ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants fileId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Creates a new pipe and allocates a new file object for it.

The flags parameter takes a ORed combination of the following possible pipe flags (in hexadecimal notation):

NonBlockingRead = 0x0001
NonBlockingWrite = 0x0002

The length of the pipe buffer can be specified with the length parameter in bytes. If length is set to zero, then the default pipe buffer length is used.

Returns the object ID of the new file object and the resulting error code.

The following constants are available for this function:

For flags:

BrickRED.PIPE_FLAG_NON_BLOCKING_READ = 1
BrickRED.PIPE_FLAG_NON_BLOCKING_WRITE = 2

For 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

Sub BrickRED.GetFileInfo(ByVal fileId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef type As Byte, ByRef nameStringId As Integer, ByRef flags As Long, ByRef permissions As Integer, ByRef uid As Long, ByRef gid As Long, ByRef length As Long, ByRef accessTimestamp As Long, ByRef modificationTimestamp As Long, ByRef statusChangeTimestamp As Long)¶

Parameters:

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants type – Type: Byte, Range: See constants nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] flags – Type: Long, Range: See constants permissions – Type: Integer, Range: See constants uid – Type: Long, Range: [0 to 2³² - 1] gid – Type: Long, Range: [0 to 2³² - 1] length – Type: Long, Unit: 1 B, Range: [0 to 2⁶⁴ - 1] accessTimestamp – Type: Long, Range: [0 to 2⁶⁴ - 1] modificationTimestamp – Type: Long, Range: [0 to 2⁶⁴ - 1] statusChangeTimestamp – Type: Long, Range: [0 to 2⁶⁴ - 1]

fileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Output Parameters:

errorCode – Type: Byte, Range: See constants
type – Type: Byte, Range: See constants
nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
flags – Type: Long, Range: See constants
permissions – Type: Integer, Range: See constants
uid – Type: Long, Range: [0 to 2³² - 1]
gid – Type: Long, Range: [0 to 2³² - 1]
length – Type: Long, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]
accessTimestamp – Type: Long, Range: [0 to 2⁶⁴ - 1]
modificationTimestamp – Type: Long, Range: [0 to 2⁶⁴ - 1]
statusChangeTimestamp – Type: Long, Range: [0 to 2⁶⁴ - 1]

Returns various information about a file and the resulting error code.

Possible file types are:

Unknown = 0
Regular = 1
Directory = 2
Character = 3
Block = 4
FIFO = 5
Symlink = 6
Socket = 7
Pipe = 8

If the file type is Pipe then the returned name string object is invalid, because a pipe has no name. Otherwise the returned name string object was used to open or create the file object, as passed to OpenFile().

The returned flags were used to open or create the file object, as passed to OpenFile() or CreatePipe(). See the respective function for a list of possible file and pipe flags.

FIXME: everything except flags and length is invalid if file type is Pipe

The following constants are available for this function:

For 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

For 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

For 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

For 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

Sub BrickRED.ReadFile(ByVal fileId As Integer, ByVal lengthToRead As Byte, ByRef errorCode As Byte, ByRef buffer() As Byte, ByRef lengthRead As Byte)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] lengthToRead – Type: Byte, Unit: 1 B, Range: [0 to 255]
Output Parameters:	errorCode – Type: Byte, Range: See constants buffer – Type: Byte Array, Length: 62, Range: [0 to 255] lengthRead – Type: Byte, Unit: 1 B, Range: [0 to 255]

Reads up to 62 bytes from a file object.

Returns the bytes read, the actual number of bytes read and the resulting error code.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are returned.

If the file object was created by OpenFile() without the NonBlocking flag or by CreatePipe() without the NonBlockingRead flag then the error code NotSupported is returned.

The following constants are available for this function:

For 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

Sub BrickRED.ReadFileAsync(ByVal fileId As Integer, ByVal lengthToRead As Long)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] lengthToRead – Type: Long, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]

Reads up to 2⁶³ - 1 bytes from a file object asynchronously.

Reports the bytes read (in 60 byte chunks), the actual number of bytes read and the resulting error code via the AsyncFileReadCallback callback.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are reported.

If the file object was created by OpenFile() without the NonBlocking flag or by CreatePipe() without the NonBlockingRead flag then the error code NotSupported is reported via the AsyncFileReadCallback callback.

Function BrickRED.AbortAsyncFileRead(ByVal fileId As Integer) As Byte¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

Aborts a ReadFileAsync() operation in progress.

Returns the resulting error code.

On success the AsyncFileReadCallback callback will report OperationAborted.

The following constants are available for this function:

For 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

Sub BrickRED.WriteFile(ByVal fileId As Integer, ByVal buffer() As Byte, ByVal lengthToWrite As Byte, ByRef errorCode As Byte, ByRef lengthWritten As Byte)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] buffer – Type: Byte Array, Length: 61, Range: [0 to 255] lengthToWrite – Type: Byte, Unit: 1 B, Range: [0 to 255]
Output Parameters:	errorCode – Type: Byte, Range: See constants lengthWritten – Type: Byte, Unit: 1 B, Range: [0 to 255]

Writes up to 61 bytes to a file object.

Returns the actual number of bytes written and the resulting error code.

If the file object was created by OpenFile() without the NonBlocking flag or by CreatePipe() without the NonBlockingWrite flag then the error code NotSupported is returned.

The following constants are available for this function:

For 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

Sub BrickRED.WriteFileUnchecked(ByVal fileId As Integer, ByVal buffer() As Byte, ByVal lengthToWrite As Byte)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] buffer – Type: Byte Array, Length: 61, Range: [0 to 255] lengthToWrite – Type: Byte, Unit: 1 B, Range: [0 to 255]

Writes up to 61 bytes to a file object.

Does neither report the actual number of bytes written nor the resulting error code.

If the file object was created by OpenFile() without the NonBlocking flag or by CreatePipe() without the NonBlockingWrite flag then the write operation will fail silently.

Sub BrickRED.WriteFileAsync(ByVal fileId As Integer, ByVal buffer() As Byte, ByVal lengthToWrite As Byte)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] buffer – Type: Byte Array, Length: 61, Range: [0 to 255] lengthToWrite – Type: Byte, Unit: 1 B, Range: [0 to 255]

Writes up to 61 bytes to a file object.

Reports the actual number of bytes written and the resulting error code via the AsyncFileWriteCallback callback.

If the file object was created by OpenFile() without the NonBlocking flag or by CreatePipe() without the NonBlockingWrite flag then the error code NotSupported is reported via the AsyncFileWriteCallback callback.

Sub BrickRED.SetFilePosition(ByVal fileId As Integer, ByVal offset As Long, ByVal origin As Byte, ByRef errorCode As Byte, ByRef position As Long)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] offset – Type: Long, Unit: 1 B, Range: [-2⁶³ to 2⁶³ - 1] origin – Type: Byte, Range: See constants
Output Parameters:	errorCode – Type: Byte, Range: See constants position – Type: Long, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]

Set the current seek position of a file object relative to origin.

Possible file origins are:

Beginning = 0
Current = 1
End = 2

Returns the resulting absolute seek position and error code.

If the file object was created by CreatePipe() then it has no seek position and the error code InvalidSeek is returned.

The following constants are available for this function:

For origin:

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

For 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

Sub BrickRED.GetFilePosition(ByVal fileId As Integer, ByRef errorCode As Byte, ByRef position As Long)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants position – Type: Long, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]

Returns the current seek position of a file object and returns the resulting error code.

If the file object was created by CreatePipe() then it has no seek position and the error code InvalidSeek is returned.

The following constants are available for this function:

For 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

Function BrickRED.SetFileEvents(ByVal fileId As Integer, ByVal events As Integer) As Byte¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] events – Type: Integer, Range: See constants
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For events:

BrickRED.FILE_EVENT_READABLE = 1
BrickRED.FILE_EVENT_WRITABLE = 2

For 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

Sub BrickRED.GetFileEvents(ByVal fileId As Integer, ByRef errorCode As Byte, ByRef events As Integer)¶

Parameters:	fileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants events – Type: Integer, Range: See constants

The following constants are available for this function:

For 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

For events:

BrickRED.FILE_EVENT_READABLE = 1
BrickRED.FILE_EVENT_WRITABLE = 2

Sub BrickRED.OpenDirectory(ByVal nameStringId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef directoryId As Integer)¶

Parameters:	nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants directoryId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Opens an existing directory and allocates a new directory object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the directory object is destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the directory object holds a reference to it.

Returns the object ID of the new directory object and the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetDirectoryName(ByVal directoryId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef nameStringId As Integer)¶

Parameters:	directoryId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the name of a directory object, as passed to OpenDirectory(), and the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetNextDirectoryEntry(ByVal directoryId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef nameStringId As Integer, ByRef type As Byte)¶

Parameters:	directoryId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] type – Type: Byte, Range: See constants

Returns the next entry in a directory object and the resulting error code.

If there is not next entry then error code NoMoreData is returned. To rewind a directory object call RewindDirectory().

Possible directory entry types are:

Unknown = 0
Regular = 1
Directory = 2
Character = 3
Block = 4
FIFO = 5
Symlink = 6
Socket = 7

The following constants are available for this function:

For 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

For 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

Function BrickRED.RewindDirectory(ByVal directoryId As Integer) As Byte¶

Parameters:	directoryId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

Rewinds a directory object and returns the resulting error code.

The following constants are available for this function:

For 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

Function BrickRED.CreateDirectory(ByVal nameStringId As Integer, ByVal flags As Long, ByVal permissions As Integer, ByVal uid As Long, ByVal gid As Long) As Byte¶

Parameters:	nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] flags – Type: Long, Range: See constants permissions – Type: Integer, Range: See constants uid – Type: Long, Range: [0 to 2³² - 1] gid – Type: Long, Range: [0 to 2³² - 1]
Returns:	errorCode – Type: Byte, Range: See constants

FIXME: name has to be absolute

The following constants are available for this function:

For flags:

BrickRED.DIRECTORY_FLAG_RECURSIVE = 1
BrickRED.DIRECTORY_FLAG_EXCLUSIVE = 2

For 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

For 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

Sub BrickRED.GetProcesses(ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef processesListId As Integer)¶

Parameters:	sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants processesListId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Sub BrickRED.SpawnProcess(ByVal executableStringId As Integer, ByVal argumentsListId As Integer, ByVal environmentListId As Integer, ByVal workingDirectoryStringId As Integer, ByVal uid As Long, ByVal gid As Long, ByVal stdinFileId As Integer, ByVal stdoutFileId As Integer, ByVal stderrFileId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef processId As Integer)¶

Parameters:

Parameters:	executableStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] argumentsListId – Type: Integer, Range: [0 to 2¹⁶ - 1] environmentListId – Type: Integer, Range: [0 to 2¹⁶ - 1] workingDirectoryStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] uid – Type: Long, Range: [0 to 2³² - 1] gid – Type: Long, Range: [0 to 2³² - 1] stdinFileId – Type: Integer, Range: [0 to 2¹⁶ - 1] stdoutFileId – Type: Integer, Range: [0 to 2¹⁶ - 1] stderrFileId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants processId – Type: Integer, Range: [0 to 2¹⁶ - 1]

executableStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
argumentsListId – Type: Integer, Range: [0 to 2¹⁶ - 1]
environmentListId – Type: Integer, Range: [0 to 2¹⁶ - 1]
workingDirectoryStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
uid – Type: Long, Range: [0 to 2³² - 1]
gid – Type: Long, Range: [0 to 2³² - 1]
stdinFileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stdoutFileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stderrFileId – Type: Integer, Range: [0 to 2¹⁶ - 1]
sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Output Parameters:

errorCode – Type: Byte, Range: See constants
processId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Function BrickRED.KillProcess(ByVal processId As Integer, ByVal signal As Byte) As Byte¶

Parameters:	processId – Type: Integer, Range: [0 to 2¹⁶ - 1] signal – Type: Byte, Range: See constants
Returns:	errorCode – Type: Byte, Range: See constants

Sends a UNIX signal to a process object and returns the resulting error code.

Possible UNIX signals are:

Interrupt = 2
Quit = 3
Abort = 6
Kill = 9
User1 = 10
User2 = 12
Terminate = 15
Continue = 18
Stop = 19

The following constants are available for this function:

For 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

For 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

Sub BrickRED.GetProcessCommand(ByVal processId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef executableStringId As Integer, ByRef argumentsListId As Integer, ByRef environmentListId As Integer, ByRef workingDirectoryStringId As Integer)¶

Parameters:	processId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants executableStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] argumentsListId – Type: Integer, Range: [0 to 2¹⁶ - 1] environmentListId – Type: Integer, Range: [0 to 2¹⁶ - 1] workingDirectoryStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the executable, arguments, environment and working directory used to spawn a process object, as passed to SpawnProcess(), and the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetProcessIdentity(ByVal processId As Integer, ByRef errorCode As Byte, ByRef pid As Long, ByRef uid As Long, ByRef gid As Long)¶

Parameters:	processId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants pid – Type: Long, Range: [0 to 2³² - 1] uid – Type: Long, Range: [0 to 2³² - 1] gid – Type: Long, Range: [0 to 2³² - 1]

Returns the process ID and the user and group ID used to spawn a process object, as passed to SpawnProcess(), and the resulting error code.

The process ID is only valid if the state is Running or Stopped, see GetProcessState().

The following constants are available for this function:

For 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

Sub BrickRED.GetProcessStdio(ByVal processId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef stdinFileId As Integer, ByRef stdoutFileId As Integer, ByRef stderrFileId As Integer)¶

Parameters:	processId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants stdinFileId – Type: Integer, Range: [0 to 2¹⁶ - 1] stdoutFileId – Type: Integer, Range: [0 to 2¹⁶ - 1] stderrFileId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the stdin, stdout and stderr files used to spawn a process object, as passed to SpawnProcess(), and the resulting error code.

The following constants are available for this function:

For 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

Sub BrickRED.GetProcessState(ByVal processId As Integer, ByRef errorCode As Byte, ByRef state As Byte, ByRef timestamp As Long, ByRef exitCode As Byte)¶

Parameters:	processId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants state – Type: Byte, Range: See constants timestamp – Type: Long, Range: [0 to 2⁶⁴ - 1] exitCode – Type: Byte, Range: [0 to 255]

Returns the current state, timestamp and exit code of a process object, and the resulting error code.

Possible process states are:

Unknown = 0
Running = 1
Error = 2
Exited = 3
Killed = 4
Stopped = 5

The timestamp represents the UNIX time since when the process is in its current state.

The exit code is only valid if the state is Error, Exited, Killed or Stopped and has different meanings depending on the state:

Error: error code for error occurred while spawning the process (see below)
Exited: exit status of the process
Killed: UNIX signal number used to kill the process
Stopped: UNIX signal number used to stop the process

Possible exit/error codes in Error state are:

InternalError = 125
CannotExecute = 126
DoesNotExist = 127

The CannotExecute error can be caused by the executable being opened for writing.

The following constants are available for this function:

For 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

For 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

Sub BrickRED.GetPrograms(ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef programsListId As Integer)¶

Parameters:	sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants programsListId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Sub BrickRED.DefineProgram(ByVal identifierStringId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef programId As Integer)¶

Parameters:	identifierStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants programId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Function BrickRED.PurgeProgram(ByVal programId As Integer, ByVal cookie As Long) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] cookie – Type: Long, Range: [0 to 2³² - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Sub BrickRED.GetProgramIdentifier(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef identifierStringId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants identifierStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Sub BrickRED.GetProgramRootDirectory(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef rootDirectoryStringId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants rootDirectoryStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

FIXME: root directory is absolute: <home>/programs/<identifier>

The following constants are available for this function:

For 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

Function BrickRED.SetProgramCommand(ByVal programId As Integer, ByVal executableStringId As Integer, ByVal argumentsListId As Integer, ByVal environmentListId As Integer, ByVal workingDirectoryStringId As Integer) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] executableStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] argumentsListId – Type: Integer, Range: [0 to 2¹⁶ - 1] environmentListId – Type: Integer, Range: [0 to 2¹⁶ - 1] workingDirectoryStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

FIXME: working directory is relative to <home>/programs/<identifier>/bin

The following constants are available for this function:

For 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

Sub BrickRED.GetProgramCommand(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef executableStringId As Integer, ByRef argumentsListId As Integer, ByRef environmentListId As Integer, ByRef workingDirectoryStringId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants executableStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] argumentsListId – Type: Integer, Range: [0 to 2¹⁶ - 1] environmentListId – Type: Integer, Range: [0 to 2¹⁶ - 1] workingDirectoryStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

FIXME: working directory is relative to <home>/programs/<identifier>/bin

The following constants are available for this function:

For 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

Function BrickRED.SetProgramStdioRedirection(ByVal programId As Integer, ByVal stdinRedirection As Byte, ByVal stdinFileNameStringId As Integer, ByVal stdoutRedirection As Byte, ByVal stdoutFileNameStringId As Integer, ByVal stderrRedirection As Byte, ByVal stderrFileNameStringId As Integer) As Byte¶

Parameters:

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] stdinRedirection – Type: Byte, Range: See constants stdinFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] stdoutRedirection – Type: Byte, Range: See constants stdoutFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] stderrRedirection – Type: Byte, Range: See constants stderrFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

programId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stdinRedirection – Type: Byte, Range: See constants
stdinFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stdoutRedirection – Type: Byte, Range: See constants
stdoutFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stderrRedirection – Type: Byte, Range: See constants
stderrFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns:

errorCode – Type: Byte, Range: See constants

FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

The following constants are available for this function:

For 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

For 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

For 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

For 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

Sub BrickRED.GetProgramStdioRedirection(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef stdinRedirection As Byte, ByRef stdinFileNameStringId As Integer, ByRef stdoutRedirection As Byte, ByRef stdoutFileNameStringId As Integer, ByRef stderrRedirection As Byte, ByRef stderrFileNameStringId As Integer)¶

Parameters:

programId – Type: Integer, Range: [0 to 2¹⁶ - 1]
sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Output Parameters:

errorCode – Type: Byte, Range: See constants
stdinRedirection – Type: Byte, Range: See constants
stdinFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stdoutRedirection – Type: Byte, Range: See constants
stdoutFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
stderrRedirection – Type: Byte, Range: See constants
stderrFileNameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

The following constants are available for this function:

For 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

For 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

For 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

For 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

Function BrickRED.SetProgramSchedule(ByVal programId As Integer, ByVal startMode As Byte, ByVal continueAfterError As Boolean, ByVal startInterval As Long, ByVal startFieldsStringId As Integer) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] startMode – Type: Byte, Range: See constants continueAfterError – Type: Boolean startInterval – Type: Long, Range: [0 to 2³² - 1] startFieldsStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

For 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

Sub BrickRED.GetProgramSchedule(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef startMode As Byte, ByRef continueAfterError As Boolean, ByRef startInterval As Long, ByRef startFieldsStringId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants startMode – Type: Byte, Range: See constants continueAfterError – Type: Boolean startInterval – Type: Long, Range: [0 to 2³² - 1] startFieldsStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

For 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

Sub BrickRED.GetProgramSchedulerState(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef state As Byte, ByRef timestamp As Long, ByRef messageStringId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants state – Type: Byte, Range: See constants timestamp – Type: Long, Range: [0 to 2⁶⁴ - 1] messageStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

FIXME: message is currently valid in error-occurred state only

The following constants are available for this function:

For 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

For state:

BrickRED.PROGRAM_SCHEDULER_STATE_STOPPED = 0
BrickRED.PROGRAM_SCHEDULER_STATE_RUNNING = 1

Function BrickRED.ContinueProgramSchedule(ByVal programId As Integer) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Function BrickRED.StartProgram(ByVal programId As Integer) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Sub BrickRED.GetLastSpawnedProgramProcess(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef processId As Integer, ByRef timestamp As Long)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants processId – Type: Integer, Range: [0 to 2¹⁶ - 1] timestamp – Type: Long, Range: [0 to 2⁶⁴ - 1]

The following constants are available for this function:

For 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

Sub BrickRED.GetCustomProgramOptionNames(ByVal programId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef namesListId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants namesListId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Function BrickRED.SetCustomProgramOptionValue(ByVal programId As Integer, ByVal nameStringId As Integer, ByVal valueStringId As Integer) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] valueStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Sub BrickRED.GetCustomProgramOptionValue(ByVal programId As Integer, ByVal nameStringId As Integer, ByVal sessionId As Integer, ByRef errorCode As Byte, ByRef valueStringId As Integer)¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1] sessionId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Output Parameters:	errorCode – Type: Byte, Range: See constants valueStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]

The following constants are available for this function:

For 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

Function BrickRED.RemoveCustomProgramOption(ByVal programId As Integer, ByVal nameStringId As Integer) As Byte¶

Parameters:	programId – Type: Integer, Range: [0 to 2¹⁶ - 1] nameStringId – Type: Integer, Range: [0 to 2¹⁶ - 1]
Returns:	errorCode – Type: Byte, Range: See constants

The following constants are available for this function:

For 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

Sub BrickRED.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Output Parameters:

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: Char, Range: ["0"C to "8"C]
hardwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

firmwareVersion – Type: Byte Array, Length: 3

0: major – Type: Byte, Range: [0 to 255]
1: minor – Type: Byte, Range: [0 to 255]
2: revision – Type: Byte, Range: [0 to 255]

deviceIdentifier – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here. There is also a constant for the device identifier of this Brick.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickRED, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler red.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

Event BrickRED.AsyncFileReadCallback(ByVal sender As BrickRED, ByVal fileId As Integer, ByVal errorCode As Byte, ByVal buffer() As Byte, ByVal lengthRead As Byte)¶

Callback Parameters:	sender – Type: BrickRED fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] errorCode – Type: Byte, Range: See constants buffer – Type: Byte Array, Length: 60, Range: [0 to 255] lengthRead – Type: Byte, Unit: 1 B, Range: [0 to 255]

This callback reports the result of a call to the ReadFileAsync() function.

The following constants are available for this function:

For 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(ByVal sender As BrickRED, ByVal fileId As Integer, ByVal errorCode As Byte, ByVal lengthWritten As Byte)¶

Callback Parameters:	sender – Type: BrickRED fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] errorCode – Type: Byte, Range: See constants lengthWritten – Type: Byte, Unit: 1 B, Range: [0 to 255]

This callback reports the result of a call to the WriteFileAsync() function.

The following constants are available for this function:

For 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(ByVal sender As BrickRED, ByVal fileId As Integer, ByVal events As Integer)¶

Callback Parameters:	sender – Type: BrickRED fileId – Type: Integer, Range: [0 to 2¹⁶ - 1] events – Type: Integer, Range: See constants

The following constants are available for this function:

For events:

BrickRED.FILE_EVENT_READABLE = 1
BrickRED.FILE_EVENT_WRITABLE = 2

Event BrickRED.ProcessStateChangedCallback(ByVal sender As BrickRED, ByVal processId As Integer, ByVal state As Byte, ByVal timestamp As Long, ByVal exitCode As Byte)¶

Callback Parameters:	sender – Type: BrickRED processId – Type: Integer, Range: [0 to 2¹⁶ - 1] state – Type: Byte, Range: See constants timestamp – Type: Long, Range: [0 to 2⁶⁴ - 1] exitCode – Type: Byte, Range: [0 to 255]

The following constants are available for this function:

For 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(ByVal sender As BrickRED, ByVal programId As Integer)¶

Callback Parameters:	sender – Type: BrickRED programId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Event BrickRED.ProgramProcessSpawnedCallback(ByVal sender As BrickRED, ByVal programId As Integer)¶

Callback Parameters:	sender – Type: BrickRED programId – Type: Integer, Range: [0 to 2¹⁶ - 1]

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

Function BrickRED.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

Function BrickRED.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	responseExpected – Type: Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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

Sub BrickRED.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameters:	functionId – Type: Byte, Range: See constants responseExpected – Type: Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For 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

Sub BrickRED.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

Const BrickRED.DEVICE_IDENTIFIER¶

This constant is used to identify a RED Brick.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Const BrickRED.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a RED Brick.