blpapi_schema.h File Reference

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

Go to the source code of this file.

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

---

Detailed Description

Provide a representation of a schema describing structured messages.

---

Define Documentation

#define INCLUDED_IOSFWD

---

Typedef Documentation

typedef void* blpapi_SchemaElementDefinition_t

typedef void* blpapi_SchemaTypeDefinition_t

---

Function Documentation

BLPAPI_EXPORT blpapi_Name_t* blpapi_SchemaElementDefinition_name

(

const blpapi_SchemaElementDefinition_t *

field

)

BLPAPI_EXPORT const char* blpapi_SchemaElementDefinition_description

(

const blpapi_SchemaElementDefinition_t *

field

)

BLPAPI_EXPORT int blpapi_SchemaElementDefinition_status

(

const blpapi_SchemaElementDefinition_t *

field

)

BLPAPI_EXPORT blpapi_SchemaTypeDefinition_t* blpapi_SchemaElementDefinition_type

(

const blpapi_SchemaElementDefinition_t *

field

)

BLPAPI_EXPORT size_t blpapi_SchemaElementDefinition_numAlternateNames

(

const blpapi_SchemaElementDefinition_t *

field

)

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

BLPAPI_EXPORT size_t blpapi_SchemaElementDefinition_minValues

(

const blpapi_SchemaElementDefinition_t *

field

)

BLPAPI_EXPORT size_t blpapi_SchemaElementDefinition_maxValues

(

const blpapi_SchemaElementDefinition_t *

field

)

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

BLPAPI_EXPORT void blpapi_SchemaElementDefinition_setUserData	(	blpapi_SchemaElementDefinition_t *	field,
		void *	userdata
	)

BLPAPI_EXPORT void* blpapi_SchemaElementDefinition_userData

(

const blpapi_SchemaElementDefinition_t *

field

)

BLPAPI_EXPORT blpapi_Name_t* blpapi_SchemaTypeDefinition_name

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT const char* blpapi_SchemaTypeDefinition_description

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_status

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_datatype

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_isComplexType

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_isSimpleType

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_isEnumerationType

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_isComplex

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_isSimple

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT int blpapi_SchemaTypeDefinition_isEnumeration

(

const blpapi_SchemaTypeDefinition_t *

type

)

BLPAPI_EXPORT size_t blpapi_SchemaTypeDefinition_numElementDefinitions

(

const blpapi_SchemaTypeDefinition_t *

type

)

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

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

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

BLPAPI_EXPORT void blpapi_SchemaTypeDefinition_setUserData	(	blpapi_SchemaTypeDefinition_t *	element,
		void *	userdata
	)

BLPAPI_EXPORT void* blpapi_SchemaTypeDefinition_userData

(

const blpapi_SchemaTypeDefinition_t *

element

)

BLPAPI_EXPORT blpapi_ConstantList_t* blpapi_SchemaTypeDefinition_enumeration

(

const blpapi_SchemaTypeDefinition_t *

element

)