LibreOffice Module registry (master)  1
Functions
writer.h File Reference
#include <registry/regdllapi.h>
#include <registry/types.hxx>
#include <registry/version.h>
#include <rtl/ustring.h>
#include <sal/types.h>
Include dependency graph for writer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

REG_DLLPUBLIC voidtypereg_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. More...
 
REG_DLLPUBLIC void typereg_writer_destroy (void *handle) SAL_THROW_EXTERN_C()
 Destroys a type writer. More...
 
REG_DLLPUBLIC sal_Bool typereg_writer_setSuperTypeName (void const *handle, sal_uInt16 index, rtl_uString const *typeName) SAL_THROW_EXTERN_C()
 Sets the type name of a super type of a type writer. More...
 
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. More...
 
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. More...
 
REG_DLLPUBLIC sal_Bool typereg_writer_setMethodParameterData (void const *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. More...
 
REG_DLLPUBLIC sal_Bool typereg_writer_setMethodExceptionTypeName (void const *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. More...
 
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. More...
 
REG_DLLPUBLIC void const * typereg_writer_getBlob (void *handle, sal_uInt32 *size) SAL_THROW_EXTERN_C()
 Returns the blob of a type writer. More...
 

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
versionthe version of the created type writer; must not be negative
documentationthe documentation; must not be null
fileNamethe file name; must not be null (deprecated, use an empty string)
typeClassthe type class of the created type writer
publishedwhether the created type writer is published; for a type class that cannot be published, this should be false
typeNamethe type name of the created type writer; must not be null
superTypeCountthe number of super types of the created type writer
fieldCountthe number of fields of the created type writer
methodCountthe number of methods of the created type writer
referenceCountthe 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
Available since:
UDK 3.2.0

Definition at line 1245 of file reflwrit.cxx.

References SAL_THROW_EXTERN_C.

Referenced by createEntry().

REG_DLLPUBLIC void typereg_writer_destroy ( void handle)

Destroys a type writer.

Parameters
handlea handle on a type writer obtained from a call to typereg_writer_create; must not be null
Available since:
UDK 3.2.0

Definition at line 1262 of file reflwrit.cxx.

References SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::~Writer().

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

Returns the blob of a type writer.

Parameters
handlea handle on a type writer; must not be null
sizean 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

Definition at line 1202 of file reflwrit.cxx.

References SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::getBlob(), getBlop(), and getBlopSize().

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
handlea handle on a type writer; must not be null
indexa valid index into the range of fields of the given type writer
documentationthe documentation of the field; must not be null
fileNamethe file name of the field; must not be null (deprecated, use an empty string)
flagsthe flags of the field
namethe name of the field; must not be null
typeNamethe type name of the field; must not be null
valueTypethe type of the value of the field
valueValuethe value of the value of the field
Returns
false iff an out-of-memory condition occurred, in which case the type writer is not modified
Available since:
UDK 3.2.0

Definition at line 1123 of file reflwrit.cxx.

References index, and SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::setFieldData(), and setFieldData().

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
handlea handle on a type writer; must not be null
indexa valid index into the range of methods of the given type writer
documentationthe documentation of the method; must not be null
flagsthe flags of the method
namethe name of the method; must not be null
returnTypeNamethe return type name of the method; must not be null
parameterCountthe number of parameters of the method
exceptionCountthe number of exceptions of the method
Returns
false iff an out-of-memory condition occurred, in which case the type writer is not modified
Available since:
UDK 3.2.0

Definition at line 1156 of file reflwrit.cxx.

References index, and SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::setMethodData().

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

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

Parameters
handlea handle on a type writer; must not be null
methodIndexa valid index into the range of methods of the given type writer
exceptionIndexa valid index into the range of exceptions of the given method
typeNamethe exception type name; must not be null
Returns
false iff an out-of-memory condition occurred, in which case the type writer is not modified
Available since:
UDK 3.2.0

Definition at line 1188 of file reflwrit.cxx.

References SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::setMethodExceptionTypeName().

REG_DLLPUBLIC sal_Bool typereg_writer_setMethodParameterData ( void const *  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
handlea handle on a type writer; must not be null
methodIndexa valid index into the range of methods of the given type writer
parameterIndexa valid index into the range of parameters of the given method
flagsthe flags of the parameter
namethe name of the parameter; must not be null
typeNamethe type name of the parameter; must not be null
Returns
false iff an out-of-memory condition occurred, in which case the type writer is not modified
Available since:
UDK 3.2.0

Definition at line 1173 of file reflwrit.cxx.

References SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::setMethodParameterData().

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
handlea handle on a type writer; must not be null
indexa valid index into the range of references of the given type writer
documentationthe documentation of the reference; must not be null
sortthe sort of the reference
flagsthe flags of the reference
typeNamethe type name of the reference; must not be null
Returns
false iff an out-of-memory condition occurred, in which case the type writer is not modified
Available since:
UDK 3.2.0

Definition at line 1231 of file reflwrit.cxx.

References index, and SAL_THROW_EXTERN_C.

Referenced by typereg::Writer::setReferenceData().

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

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

Parameters
handlea handle on a type writer; must not be null
indexa valid index into the range of super types of the given type writer
typeNamethe super type name; must not be null
Returns
false iff an out-of-memory condition occurred, in which case the type writer is not modified
Available since:
UDK 3.2.0

Definition at line 1266 of file reflwrit.cxx.

References index, and SAL_THROW_EXTERN_C.

Referenced by createEntry(), and typereg::Writer::setSuperTypeName().