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

C/C++ - RED Brick¶

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

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

E_OK = 0
E_TIMEOUT = -1
E_NO_STREAM_SOCKET = -2
E_HOSTNAME_INVALID = -3
E_NO_CONNECT = -4
E_NO_THREAD = -5
E_NOT_ADDED = -6 (seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
E_ALREADY_CONNECTED = -7
E_NOT_CONNECTED = -8
E_INVALID_PARAMETER = -9
E_NOT_SUPPORTED = -10
E_UNKNOWN_ERROR_CODE = -11
E_STREAM_OUT_OF_SYNC = -12
E_INVALID_UID = -13
E_NON_ASCII_CHAR_IN_SECRET = -14
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Bemerkung

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

Fortgeschrittene Funktionen¶

int red_create_session(RED *red, uint32_t lifetime, uint8_t *ret_error_code, uint16_t *ret_session_id)¶

Parameter:	red – Typ: RED * lifetime – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_expire_session(RED *red, uint16_t session_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_expire_session_unchecked(RED *red, uint16_t session_id)¶

Parameter:	red – Typ: RED * session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

int red_keep_session_alive(RED *red, uint16_t session_id, uint32_t lifetime, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] lifetime – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_release_object(RED *red, uint16_t object_id, uint16_t session_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * object_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_release_object_unchecked(RED *red, uint16_t object_id, uint16_t session_id)¶

Parameter:	red – Typ: RED * object_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

int red_allocate_string(RED *red, uint32_t length_to_reserve, const char *buffer, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_string_id)¶

Parameter:	red – Typ: RED * length_to_reserve – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] buffer – Typ: const char[58] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_truncate_string(RED *red, uint16_t string_id, uint32_t length, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] length – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_string_length(RED *red, uint16_t string_id, uint8_t *ret_error_code, uint32_t *ret_length)¶

Parameter:	red – Typ: RED * string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_length – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_set_string_chunk(RED *red, uint16_t string_id, uint32_t offset, const char *buffer, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] buffer – Typ: const char[58]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_string_chunk(RED *red, uint16_t string_id, uint32_t offset, uint8_t *ret_error_code, char ret_buffer[63])¶

Parameter:	red – Typ: RED * string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_buffer – Typ: char[63]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_allocate_list(RED *red, uint16_t length_to_reserve, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_list_id)¶

Parameter:	red – Typ: RED * length_to_reserve – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_list_length(RED *red, uint16_t list_id, uint8_t *ret_error_code, uint16_t *ret_length)¶

Parameter:	red – Typ: RED * list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_length – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_list_item(RED *red, uint16_t list_id, uint16_t index, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_item_object_id, uint8_t *ret_type)¶

Parameter:	red – Typ: RED * list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] index – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_item_object_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_type:

RED_OBJECT_TYPE_STRING = 0
RED_OBJECT_TYPE_LIST = 1
RED_OBJECT_TYPE_FILE = 2
RED_OBJECT_TYPE_DIRECTORY = 3
RED_OBJECT_TYPE_PROCESS = 4
RED_OBJECT_TYPE_PROGRAM = 5

int red_append_to_list(RED *red, uint16_t list_id, uint16_t item_object_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] item_object_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_remove_from_list(RED *red, uint16_t list_id, uint16_t index, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] index – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_open_file(RED *red, uint16_t name_string_id, uint32_t flags, uint16_t permissions, uint32_t uid, uint32_t gid, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_file_id)¶

Parameter:	red – Typ: RED * name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: uint32_t, Wertebereich: Siehe Konstanten permissions – Typ: uint16_t, Wertebereich: Siehe Konstanten uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] gid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für flags:

RED_FILE_FLAG_READ_ONLY = 1
RED_FILE_FLAG_WRITE_ONLY = 2
RED_FILE_FLAG_READ_WRITE = 4
RED_FILE_FLAG_APPEND = 8
RED_FILE_FLAG_CREATE = 16
RED_FILE_FLAG_EXCLUSIVE = 32
RED_FILE_FLAG_NON_BLOCKING = 64
RED_FILE_FLAG_TRUNCATE = 128
RED_FILE_FLAG_TEMPORARY = 256
RED_FILE_FLAG_REPLACE = 512

Für permissions:

