blpapi_element.h File Reference

Provide a representation of an item in a message. More...

#include <blpapi_call.h>
#include <blpapi_datetime.h>
#include <blpapi_defs.h>
#include <blpapi_name.h>
#include <blpapi_schema.h>
#include <blpapi_streamproxy.h>
#include <blpapi_types.h>
#include <stddef.h>
#include <blpapi_exception.h>
#include <cassert>
#include <string>
#include <type_traits>

Go to the source code of this file.

Classes
class	Element

Namespaces
	BloombergLP
	BloombergLP::blpapi

Functions
blpapi_Name_t *	blpapi_Element_name (const blpapi_Element_t *element)
const char *	blpapi_Element_nameString (const blpapi_Element_t *element)
blpapi_SchemaElementDefinition_t *	blpapi_Element_definition (const blpapi_Element_t *element)
int	blpapi_Element_datatype (const blpapi_Element_t *element)
int	blpapi_Element_isComplexType (const blpapi_Element_t *element)
int	blpapi_Element_isArray (const blpapi_Element_t *element)
int	blpapi_Element_isReadOnly (const blpapi_Element_t *element)
size_t	blpapi_Element_numValues (const blpapi_Element_t *element)
size_t	blpapi_Element_numElements (const blpapi_Element_t *element)
int	blpapi_Element_isNullValue (const blpapi_Element_t *element, size_t position)
int	blpapi_Element_isNull (const blpapi_Element_t *element)
int	blpapi_Element_print (const blpapi_Element_t *element, blpapi_StreamWriter_t streamWriter, void *stream, int level, int spacesPerLevel)
int	blpapi_Element_getElementAt (const blpapi_Element_t *element, blpapi_Element_t **result, size_t position)
int	blpapi_Element_getElement (const blpapi_Element_t *element, blpapi_Element_t **result, const char *nameString, const blpapi_Name_t *name)
int	blpapi_Element_hasElement (const blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name)
int	blpapi_Element_hasElementEx (const blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, int excludeNullElements, int reserved)
int	blpapi_Element_getValueAsBool (const blpapi_Element_t *element, blpapi_Bool_t *buffer, size_t index)
int	blpapi_Element_getValueAsChar (const blpapi_Element_t *element, blpapi_Char_t *buffer, size_t index)
int	blpapi_Element_getValueAsInt32 (const blpapi_Element_t *element, blpapi_Int32_t *buffer, size_t index)
int	blpapi_Element_getValueAsInt64 (const blpapi_Element_t *element, blpapi_Int64_t *buffer, size_t index)
int	blpapi_Element_getValueAsFloat32 (const blpapi_Element_t *element, blpapi_Float32_t *buffer, size_t index)
int	blpapi_Element_getValueAsFloat64 (const blpapi_Element_t *element, blpapi_Float64_t *buffer, size_t index)
int	blpapi_Element_getValueAsString (const blpapi_Element_t *element, const char **buffer, size_t index)
int	blpapi_Element_getValueAsDatetime (const blpapi_Element_t *element, blpapi_Datetime_t *buffer, size_t index)
int	blpapi_Element_getValueAsHighPrecisionDatetime (const blpapi_Element_t *element, blpapi_HighPrecisionDatetime_t *buffer, size_t index)
int	blpapi_Element_getValueAsElement (const blpapi_Element_t *element, blpapi_Element_t **buffer, size_t index)
int	blpapi_Element_getValueAsName (const blpapi_Element_t *element, blpapi_Name_t **buffer, size_t index)
int	blpapi_Element_getValueAsBytes (const blpapi_Element_t *element, const char **buffer, size_t *length, size_t index)
int	blpapi_Element_getChoice (const blpapi_Element_t *element, blpapi_Element_t **result)
int	blpapi_Element_setValueBool (blpapi_Element_t *element, blpapi_Bool_t value, size_t index)
int	blpapi_Element_setValueChar (blpapi_Element_t *element, blpapi_Char_t value, size_t index)
int	blpapi_Element_setValueInt32 (blpapi_Element_t *element, blpapi_Int32_t value, size_t index)
int	blpapi_Element_setValueInt64 (blpapi_Element_t *element, blpapi_Int64_t value, size_t index)
int	blpapi_Element_setValueFloat32 (blpapi_Element_t *element, blpapi_Float32_t value, size_t index)
int	blpapi_Element_setValueFloat64 (blpapi_Element_t *element, blpapi_Float64_t value, size_t index)
int	blpapi_Element_setValueString (blpapi_Element_t *element, const char *value, size_t index)
int	blpapi_Element_setValueDatetime (blpapi_Element_t *element, const blpapi_Datetime_t *value, size_t index)
int	blpapi_Element_setValueHighPrecisionDatetime (blpapi_Element_t *element, const blpapi_HighPrecisionDatetime_t *value, size_t index)
int	blpapi_Element_setValueBytes (blpapi_Element_t *element, const char *value, size_t length, size_t index)
int	blpapi_Element_setValueFromElement (blpapi_Element_t *element, blpapi_Element_t *value, size_t index)
int	blpapi_Element_setValueFromName (blpapi_Element_t *element, const blpapi_Name_t *value, size_t index)
int	blpapi_Element_setElementBool (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Bool_t value)
int	blpapi_Element_setElementChar (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Char_t value)
int	blpapi_Element_setElementInt32 (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Int32_t value)
int	blpapi_Element_setElementInt64 (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Int64_t value)
int	blpapi_Element_setElementFloat32 (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Float32_t value)
int	blpapi_Element_setElementFloat64 (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Float64_t value)
int	blpapi_Element_setElementString (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, const char *value)
int	blpapi_Element_setElementDatetime (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, const blpapi_Datetime_t *value)
int	blpapi_Element_setElementHighPrecisionDatetime (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, const blpapi_HighPrecisionDatetime_t *value)
int	blpapi_Element_setElementBytes (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, const char *value, size_t length)
int	blpapi_Element_setElementFromField (blpapi_Element_t *element, const char *nameString, const blpapi_Name_t *name, blpapi_Element_t *sourcebuffer)
int	blpapi_Element_setElementFromName (blpapi_Element_t *element, const char *elementName, const blpapi_Name_t *name, const blpapi_Name_t *buffer)
int	blpapi_Element_appendElement (blpapi_Element_t *element, blpapi_Element_t **appendedElement)
int	blpapi_Element_setChoice (blpapi_Element_t *element, blpapi_Element_t **resultElement, const char *nameCstr, const blpapi_Name_t *name, size_t index)
std::ostream &	operator<< (std::ostream &stream, const Element &element)

