Data Item I004/040 - Alert Identifier

Unique identifier for an alert instance. More...

Collaboration diagram for Data Item I004/040 - Alert Identifier:

Data Structures
struct	ast_dataitem_004_040_t
	Data Item I004/040 - Alert Identifier. More...

Macros
#define	ast_dataitem_004_040_get_size   ast_dataitem_get_size_fixed_2_byte
	Get size function for I004/040.
#define	ast_dataitem_004_040_get_detail_html   ast_dataitem_get_detail_html_dummy;
	Get detail function for I004/040.

Functions
ast_dataitem_004_040_t	ast_dataitem_004_040_decode (const ast_dataitem_t di)
	Decode Data Item I004/040.
ast_dataitem_t	ast_dataitem_004_040_encode (unsigned char *const buffer, const size_t buf_size, const ast_dataitem_ex_t xdi)
	Encode Data Item I004/040.
void	ast_dataitem_004_040_get_summary (char *summary, const size_t summary_size, const ast_dataitem_t di)
	Get summary text for I004/040.

Detailed Description

Unique identifier for an alert instance.

Format:

Two-octet fixed length Data Item

Description:

Provides a unique reference to identify a specific alert/conflict instance, allowing correlation of alert activation and termination (EOC) messages.

Encoding Rule:

This item is used in conjunction with the Message Type to uniquely identify an alert.

Macro Definition Documentation

ast_dataitem_004_040_get_detail_html

#define ast_dataitem_004_040_get_detail_html   ast_dataitem_get_detail_html_dummy;

Get detail function for I004/040.

ast_dataitem_004_040_get_size

#define ast_dataitem_004_040_get_size   ast_dataitem_get_size_fixed_2_byte

Get size function for I004/040.

Function Documentation

ast_dataitem_004_040_decode()

ast_dataitem_004_040_t ast_dataitem_004_040_decode

(

const ast_dataitem_t

di

)

Decode Data Item I004/040.

Parameters

di	Data item to decode

Returns

Decoded alert identifier structure

ast_dataitem_004_040_encode()

ast_dataitem_t ast_dataitem_004_040_encode	(	unsigned char *const	buffer,
		const size_t	buf_size,
		const ast_dataitem_ex_t	xdi )

Encode Data Item I004/040.

Parameters

buffer	Output buffer
buf_size	Buffer size
xdi	Extended data item information

Returns

Encoded data item

ast_dataitem_004_040_get_summary()

void ast_dataitem_004_040_get_summary	(	char *	summary,
		const size_t	summary_size,
		const ast_dataitem_t	di )

Get summary text for I004/040.

Parameters

summary	Output buffer for summary
summary_size	Size of summary buffer
di	Data item to summarize