Status_codes

Many StZNet API functions return an ::StStatus value to indicate the success or failure of the call. More...

Macros
#define	DEFINE_ERROR(symbol, value)   ST_ ## symbol = value,
	Macro used by error-def.h to define all of the return codes. More...

Enumerations
enum	{ ST_ERROR_CODE_COUNT }

Detailed Description

Many StZNet API functions return an ::StStatus value to indicate the success or failure of the call.

Return codes are one byte long. This page documents the possible status codes and their meanings.

See error-def.h for source code.

See also error.h for information on how the values for the return codes are built up from these definitions. The file error-def.h is separated from error.h because utilities will use this file to parse the return codes.

Note

Do not include error-def.h directly. It is included by error.h inside an enum typedef, which is in turn included by st.h.

Macro Definition Documentation

#define DEFINE_ERROR	(		symbol,
			value
	)		ST_ ## symbol = value,

Macro used by error-def.h to define all of the return codes.

Parameters

symbol	The name of the constant being defined. All St returns begin with ST_. For example, ::ST_CONNECTION_OPEN.
value	The value of the return code. For example, 0x61.

Definition at line 34 of file error.h.

Enumeration Type Documentation

anonymous enum

Enumerator
ST_ERROR_CODE_COUNT	Gets defined as a count of all the possible return codes in the StZNet stack API.

Definition at line 38 of file error.h.