<<extension>> Unique identifier for a written data sample More...

Data Structures
struct	DDS_Cookie_t
	<<extension>> Sequence of bytes. More...

struct	DDS_CookieSeq
	Declares IDL `sequence` < DDS_Cookie_t > . More...

Functions
DDS_Boolean	DDS_Cookie_from_pointer (struct DDS_Cookie_t self, const void pointer)
	Stores a pointer in a cookie. More...

void *	DDS_Cookie_to_pointer (const struct DDS_Cookie_t *self)
	Returns the pointer previously stored in the cookie. More...

Detailed Description

<<extension>> Unique identifier for a written data sample

Function Documentation

DDS_Boolean DDS_Cookie_from_pointer	(	struct DDS_Cookie_t *	self,
		const void *	pointer
	)

Stores a pointer in a cookie.

Parameters

self	<<in>> Cannot be NULL.
pointer	<<in>> The pointer to be stored in the cookie. Can be NULL.

Returns: DDS_BOOLEAN_TRUE if the cookie was successfully filled with the pointer, DDS_BOOLEAN_FALSE otherwise.

void * DDS_Cookie_to_pointer ( const struct DDS_Cookie_t * self )

Returns the pointer previously stored in the cookie.

Precondition: The cookie's value was filled with a pointer; otherwise, the value returned may not be a valid memory address.

Parameters

self	<<in>> Cannot be NULL.