Streams

	Data Types
	Stream Operations
	Stream Types
	Stream Visibility
	Schema
Entities/Objects
typedef struct EspSchema	EspSchema
typedef struct EspStream	EspStream
typedef struct EspMoney	EspMoney
typedef struct EspBigDatetime	EspBigDatetime

Functions
ESPAPICALL int32_t	esp_stream_get_type (const EspStream *stream, ESP_STREAM_TYPE_T *type, EspError *error)
ESPAPICALL int32_t	esp_stream_get_visibility (const EspStream *stream, ESP_STREAM_VISIBILITY_T *visibility, EspError *error)
ESPAPICALL int32_t	esp_stream_get_id (const EspStream *stream, int32_t *id, EspError *error)
ESPAPICALL const char *	esp_stream_get_name (const EspStream *stream, EspError *error)
ESPAPICALL const EspSchema *	esp_stream_get_schema (const EspStream *stream, EspError *error)

---

Function Documentation

ESPAPICALL int32_t esp_stream_get_id	(	const EspStream *	stream,
		int32_t *	id,
		EspError *	error
	)

Retrieve the unique id assigned to the EspStream.

Returns:

0 on success.

Parameters:

stream	EspStream to query
id	Pointer in which to return the id

ESPAPICALL const char* esp_stream_get_name	(	const EspStream *	stream,
		EspError *	error
	)

Retrieve the name for this EspStream.

Returns:

stream name, NULL on error.

Parameters:

stream

EspStream to query

ESPAPICALL const EspSchema* esp_stream_get_schema	(	const EspStream *	stream,
		EspError *	error
	)

Retrieve the schema for the EspStream.

.

Returns:

the schema, NULL on error

Parameters:

stream

EspStream to query

ESPAPICALL int32_t esp_stream_get_type	(	const EspStream *	stream,
		ESP_STREAM_TYPE_T *	type,
		EspError *	error
	)

Retrieve the type of the EspStream.

Returns:

0 on success.

Parameters:

stream	EspStream to query
type	Pointer in which to return the type

ESPAPICALL int32_t esp_stream_get_visibility	(	const EspStream *	stream,
		ESP_STREAM_VISIBILITY_T *	visibility,
		EspError *	error
	)

Retrieve the visibility of the EspStream.

Returns:

0 on success.

Parameters:

stream	EspStream to query
visibility	Pointer in which to return the visibility