Detailed Description

Provide a representation of an item in a message.

Function Documentation

blpapi_Element_appendElement()

int blpapi_Element_appendElement	(	blpapi_Element_t *	element,
		blpapi_Element_t **	appendedElement
	)

blpapi_Element_datatype()

int blpapi_Element_datatype

(

const blpapi_Element_t *

element

)

blpapi_Element_definition()

blpapi_SchemaElementDefinition_t* blpapi_Element_definition

(

const blpapi_Element_t *

element

)

blpapi_Element_getChoice()

int blpapi_Element_getChoice	(	const blpapi_Element_t *	element,
		blpapi_Element_t **	result
	)

blpapi_Element_getElement()

int blpapi_Element_getElement	(	const blpapi_Element_t *	element,
		blpapi_Element_t **	result,
		const char *	nameString,
		const blpapi_Name_t *	name
	)

blpapi_Element_getElementAt()

int blpapi_Element_getElementAt	(	const blpapi_Element_t *	element,
		blpapi_Element_t **	result,
		size_t	position
	)

blpapi_Element_getValueAsBool()

int blpapi_Element_getValueAsBool	(	const blpapi_Element_t *	element,
		blpapi_Bool_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsBytes()

int blpapi_Element_getValueAsBytes	(	const blpapi_Element_t *	element,
		const char **	buffer,
		size_t *	length,
		size_t	index
	)

blpapi_Element_getValueAsChar()

int blpapi_Element_getValueAsChar	(	const blpapi_Element_t *	element,
		blpapi_Char_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsDatetime()

int blpapi_Element_getValueAsDatetime	(	const blpapi_Element_t *	element,
		blpapi_Datetime_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsElement()

int blpapi_Element_getValueAsElement	(	const blpapi_Element_t *	element,
		blpapi_Element_t **	buffer,
		size_t	index
	)

blpapi_Element_getValueAsFloat32()

int blpapi_Element_getValueAsFloat32	(	const blpapi_Element_t *	element,
		blpapi_Float32_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsFloat64()

int blpapi_Element_getValueAsFloat64	(	const blpapi_Element_t *	element,
		blpapi_Float64_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsHighPrecisionDatetime()

int blpapi_Element_getValueAsHighPrecisionDatetime	(	const blpapi_Element_t *	element,
		blpapi_HighPrecisionDatetime_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsInt32()

int blpapi_Element_getValueAsInt32	(	const blpapi_Element_t *	element,
		blpapi_Int32_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsInt64()

int blpapi_Element_getValueAsInt64	(	const blpapi_Element_t *	element,
		blpapi_Int64_t *	buffer,
		size_t	index
	)

blpapi_Element_getValueAsName()

int blpapi_Element_getValueAsName	(	const blpapi_Element_t *	element,
		blpapi_Name_t **	buffer,
		size_t	index
	)

blpapi_Element_getValueAsString()

int blpapi_Element_getValueAsString	(	const blpapi_Element_t *	element,
		const char **	buffer,
		size_t	index
	)

blpapi_Element_hasElement()

int blpapi_Element_hasElement	(	const blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name
	)

blpapi_Element_hasElementEx()

int blpapi_Element_hasElementEx	(	const blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		int	excludeNullElements,
		int	reserved
	)

blpapi_Element_isArray()

int blpapi_Element_isArray

(

const blpapi_Element_t *

element

)

blpapi_Element_isComplexType()

int blpapi_Element_isComplexType

(

const blpapi_Element_t *

element

)

blpapi_Element_isNull()

int blpapi_Element_isNull

(

const blpapi_Element_t *

element

)

blpapi_Element_isNullValue()

int blpapi_Element_isNullValue	(	const blpapi_Element_t *	element,
		size_t	position
	)

blpapi_Element_isReadOnly()

int blpapi_Element_isReadOnly

(

const blpapi_Element_t *

element

)

blpapi_Element_name()

blpapi_Name_t* blpapi_Element_name

(

const blpapi_Element_t *

element

)

blpapi_Element_nameString()

const char* blpapi_Element_nameString

(

const blpapi_Element_t *

element

)

blpapi_Element_numElements()

size_t blpapi_Element_numElements

(

const blpapi_Element_t *

element

)

blpapi_Element_numValues()

size_t blpapi_Element_numValues

(

const blpapi_Element_t *

element

)

blpapi_Element_print()

int blpapi_Element_print	(	const blpapi_Element_t *	element,
		blpapi_StreamWriter_t	streamWriter,
		void *	stream,
		int	level,
		int	spacesPerLevel
	)

blpapi_Element_setChoice()

int blpapi_Element_setChoice	(	blpapi_Element_t *	element,
		blpapi_Element_t **	resultElement,
		const char *	nameCstr,
		const blpapi_Name_t *	name,
		size_t	index
	)

blpapi_Element_setElementBool()

int blpapi_Element_setElementBool	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Bool_t	value
	)

blpapi_Element_setElementBytes()

int blpapi_Element_setElementBytes	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		const char *	value,
		size_t	length
	)

blpapi_Element_setElementChar()

int blpapi_Element_setElementChar	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Char_t	value
	)

blpapi_Element_setElementDatetime()

int blpapi_Element_setElementDatetime	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		const blpapi_Datetime_t *	value
	)

blpapi_Element_setElementFloat32()

int blpapi_Element_setElementFloat32	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Float32_t	value
	)

blpapi_Element_setElementFloat64()

int blpapi_Element_setElementFloat64	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Float64_t	value
	)

blpapi_Element_setElementFromField()

int blpapi_Element_setElementFromField	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Element_t *	sourcebuffer
	)

