Global Functions in Namespace in Sourcefile writer.h

Class

Global Functions in Global Namespace C++
in Sourcefile writer.h

typereg_writer_create

extern "C"
void * typereg_writer_create(

typereg_Version	version,
const rtl_uString *	documentation,
const rtl_uString *	fileName,
RTTypeClass	typeClass,
sal_Bool	published,
const rtl_uString *	typeName,
sal_uInt16	superTypeCount,
sal_uInt16	fieldCount,
sal_uInt16	methodCount,
sal_uInt16	referenceCount );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Creates a type writer working on a binary blob that represents a UNOIDL type.

Description

Operations on a returned handle are not multi-thread–safe.

Parameters

version	the version of the created type writer; must not be negative
documentation	the documentation; must not be null
fileName	the file name; must not be null (deprecated, use an empty string)
typeClass	the type class of the created type writer
published	whether the created type writer is published; for a type class that cannot be published, this should be false
typeName	the type name of the created type writer; must not be null
superTypeCount	the number of super types of the created type writer
fieldCount	the number of fields of the created type writer
methodCount	the number of methods of the created type writer
referenceCount	the number of references of the created type writer

Return

a handle on the type writer; if an out-of-memory condition occurs, null is returned, and no type writer is created

Since

UDK 3.2.0

typereg_writer_destroy

extern "C"
void typereg_writer_destroy(

void *

handle );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Destroys a type writer.

Parameters

handle

a handle on a type writer obtained from a call to
   typereg_writer_create; must not be null

Since

UDK 3.2.0

typereg_writer_getBlob

extern "C"
const void * typereg_writer_getBlob(

void *	handle,
sal_uInt32 *	size );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Returns the blob of a type writer.

Parameters

handle	a handle on a type writer; must not be null
size	an out-parameter obtaining the size of the blob; must not be null

Return

a (byte-aligned) pointer to the blob; the returned pointer and the returned size remain valid until the next function is called on the given type writer; if an out-of-memory condition occurs, null is returned and size is not modified

typereg_writer_setFieldData

extern "C"
sal_Bool typereg_writer_setFieldData(

void *	handle,
sal_uInt16	index,
const rtl_uString *	documentation,
const rtl_uString *	fileName,
RTFieldAccess	flags,
const rtl_uString *	name,
const rtl_uString *	typeName,
RTValueType	valueType,
RTConstValueUnion	valueValue );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Sets the data of a field of a type writer.

Parameters

handle	a handle on a type writer; must not be null
index	a valid index into the range of fields of the given type writer
documentation	the documentation of the field; must not be null
fileName	the file name of the field; must not be null (deprecated, use an empty string)
flags	the flags of the field
name	the name of the field; must not be null
typeName	the type name of the field; must not be null
valueType	the type of the value of the field
valueValue	the value of the value of the field

Return

false iff an out-of-memory condition ocurred, in which case the type writer is not modified

Since

UDK 3.2.0

typereg_writer_setMethodData

extern "C"
sal_Bool typereg_writer_setMethodData(

void *	handle,
sal_uInt16	index,
const rtl_uString *	documentation,
RTMethodMode	flags,
const rtl_uString *	name,
const rtl_uString *	returnTypeName,
sal_uInt16	parameterCount,
sal_uInt16	exceptionCount );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Sets the data of a method of a type writer.

Parameters

handle	a handle on a type writer; must not be null
index	a valid index into the range of methods of the given type writer
documentation	the documentation of the method; must not be null
flags	the flags of the method
name	the name of the method; must not be null
returnTypeName	the return type name of the method; must not be null
parameterCount	the number of parameters of the method
exceptionCount	the number of exceptions of the method

Return

false iff an out-of-memory condition ocurred, in which case the type writer is not modified

Since

UDK 3.2.0

typereg_writer_setMethodExceptionTypeName

extern "C"
sal_Bool typereg_writer_setMethodExceptionTypeName(

void *	handle,
sal_uInt16	methodIndex,
sal_uInt16	exceptionIndex,
const rtl_uString *	typeName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Sets an exception type name of a method of a type writer.

Parameters

handle	a handle on a type writer; must not be null
methodIndex	a valid index into the range of methods of the given type writer
exceptionIndex	a valid index into the range of exceptions of the given method
typeName	the exception type name; must not be null

Return

false iff an out-of-memory condition ocurred, in which case the type writer is not modified

Since

UDK 3.2.0

typereg_writer_setMethodParameterData

extern "C"
sal_Bool typereg_writer_setMethodParameterData(

void *	handle,
sal_uInt16	methodIndex,
sal_uInt16	parameterIndex,
RTParamMode	flags,
const rtl_uString *	name,
const rtl_uString *	typeName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Sets the data of a parameter of a method of a type writer.

Parameters

handle	a handle on a type writer; must not be null
methodIndex	a valid index into the range of methods of the given type writer
parameterIndex	a valid index into the range of parameters of the given method
flags	the flags of the parameter
name	the name of the parameter; must not be null
typeName	the type name of the parameter; must not be null

Return

false iff an out-of-memory condition ocurred, in which case the type writer is not modified

Since

UDK 3.2.0

typereg_writer_setReferenceData

extern "C"
sal_Bool typereg_writer_setReferenceData(

void *	handle,
sal_uInt16	index,
const rtl_uString *	documentation,
RTReferenceType	sort,
RTFieldAccess	flags,
const rtl_uString *	typeName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Sets the data of a reference of a type writer.

Parameters

handle	a handle on a type writer; must not be null
index	a valid index into the range of references of the given type writer
documentation	the documentation of the reference; must not be null
sort	the sort of the reference
flags	the flags of the reference
typeName	the type name of the reference; must not be null

Return

false iff an out-of-memory condition ocurred, in which case the type writer is not modified

Since

UDK 3.2.0

typereg_writer_setSuperTypeName

extern "C"
sal_Bool typereg_writer_setSuperTypeName(

void *	handle,
sal_uInt16	index,
const rtl_uString *	typeName );

virtual	abstract	const	volatile	template	static	inline	C-linkage
NO	NO	NO	NO	NO	NO	NO	YES

Summary

Sets the type name of a super type of a type writer.

Parameters

handle	a handle on a type writer; must not be null
index	a valid index into the range of super types of the given type writer
typeName	the super type name; must not be null

Return

false iff an out-of-memory condition ocurred, in which case the type writer is not modified

Since

UDK 3.2.0

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Global Functions in Global Namespace C++ in Sourcefile writer.h

Global Functions in Global Namespace C++
in Sourcefile writer.h