RED_FILE_PERMISSION_USER_ALL = 448
RED_FILE_PERMISSION_USER_READ = 256
RED_FILE_PERMISSION_USER_WRITE = 128
RED_FILE_PERMISSION_USER_EXECUTE = 64
RED_FILE_PERMISSION_GROUP_ALL = 56
RED_FILE_PERMISSION_GROUP_READ = 32
RED_FILE_PERMISSION_GROUP_WRITE = 16
RED_FILE_PERMISSION_GROUP_EXECUTE = 8
RED_FILE_PERMISSION_OTHERS_ALL = 7
RED_FILE_PERMISSION_OTHERS_READ = 4
RED_FILE_PERMISSION_OTHERS_WRITE = 2
RED_FILE_PERMISSION_OTHERS_EXECUTE = 1

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_create_pipe(RED *red, uint32_t flags, uint64_t length, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_file_id)¶

Parameter:	red – Typ: RED * flags – Typ: uint32_t, Wertebereich: Siehe Konstanten length – Typ: uint64_t, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für flags:

RED_PIPE_FLAG_NON_BLOCKING_READ = 1
RED_PIPE_FLAG_NON_BLOCKING_WRITE = 2

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_file_info(RED *red, uint16_t file_id, uint16_t session_id, uint8_t *ret_error_code, uint8_t *ret_type, uint16_t *ret_name_string_id, uint32_t *ret_flags, uint16_t *ret_permissions, uint32_t *ret_uid, uint32_t *ret_gid, uint64_t *ret_length, uint64_t *ret_access_timestamp, uint64_t *ret_modification_timestamp, uint64_t *ret_status_change_timestamp)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_type – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_flags – Typ: uint32_t, Wertebereich: Siehe Konstanten ret_permissions – Typ: uint16_t, Wertebereich: Siehe Konstanten ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_gid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_length – Typ: uint64_t, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1] ret_access_timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1] ret_modification_timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1] ret_status_change_timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_type:

RED_FILE_TYPE_UNKNOWN = 0
RED_FILE_TYPE_REGULAR = 1
RED_FILE_TYPE_DIRECTORY = 2
RED_FILE_TYPE_CHARACTER = 3
RED_FILE_TYPE_BLOCK = 4
RED_FILE_TYPE_FIFO = 5
RED_FILE_TYPE_SYMLINK = 6
RED_FILE_TYPE_SOCKET = 7
RED_FILE_TYPE_PIPE = 8

Für ret_flags:

RED_FILE_FLAG_READ_ONLY = 1
RED_FILE_FLAG_WRITE_ONLY = 2
RED_FILE_FLAG_READ_WRITE = 4
RED_FILE_FLAG_APPEND = 8
RED_FILE_FLAG_CREATE = 16
RED_FILE_FLAG_EXCLUSIVE = 32
RED_FILE_FLAG_NON_BLOCKING = 64
RED_FILE_FLAG_TRUNCATE = 128
RED_FILE_FLAG_TEMPORARY = 256
RED_FILE_FLAG_REPLACE = 512

Für ret_permissions:

RED_FILE_PERMISSION_USER_ALL = 448
RED_FILE_PERMISSION_USER_READ = 256
RED_FILE_PERMISSION_USER_WRITE = 128
RED_FILE_PERMISSION_USER_EXECUTE = 64
RED_FILE_PERMISSION_GROUP_ALL = 56
RED_FILE_PERMISSION_GROUP_READ = 32
RED_FILE_PERMISSION_GROUP_WRITE = 16
RED_FILE_PERMISSION_GROUP_EXECUTE = 8
RED_FILE_PERMISSION_OTHERS_ALL = 7
RED_FILE_PERMISSION_OTHERS_READ = 4
RED_FILE_PERMISSION_OTHERS_WRITE = 2
RED_FILE_PERMISSION_OTHERS_EXECUTE = 1

int red_read_file(RED *red, uint16_t file_id, uint8_t length_to_read, uint8_t *ret_error_code, uint8_t ret_buffer[62], uint8_t *ret_length_read)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] length_to_read – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_buffer – Typ: uint8_t[62], Wertebereich: [0 bis 255] ret_length_read – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_read_file_async(RED *red, uint16_t file_id, uint64_t length_to_read)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] length_to_read – Typ: uint64_t, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]
Rückgabe:	e_code – Typ: int

int red_abort_async_file_read(RED *red, uint16_t file_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_write_file(RED *red, uint16_t file_id, uint8_t buffer[61], uint8_t length_to_write, uint8_t *ret_error_code, uint8_t *ret_length_written)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: uint8_t[61], Wertebereich: [0 bis 255] length_to_write – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_length_written – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_write_file_unchecked(RED *red, uint16_t file_id, uint8_t buffer[61], uint8_t length_to_write)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: uint8_t[61], Wertebereich: [0 bis 255] length_to_write – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

int red_write_file_async(RED *red, uint16_t file_id, uint8_t buffer[61], uint8_t length_to_write)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] buffer – Typ: uint8_t[61], Wertebereich: [0 bis 255] length_to_write – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