blpapi_Element_setElementFromName()

int blpapi_Element_setElementFromName	(	blpapi_Element_t *	element,
		const char *	elementName,
		const blpapi_Name_t *	name,
		const blpapi_Name_t *	buffer
	)

blpapi_Element_setElementHighPrecisionDatetime()

int blpapi_Element_setElementHighPrecisionDatetime	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		const blpapi_HighPrecisionDatetime_t *	value
	)

blpapi_Element_setElementInt32()

int blpapi_Element_setElementInt32	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Int32_t	value
	)

blpapi_Element_setElementInt64()

int blpapi_Element_setElementInt64	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		blpapi_Int64_t	value
	)

blpapi_Element_setElementString()

int blpapi_Element_setElementString	(	blpapi_Element_t *	element,
		const char *	nameString,
		const blpapi_Name_t *	name,
		const char *	value
	)

blpapi_Element_setValueBool()

int blpapi_Element_setValueBool	(	blpapi_Element_t *	element,
		blpapi_Bool_t	value,
		size_t	index
	)

blpapi_Element_setValueBytes()

int blpapi_Element_setValueBytes	(	blpapi_Element_t *	element,
		const char *	value,
		size_t	length,
		size_t	index
	)

blpapi_Element_setValueChar()

int blpapi_Element_setValueChar	(	blpapi_Element_t *	element,
		blpapi_Char_t	value,
		size_t	index
	)

blpapi_Element_setValueDatetime()

int blpapi_Element_setValueDatetime	(	blpapi_Element_t *	element,
		const blpapi_Datetime_t *	value,
		size_t	index
	)

blpapi_Element_setValueFloat32()

int blpapi_Element_setValueFloat32	(	blpapi_Element_t *	element,
		blpapi_Float32_t	value,
		size_t	index
	)

blpapi_Element_setValueFloat64()

int blpapi_Element_setValueFloat64	(	blpapi_Element_t *	element,
		blpapi_Float64_t	value,
		size_t	index
	)

blpapi_Element_setValueFromElement()

int blpapi_Element_setValueFromElement	(	blpapi_Element_t *	element,
		blpapi_Element_t *	value,
		size_t	index
	)

blpapi_Element_setValueFromName()

int blpapi_Element_setValueFromName	(	blpapi_Element_t *	element,
		const blpapi_Name_t *	value,
		size_t	index
	)

blpapi_Element_setValueHighPrecisionDatetime()

int blpapi_Element_setValueHighPrecisionDatetime	(	blpapi_Element_t *	element,
		const blpapi_HighPrecisionDatetime_t *	value,
		size_t	index
	)

blpapi_Element_setValueInt32()

int blpapi_Element_setValueInt32	(	blpapi_Element_t *	element,
		blpapi_Int32_t	value,
		size_t	index
	)

blpapi_Element_setValueInt64()

int blpapi_Element_setValueInt64	(	blpapi_Element_t *	element,
		blpapi_Int64_t	value,
		size_t	index
	)

blpapi_Element_setValueString()

int blpapi_Element_setValueString	(	blpapi_Element_t *	element,
		const char *	value,
		size_t	index
	)