blpapi_schema.h File Reference

Provide a representation of a schema describing structured messages. More...

#include <blpapi_constant.h>
#include <blpapi_defs.h>
#include <blpapi_exception.h>
#include <blpapi_name.h>
#include <blpapi_streamproxy.h>
#include <blpapi_types.h>

Go to the source code of this file.

Classes
struct	SchemaStatus
class	SchemaElementDefinition
class	SchemaTypeDefinition

Namespaces
	BloombergLP
	BloombergLP::blpapi

Typedefs
typedef void *	blpapi_SchemaTypeDefinition_t

Functions
blpapi_Name_t *	blpapi_SchemaElementDefinition_name (const blpapi_SchemaElementDefinition_t *field)
const char *	blpapi_SchemaElementDefinition_description (const blpapi_SchemaElementDefinition_t *field)
int	blpapi_SchemaElementDefinition_status (const blpapi_SchemaElementDefinition_t *field)
blpapi_SchemaTypeDefinition_t *	blpapi_SchemaElementDefinition_type (const blpapi_SchemaElementDefinition_t *field)
size_t	blpapi_SchemaElementDefinition_numAlternateNames (const blpapi_SchemaElementDefinition_t *field)
blpapi_Name_t *	blpapi_SchemaElementDefinition_getAlternateName (const blpapi_SchemaElementDefinition_t *field, size_t index)
size_t	blpapi_SchemaElementDefinition_minValues (const blpapi_SchemaElementDefinition_t *field)
size_t	blpapi_SchemaElementDefinition_maxValues (const blpapi_SchemaElementDefinition_t *field)
int	blpapi_SchemaElementDefinition_print (const blpapi_SchemaElementDefinition_t *element, blpapi_StreamWriter_t streamWriter, void *userStream, int level, int spacesPerLevel)
void	blpapi_SchemaElementDefinition_setUserData (blpapi_SchemaElementDefinition_t *field, void *userdata)
void *	blpapi_SchemaElementDefinition_userData (const blpapi_SchemaElementDefinition_t *field)
blpapi_Name_t *	blpapi_SchemaTypeDefinition_name (const blpapi_SchemaTypeDefinition_t *type)
const char *	blpapi_SchemaTypeDefinition_description (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_status (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_datatype (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_isComplexType (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_isSimpleType (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_isEnumerationType (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_isComplex (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_isSimple (const blpapi_SchemaTypeDefinition_t *type)
int	blpapi_SchemaTypeDefinition_isEnumeration (const blpapi_SchemaTypeDefinition_t *type)
size_t	blpapi_SchemaTypeDefinition_numElementDefinitions (const blpapi_SchemaTypeDefinition_t *type)
blpapi_SchemaElementDefinition_t *	blpapi_SchemaTypeDefinition_getElementDefinition (const blpapi_SchemaTypeDefinition_t *type, const char *nameString, const blpapi_Name_t *name)
blpapi_SchemaElementDefinition_t *	blpapi_SchemaTypeDefinition_getElementDefinitionAt (const blpapi_SchemaTypeDefinition_t *type, size_t index)
int	blpapi_SchemaTypeDefinition_print (const blpapi_SchemaTypeDefinition_t *element, blpapi_StreamWriter_t streamWriter, void *userStream, int level, int spacesPerLevel)
void	blpapi_SchemaTypeDefinition_setUserData (blpapi_SchemaTypeDefinition_t *element, void *userdata)
void *	blpapi_SchemaTypeDefinition_userData (const blpapi_SchemaTypeDefinition_t *element)
blpapi_ConstantList_t *	blpapi_SchemaTypeDefinition_enumeration (const blpapi_SchemaTypeDefinition_t *element)
std::ostream &	operator<< (std::ostream &stream, const SchemaElementDefinition &element)
std::ostream &	operator<< (std::ostream &stream, const SchemaTypeDefinition &typeDef)

Detailed Description

Provide a representation of a schema describing structured messages.

Typedef Documentation

blpapi_SchemaTypeDefinition_t

typedef void* blpapi_SchemaTypeDefinition_t

Function Documentation

blpapi_SchemaElementDefinition_description()

const char* blpapi_SchemaElementDefinition_description

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_getAlternateName()

blpapi_Name_t* blpapi_SchemaElementDefinition_getAlternateName	(	const blpapi_SchemaElementDefinition_t *	field,
		size_t	index
	)

blpapi_SchemaElementDefinition_maxValues()

size_t blpapi_SchemaElementDefinition_maxValues

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_minValues()

size_t blpapi_SchemaElementDefinition_minValues

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_name()

blpapi_Name_t* blpapi_SchemaElementDefinition_name

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_numAlternateNames()

size_t blpapi_SchemaElementDefinition_numAlternateNames

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_print()

int blpapi_SchemaElementDefinition_print	(	const blpapi_SchemaElementDefinition_t *	element,
		blpapi_StreamWriter_t	streamWriter,
		void *	userStream,
		int	level,
		int	spacesPerLevel
	)

blpapi_SchemaElementDefinition_setUserData()

void blpapi_SchemaElementDefinition_setUserData	(	blpapi_SchemaElementDefinition_t *	field,
		void *	userdata
	)

blpapi_SchemaElementDefinition_status()

int blpapi_SchemaElementDefinition_status

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_type()

blpapi_SchemaTypeDefinition_t* blpapi_SchemaElementDefinition_type

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaElementDefinition_userData()

void* blpapi_SchemaElementDefinition_userData

(

const blpapi_SchemaElementDefinition_t *

field

)

blpapi_SchemaTypeDefinition_datatype()

int blpapi_SchemaTypeDefinition_datatype

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_description()

const char* blpapi_SchemaTypeDefinition_description

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_enumeration()

blpapi_ConstantList_t* blpapi_SchemaTypeDefinition_enumeration

(

const blpapi_SchemaTypeDefinition_t *

element

)

blpapi_SchemaTypeDefinition_getElementDefinition()

blpapi_SchemaElementDefinition_t* blpapi_SchemaTypeDefinition_getElementDefinition	(	const blpapi_SchemaTypeDefinition_t *	type,
		const char *	nameString,
		const blpapi_Name_t *	name
	)

blpapi_SchemaTypeDefinition_getElementDefinitionAt()

blpapi_SchemaElementDefinition_t* blpapi_SchemaTypeDefinition_getElementDefinitionAt	(	const blpapi_SchemaTypeDefinition_t *	type,
		size_t	index
	)

blpapi_SchemaTypeDefinition_isComplex()

int blpapi_SchemaTypeDefinition_isComplex

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_isComplexType()

int blpapi_SchemaTypeDefinition_isComplexType

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_isEnumeration()

int blpapi_SchemaTypeDefinition_isEnumeration

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_isEnumerationType()

int blpapi_SchemaTypeDefinition_isEnumerationType

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_isSimple()

int blpapi_SchemaTypeDefinition_isSimple

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_isSimpleType()

int blpapi_SchemaTypeDefinition_isSimpleType

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_name()

blpapi_Name_t* blpapi_SchemaTypeDefinition_name

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_numElementDefinitions()

size_t blpapi_SchemaTypeDefinition_numElementDefinitions

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_print()

int blpapi_SchemaTypeDefinition_print	(	const blpapi_SchemaTypeDefinition_t *	element,
		blpapi_StreamWriter_t	streamWriter,
		void *	userStream,
		int	level,
		int	spacesPerLevel
	)

blpapi_SchemaTypeDefinition_setUserData()

void blpapi_SchemaTypeDefinition_setUserData	(	blpapi_SchemaTypeDefinition_t *	element,
		void *	userdata
	)

blpapi_SchemaTypeDefinition_status()

int blpapi_SchemaTypeDefinition_status

(

const blpapi_SchemaTypeDefinition_t *

type

)

blpapi_SchemaTypeDefinition_userData()

void* blpapi_SchemaTypeDefinition_userData

(

const blpapi_SchemaTypeDefinition_t *

element

)