int red_set_file_position(RED *red, uint16_t file_id, int64_t offset, uint8_t origin, uint8_t *ret_error_code, uint64_t *ret_position)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] offset – Typ: int64_t, Einheit: 1 B, Wertebereich: [-2⁶³ bis 2⁶³ - 1] origin – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_position – Typ: uint64_t, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]
Rückgabe:	e_code – Typ: int

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

Für origin:

RED_FILE_ORIGIN_BEGINNING = 0
RED_FILE_ORIGIN_CURRENT = 1
RED_FILE_ORIGIN_END = 2

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_file_position(RED *red, uint16_t file_id, uint8_t *ret_error_code, uint64_t *ret_position)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_position – Typ: uint64_t, Einheit: 1 B, Wertebereich: [0 bis 2⁶⁴ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_set_file_events(RED *red, uint16_t file_id, uint16_t events, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] events – Typ: uint16_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für events:

RED_FILE_EVENT_READABLE = 1
RED_FILE_EVENT_WRITABLE = 2

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_file_events(RED *red, uint16_t file_id, uint8_t *ret_error_code, uint16_t *ret_events)¶

Parameter:	red – Typ: RED * file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_events – Typ: uint16_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_events:

RED_FILE_EVENT_READABLE = 1
RED_FILE_EVENT_WRITABLE = 2

int red_open_directory(RED *red, uint16_t name_string_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_directory_id)¶

Parameter:	red – Typ: RED * name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_directory_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_directory_name(RED *red, uint16_t directory_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_name_string_id)¶

Parameter:	red – Typ: RED * directory_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_next_directory_entry(RED *red, uint16_t directory_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_name_string_id, uint8_t *ret_type)¶

Parameter:	red – Typ: RED * directory_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_type:

RED_DIRECTORY_ENTRY_TYPE_UNKNOWN = 0
RED_DIRECTORY_ENTRY_TYPE_REGULAR = 1
RED_DIRECTORY_ENTRY_TYPE_DIRECTORY = 2
RED_DIRECTORY_ENTRY_TYPE_CHARACTER = 3
RED_DIRECTORY_ENTRY_TYPE_BLOCK = 4
RED_DIRECTORY_ENTRY_TYPE_FIFO = 5
RED_DIRECTORY_ENTRY_TYPE_SYMLINK = 6
RED_DIRECTORY_ENTRY_TYPE_SOCKET = 7

int red_rewind_directory(RED *red, uint16_t directory_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * directory_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_create_directory(RED *red, uint16_t name_string_id, uint32_t flags, uint16_t permissions, uint32_t uid, uint32_t gid, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] flags – Typ: uint32_t, Wertebereich: Siehe Konstanten permissions – Typ: uint16_t, Wertebereich: Siehe Konstanten uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] gid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für flags:

RED_DIRECTORY_FLAG_RECURSIVE = 1
RED_DIRECTORY_FLAG_EXCLUSIVE = 2

Für permissions:

RED_FILE_PERMISSION_USER_ALL = 448
RED_FILE_PERMISSION_USER_READ = 256
RED_FILE_PERMISSION_USER_WRITE = 128
RED_FILE_PERMISSION_USER_EXECUTE = 64
RED_FILE_PERMISSION_GROUP_ALL = 56
RED_FILE_PERMISSION_GROUP_READ = 32
RED_FILE_PERMISSION_GROUP_WRITE = 16
RED_FILE_PERMISSION_GROUP_EXECUTE = 8
RED_FILE_PERMISSION_OTHERS_ALL = 7
RED_FILE_PERMISSION_OTHERS_READ = 4
RED_FILE_PERMISSION_OTHERS_WRITE = 2
RED_FILE_PERMISSION_OTHERS_EXECUTE = 1

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_processes(RED *red, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_processes_list_id)¶

Parameter:	red – Typ: RED * session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_processes_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_spawn_process(RED *red, uint16_t executable_string_id, uint16_t arguments_list_id, uint16_t environment_list_id, uint16_t working_directory_string_id, uint32_t uid, uint32_t gid, uint16_t stdin_file_id, uint16_t stdout_file_id, uint16_t stderr_file_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_process_id)¶

Parameter:	red – Typ: RED * executable_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] arguments_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] environment_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] working_directory_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] gid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] stdin_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] stdout_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] stderr_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_kill_process(RED *red, uint16_t process_id, uint8_t signal, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] signal – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für signal:

RED_PROCESS_SIGNAL_INTERRUPT = 2
RED_PROCESS_SIGNAL_QUIT = 3
RED_PROCESS_SIGNAL_ABORT = 6
RED_PROCESS_SIGNAL_KILL = 9
RED_PROCESS_SIGNAL_USER1 = 10
RED_PROCESS_SIGNAL_USER2 = 12
RED_PROCESS_SIGNAL_TERMINATE = 15
RED_PROCESS_SIGNAL_CONTINUE = 18
RED_PROCESS_SIGNAL_STOP = 19

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_process_command(RED *red, uint16_t process_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_executable_string_id, uint16_t *ret_arguments_list_id, uint16_t *ret_environment_list_id, uint16_t *ret_working_directory_string_id)¶

Parameter:	red – Typ: RED * process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_executable_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_arguments_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_environment_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_working_directory_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_process_identity(RED *red, uint16_t process_id, uint8_t *ret_error_code, uint32_t *ret_pid, uint32_t *ret_uid, uint32_t *ret_gid)¶

Parameter:	red – Typ: RED * process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_pid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_gid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_process_stdio(RED *red, uint16_t process_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_stdin_file_id, uint16_t *ret_stdout_file_id, uint16_t *ret_stderr_file_id)¶

Parameter:	red – Typ: RED * process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_stdin_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_stdout_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_stderr_file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_process_state(RED *red, uint16_t process_id, uint8_t *ret_error_code, uint8_t *ret_state, uint64_t *ret_timestamp, uint8_t *ret_exit_code)¶

Parameter:	red – Typ: RED * process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1] ret_exit_code – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_state:

RED_PROCESS_STATE_UNKNOWN = 0
RED_PROCESS_STATE_RUNNING = 1
RED_PROCESS_STATE_ERROR = 2
RED_PROCESS_STATE_EXITED = 3
RED_PROCESS_STATE_KILLED = 4
RED_PROCESS_STATE_STOPPED = 5

int red_get_programs(RED *red, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_programs_list_id)¶

Parameter:	red – Typ: RED * session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_programs_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_define_program(RED *red, uint16_t identifier_string_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_program_id)¶

Parameter:	red – Typ: RED * identifier_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_purge_program(RED *red, uint16_t program_id, uint32_t cookie, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] cookie – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_program_identifier(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_identifier_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_identifier_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_program_root_directory(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_root_directory_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_root_directory_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_set_program_command(RED *red, uint16_t program_id, uint16_t executable_string_id, uint16_t arguments_list_id, uint16_t environment_list_id, uint16_t working_directory_string_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] executable_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] arguments_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] environment_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] working_directory_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_program_command(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_executable_string_id, uint16_t *ret_arguments_list_id, uint16_t *ret_environment_list_id, uint16_t *ret_working_directory_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_executable_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_arguments_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_environment_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_working_directory_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_set_program_stdio_redirection(RED *red, uint16_t program_id, uint8_t stdin_redirection, uint16_t stdin_file_name_string_id, uint8_t stdout_redirection, uint16_t stdout_file_name_string_id, uint8_t stderr_redirection, uint16_t stderr_file_name_string_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] stdin_redirection – Typ: uint8_t, Wertebereich: Siehe Konstanten stdin_file_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] stdout_redirection – Typ: uint8_t, Wertebereich: Siehe Konstanten stdout_file_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] stderr_redirection – Typ: uint8_t, Wertebereich: Siehe Konstanten stderr_file_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für stdin_redirection:

RED_PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
RED_PROGRAM_STDIO_REDIRECTION_PIPE = 1
RED_PROGRAM_STDIO_REDIRECTION_FILE = 2
RED_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
RED_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
RED_PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stdout_redirection:

RED_PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
RED_PROGRAM_STDIO_REDIRECTION_PIPE = 1
RED_PROGRAM_STDIO_REDIRECTION_FILE = 2
RED_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
RED_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
RED_PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stderr_redirection:

