writer.h File Reference

#include "registry/regdllapi.h"
#include "registry/types.h"
#include "registry/version.h"
#include "rtl/ustring.h"
#include "sal/types.h"

Go to the source code of this file.

Functions
REG_DLLPUBLIC void *	typereg_writer_create (typereg_Version version, rtl_uString const *documentation, rtl_uString const *fileName, RTTypeClass typeClass, sal_Bool published, rtl_uString const *typeName, sal_uInt16 superTypeCount, sal_uInt16 fieldCount, sal_uInt16 methodCount, sal_uInt16 referenceCount) SAL_THROW_EXTERN_C()
	Creates a type writer working on a binary blob that represents a UNOIDL type.
REG_DLLPUBLIC void	typereg_writer_destroy (void *handle) SAL_THROW_EXTERN_C()
	Destroys a type writer.
REG_DLLPUBLIC sal_Bool	typereg_writer_setSuperTypeName (void *handle, sal_uInt16 index, rtl_uString const *typeName) SAL_THROW_EXTERN_C()
	Sets the type name of a super type of a type writer.
REG_DLLPUBLIC sal_Bool	typereg_writer_setFieldData (void *handle, sal_uInt16 index, rtl_uString const *documentation, rtl_uString const *fileName, RTFieldAccess flags, rtl_uString const *name, rtl_uString const *typeName, RTValueType valueType, RTConstValueUnion valueValue) SAL_THROW_EXTERN_C()
	Sets the data of a field of a type writer.
REG_DLLPUBLIC sal_Bool	typereg_writer_setMethodData (void *handle, sal_uInt16 index, rtl_uString const *documentation, RTMethodMode flags, rtl_uString const *name, rtl_uString const *returnTypeName, sal_uInt16 parameterCount, sal_uInt16 exceptionCount) SAL_THROW_EXTERN_C()
	Sets the data of a method of a type writer.
REG_DLLPUBLIC sal_Bool	typereg_writer_setMethodParameterData (void *handle, sal_uInt16 methodIndex, sal_uInt16 parameterIndex, RTParamMode flags, rtl_uString const *name, rtl_uString const *typeName) SAL_THROW_EXTERN_C()
	Sets the data of a parameter of a method of a type writer.
REG_DLLPUBLIC sal_Bool	typereg_writer_setMethodExceptionTypeName (void *handle, sal_uInt16 methodIndex, sal_uInt16 exceptionIndex, rtl_uString const *typeName) SAL_THROW_EXTERN_C()
	Sets an exception type name of a method of a type writer.
REG_DLLPUBLIC sal_Bool	typereg_writer_setReferenceData (void *handle, sal_uInt16 index, rtl_uString const *documentation, RTReferenceType sort, RTFieldAccess flags, rtl_uString const *typeName) SAL_THROW_EXTERN_C()
	Sets the data of a reference of a type writer.
REG_DLLPUBLIC void const *	typereg_writer_getBlob (void *handle, sal_uInt32 *size) SAL_THROW_EXTERN_C()
	Returns the blob of a type writer.

Function Documentation

REG_DLLPUBLIC void* typereg_writer_create	(	typereg_Version	version,
		rtl_uString const *	documentation,
		rtl_uString const *	fileName,
		RTTypeClass	typeClass,
		sal_Bool	published,
		rtl_uString const *	typeName,
		sal_uInt16	superTypeCount,
		sal_uInt16	fieldCount,
		sal_uInt16	methodCount,
		sal_uInt16	referenceCount
	)

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

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

Returns

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

REG_DLLPUBLIC void typereg_writer_destroy

(

void *

handle

)

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

REG_DLLPUBLIC void const* typereg_writer_getBlob	(	void *	handle,
		sal_uInt32 *	size
	)

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

Returns

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

REG_DLLPUBLIC sal_Bool typereg_writer_setFieldData	(	void *	handle,
		sal_uInt16	index,
		rtl_uString const *	documentation,
		rtl_uString const *	fileName,
		RTFieldAccess	flags,
		rtl_uString const *	name,
		rtl_uString const *	typeName,
		RTValueType	valueType,
		RTConstValueUnion	valueValue
	)

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

Returns

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

Since

UDK 3.2.0

REG_DLLPUBLIC sal_Bool typereg_writer_setMethodData	(	void *	handle,
		sal_uInt16	index,
		rtl_uString const *	documentation,
		RTMethodMode	flags,
		rtl_uString const *	name,
		rtl_uString const *	returnTypeName,
		sal_uInt16	parameterCount,
		sal_uInt16	exceptionCount
	)

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

Returns

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

Since

UDK 3.2.0

REG_DLLPUBLIC sal_Bool typereg_writer_setMethodExceptionTypeName	(	void *	handle,
		sal_uInt16	methodIndex,
		sal_uInt16	exceptionIndex,
		rtl_uString const *	typeName
	)

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

Returns

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

Since

UDK 3.2.0

REG_DLLPUBLIC sal_Bool typereg_writer_setMethodParameterData	(	void *	handle,
		sal_uInt16	methodIndex,
		sal_uInt16	parameterIndex,
		RTParamMode	flags,
		rtl_uString const *	name,
		rtl_uString const *	typeName
	)

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

Returns

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

Since

UDK 3.2.0

REG_DLLPUBLIC sal_Bool typereg_writer_setReferenceData	(	void *	handle,
		sal_uInt16	index,
		rtl_uString const *	documentation,
		RTReferenceType	sort,
		RTFieldAccess	flags,
		rtl_uString const *	typeName
	)

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

Returns

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

Since

UDK 3.2.0

REG_DLLPUBLIC sal_Bool typereg_writer_setSuperTypeName	(	void *	handle,
		sal_uInt16	index,
		rtl_uString const *	typeName
	)

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

Returns

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

Since

UDK 3.2.0