Group SDS_Return_Codes

Modules > SDS_Return_Codes

SDS Function Return Codes. More...

Macros

Type	Name
define	SDS_EOS (-7) End of stream reached in read operation.
define	SDS_ERROR (-1) Unspecified error.
define	SDS_ERROR_IO (-4) I/O error during function execution.
define	SDS_ERROR_PARAMETER (-2) Invalid parameter passed to a function.
define	SDS_ERROR_TIMEOUT (-3) Function execution timed out.
define	SDS_NO_DATA (-6) Insufficient data in SDS stream buffer.
define	SDS_NO_SPACE (-5) Insufficient space in SDS circular buffer to write the entire data block.
define	SDS_OK (0) Function completed successfully.

Detailed Description

The following values are returned by most SDS functions.

Macro Definition Documentation

define SDS_EOS

End of stream reached in read operation.

#define SDS_EOS `(-7)`

---

define SDS_ERROR

Unspecified error.

#define SDS_ERROR `(-1)`

---

define SDS_ERROR_IO

I/O error during function execution.

#define SDS_ERROR_IO `(-4)`

---

define SDS_ERROR_PARAMETER

Invalid parameter passed to a function.

#define SDS_ERROR_PARAMETER `(-2)`

---

define SDS_ERROR_TIMEOUT

Function execution timed out.

#define SDS_ERROR_TIMEOUT `(-3)`

---

define SDS_NO_DATA

Insufficient data in SDS stream buffer.

#define SDS_NO_DATA `(-6)`

---

define SDS_NO_SPACE

Insufficient space in SDS circular buffer to write the entire data block.

#define SDS_NO_SPACE `(-5)`

---

define SDS_OK

Function completed successfully.

#define SDS_OK `(0)`

---

---