RED_PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
RED_PROGRAM_STDIO_REDIRECTION_PIPE = 1
RED_PROGRAM_STDIO_REDIRECTION_FILE = 2
RED_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
RED_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
RED_PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_program_stdio_redirection(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint8_t *ret_stdin_redirection, uint16_t *ret_stdin_file_name_string_id, uint8_t *ret_stdout_redirection, uint16_t *ret_stdout_file_name_string_id, uint8_t *ret_stderr_redirection, uint16_t *ret_stderr_file_name_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_stdin_redirection – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_stdin_file_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_stdout_redirection – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_stdout_file_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_stderr_redirection – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_stderr_file_name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_stdin_redirection:

RED_PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
RED_PROGRAM_STDIO_REDIRECTION_PIPE = 1
RED_PROGRAM_STDIO_REDIRECTION_FILE = 2
RED_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
RED_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
RED_PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für ret_stdout_redirection:

RED_PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
RED_PROGRAM_STDIO_REDIRECTION_PIPE = 1
RED_PROGRAM_STDIO_REDIRECTION_FILE = 2
RED_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
RED_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
RED_PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für ret_stderr_redirection:

RED_PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
RED_PROGRAM_STDIO_REDIRECTION_PIPE = 1
RED_PROGRAM_STDIO_REDIRECTION_FILE = 2
RED_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
RED_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
RED_PROGRAM_STDIO_REDIRECTION_STDOUT = 5

int red_set_program_schedule(RED *red, uint16_t program_id, uint8_t start_mode, bool continue_after_error, uint32_t start_interval, uint16_t start_fields_string_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] start_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten continue_after_error – Typ: bool start_interval – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] start_fields_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für start_mode:

RED_PROGRAM_START_MODE_NEVER = 0
RED_PROGRAM_START_MODE_ALWAYS = 1
RED_PROGRAM_START_MODE_INTERVAL = 2
RED_PROGRAM_START_MODE_CRON = 3

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_program_schedule(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint8_t *ret_start_mode, bool *ret_continue_after_error, uint32_t *ret_start_interval, uint16_t *ret_start_fields_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_start_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_continue_after_error – Typ: bool ret_start_interval – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_start_fields_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_start_mode:

RED_PROGRAM_START_MODE_NEVER = 0
RED_PROGRAM_START_MODE_ALWAYS = 1
RED_PROGRAM_START_MODE_INTERVAL = 2
RED_PROGRAM_START_MODE_CRON = 3

int red_get_program_scheduler_state(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint8_t *ret_state, uint64_t *ret_timestamp, uint16_t *ret_message_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1] ret_message_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für ret_state:

RED_PROGRAM_SCHEDULER_STATE_STOPPED = 0
RED_PROGRAM_SCHEDULER_STATE_RUNNING = 1

int red_continue_program_schedule(RED *red, uint16_t program_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_start_program(RED *red, uint16_t program_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_last_spawned_program_process(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_process_id, uint64_t *ret_timestamp)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] ret_timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_custom_program_option_names(RED *red, uint16_t program_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_names_list_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_names_list_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_set_custom_program_option_value(RED *red, uint16_t program_id, uint16_t name_string_id, uint16_t value_string_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] value_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_custom_program_option_value(RED *red, uint16_t program_id, uint16_t name_string_id, uint16_t session_id, uint8_t *ret_error_code, uint16_t *ret_value_string_id)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] session_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_value_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_remove_custom_program_option(RED *red, uint16_t program_id, uint16_t name_string_id, uint8_t *ret_error_code)¶

Parameter:	red – Typ: RED * program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] name_string_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für ret_error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

int red_get_identity(RED *red, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	red – Typ: RED *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['0' bis '8'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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

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

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

Konfigurationsfunktionen für Callbacks¶

void red_register_callback(RED *red, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	red – Typ: RED * callback_id – Typ: int16_t function – Typ: void ()(void) user_data* – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der red_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

red_register_callback(&red,
                      RED_CALLBACK_EXAMPLE,
                      (void (*)(void))my_callback,
                      NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

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

RED_CALLBACK_ASYNC_FILE_READ¶

void callback(uint16_t file_id, uint8_t error_code, uint8_t buffer[60], uint8_t length_read, void *user_data)

Callback-Parameter:	file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten buffer – Typ: uint8_t[60], Wertebereich: [0 bis 255] length_read – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255] user_data – Typ: void *

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

Für error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

RED_CALLBACK_ASYNC_FILE_WRITE¶

void callback(uint16_t file_id, uint8_t error_code, uint8_t length_written, void *user_data)

Callback-Parameter:	file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] error_code – Typ: uint8_t, Wertebereich: Siehe Konstanten length_written – Typ: uint8_t, Einheit: 1 B, Wertebereich: [0 bis 255] user_data – Typ: void *

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

Für error_code:

RED_ERROR_CODE_SUCCESS = 0
RED_ERROR_CODE_UNKNOWN_ERROR = 1
RED_ERROR_CODE_INVALID_OPERATION = 2
RED_ERROR_CODE_OPERATION_ABORTED = 3
RED_ERROR_CODE_INTERNAL_ERROR = 4
RED_ERROR_CODE_UNKNOWN_SESSION_ID = 5
RED_ERROR_CODE_NO_FREE_SESSION_ID = 6
RED_ERROR_CODE_UNKNOWN_OBJECT_ID = 7
RED_ERROR_CODE_NO_FREE_OBJECT_ID = 8
RED_ERROR_CODE_OBJECT_IS_LOCKED = 9
RED_ERROR_CODE_NO_MORE_DATA = 10
RED_ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
RED_ERROR_CODE_PROGRAM_IS_PURGED = 12
RED_ERROR_CODE_INVALID_PARAMETER = 128
RED_ERROR_CODE_NO_FREE_MEMORY = 129
RED_ERROR_CODE_NO_FREE_SPACE = 130
RED_ERROR_CODE_ACCESS_DENIED = 121
RED_ERROR_CODE_ALREADY_EXISTS = 132
RED_ERROR_CODE_DOES_NOT_EXIST = 133
RED_ERROR_CODE_INTERRUPTED = 134
RED_ERROR_CODE_IS_DIRECTORY = 135
RED_ERROR_CODE_NOT_A_DIRECTORY = 136
RED_ERROR_CODE_WOULD_BLOCK = 137
RED_ERROR_CODE_OVERFLOW = 138
RED_ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
RED_ERROR_CODE_OUT_OF_RANGE = 140
RED_ERROR_CODE_NAME_TOO_LONG = 141
RED_ERROR_CODE_INVALID_SEEK = 142
RED_ERROR_CODE_NOT_SUPPORTED = 143
RED_ERROR_CODE_TOO_MANY_OPEN_FILES = 144

RED_CALLBACK_FILE_EVENTS_OCCURRED¶

void callback(uint16_t file_id, uint16_t events, void *user_data)

Callback-Parameter:	file_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] events – Typ: uint16_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

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

Für events:

RED_FILE_EVENT_READABLE = 1
RED_FILE_EVENT_WRITABLE = 2

RED_CALLBACK_PROCESS_STATE_CHANGED¶

void callback(uint16_t process_id, uint8_t state, uint64_t timestamp, uint8_t exit_code, void *user_data)

Callback-Parameter:	process_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] state – Typ: uint8_t, Wertebereich: Siehe Konstanten timestamp – Typ: uint64_t, Wertebereich: [0 bis 2⁶⁴ - 1] exit_code – Typ: uint8_t, Wertebereich: [0 bis 255] user_data – Typ: void *

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

Für state:

RED_PROCESS_STATE_UNKNOWN = 0
RED_PROCESS_STATE_RUNNING = 1
RED_PROCESS_STATE_ERROR = 2
RED_PROCESS_STATE_EXITED = 3
RED_PROCESS_STATE_KILLED = 4
RED_PROCESS_STATE_STOPPED = 5

RED_CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED¶

void callback(uint16_t program_id, void *user_data)

Callback-Parameter:	program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

RED_CALLBACK_PROGRAM_PROCESS_SPAWNED¶

void callback(uint16_t program_id, void *user_data)

Callback-Parameter:	program_id – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Virtuelle Funktionen¶

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

int red_get_api_version(RED *red, uint8_t ret_api_version[3])¶

Parameter:	red – Typ: RED *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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

int red_get_response_expected(RED *red, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	red – Typ: RED * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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

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

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

Für function_id:

RED_FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
RED_FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
RED_FUNCTION_READ_FILE_ASYNC = 21
RED_FUNCTION_WRITE_FILE_UNCHECKED = 24
RED_FUNCTION_WRITE_FILE_ASYNC = 25

int red_set_response_expected(RED *red, uint8_t function_id, bool response_expected)¶

Parameter:	red – Typ: RED * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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

Für function_id:

RED_FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
RED_FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
RED_FUNCTION_READ_FILE_ASYNC = 21
RED_FUNCTION_WRITE_FILE_UNCHECKED = 24
RED_FUNCTION_WRITE_FILE_ASYNC = 25

int red_set_response_expected_all(RED *red, bool response_expected)¶

Parameter:	red – Typ: RED * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Konstanten¶

RED_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen RED Brick zu identifizieren.

Die red_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

RED_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RED Brick dar.