My Project
UDK 3.2.7 C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Functions
reader.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 sal_Bool typereg_reader_create (void const *buffer, sal_uInt32 length, sal_Bool copy, enum typereg_Version maxVersion, void **result) SAL_THROW_EXTERN_C()
 Creates a type reader working on a binary blob that represents a UNOIDL type.
REG_DLLPUBLIC void typereg_reader_acquire (void *handle) SAL_THROW_EXTERN_C()
 Increments the reference count of a type reader.
REG_DLLPUBLIC void typereg_reader_release (void *handle) SAL_THROW_EXTERN_C()
 Decrements the reference count of a type reader.
REG_DLLPUBLIC enum typereg_Version typereg_reader_getVersion (void *handle) SAL_THROW_EXTERN_C()
 Returns the binary blob version of a type reader.
REG_DLLPUBLIC void typereg_reader_getDocumentation (void *handle, rtl_uString **result) SAL_THROW_EXTERN_C()
 Returns the documentation of a type reader.
REG_DLLPUBLIC void typereg_reader_getFileName (void *handle, rtl_uString **result) SAL_THROW_EXTERN_C()
 Returns the file name of a type reader.
REG_DLLPUBLIC enum RTTypeClass typereg_reader_getTypeClass (void *handle) SAL_THROW_EXTERN_C()
 Returns the type class of a type reader.
REG_DLLPUBLIC sal_Bool typereg_reader_isPublished (void *handle) SAL_THROW_EXTERN_C()
 Returns whether a type reader is published.
REG_DLLPUBLIC void typereg_reader_getTypeName (void *handle, rtl_uString **result) SAL_THROW_EXTERN_C()
 Returns the type name of a type reader.
REG_DLLPUBLIC sal_uInt16 typereg_reader_getSuperTypeCount (void *handle) SAL_THROW_EXTERN_C()
 Returns the number of super types of a type reader.
REG_DLLPUBLIC void typereg_reader_getSuperTypeName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the type name of a super type of a type reader.
REG_DLLPUBLIC sal_uInt16 typereg_reader_getFieldCount (void *handle) SAL_THROW_EXTERN_C()
 Returns the number of fields of a type reader.
REG_DLLPUBLIC void typereg_reader_getFieldDocumentation (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the documentation of a field of a type reader.
REG_DLLPUBLIC void typereg_reader_getFieldFileName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the file name of a field of a type reader.
REG_DLLPUBLIC RTFieldAccess typereg_reader_getFieldFlags (void *handle, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the flags of a field of a type reader.
REG_DLLPUBLIC void typereg_reader_getFieldName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the name of a field of a type reader.
REG_DLLPUBLIC void typereg_reader_getFieldTypeName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the type name of a field of a type reader.
REG_DLLPUBLIC sal_Bool typereg_reader_getFieldValue (void *handle, sal_uInt16 index, enum RTValueType *type, union RTConstValueUnion *value) SAL_THROW_EXTERN_C()
 Returns the value of a field of a type reader.
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodCount (void *handle) SAL_THROW_EXTERN_C()
 Returns the number of methods of a type reader.
REG_DLLPUBLIC void typereg_reader_getMethodDocumentation (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the documentation of a method of a type reader.
REG_DLLPUBLIC enum RTMethodMode typereg_reader_getMethodFlags (void *handle, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the flags of a method of a type reader.
REG_DLLPUBLIC void typereg_reader_getMethodName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the name of a method of a type reader.
REG_DLLPUBLIC void typereg_reader_getMethodReturnTypeName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the return type name of a method of a type reader.
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodParameterCount (void *handle, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the number of parameters of a method of a type reader.
REG_DLLPUBLIC enum RTParamMode typereg_reader_getMethodParameterFlags (void *handle, sal_uInt16 methodIndex, sal_uInt16 parameterIndex) SAL_THROW_EXTERN_C()
 Returns the flags of a parameter of a method of a type reader.
REG_DLLPUBLIC void typereg_reader_getMethodParameterName (void *handle, rtl_uString **result, sal_uInt16 methodIndex, sal_uInt16 parameterIndex) SAL_THROW_EXTERN_C()
 Returns the name of a parameter of a method of a type reader.
REG_DLLPUBLIC void typereg_reader_getMethodParameterTypeName (void *handle, rtl_uString **result, sal_uInt16 methodIndex, sal_uInt16 parameterIndex) SAL_THROW_EXTERN_C()
 Returns the type name of a parameter of a method of a type reader.
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodExceptionCount (void *handle, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the number of exceptions of a method of a type reader.
REG_DLLPUBLIC void typereg_reader_getMethodExceptionTypeName (void *handle, rtl_uString **result, sal_uInt16 methodIndex, sal_uInt16 exceptionIndex) SAL_THROW_EXTERN_C()
 Returns the type name of an exception of a method of a type reader.
REG_DLLPUBLIC sal_uInt16 typereg_reader_getReferenceCount (void *handle) SAL_THROW_EXTERN_C()
 Returns the number of references of a type reader.
REG_DLLPUBLIC void typereg_reader_getReferenceDocumentation (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the documentation of a reference of a type reader.
REG_DLLPUBLIC RTFieldAccess typereg_reader_getReferenceFlags (void *handle, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the flags of a reference of a type reader.
REG_DLLPUBLIC enum RTReferenceType typereg_reader_getReferenceSort (void *handle, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the sort of a reference of a type reader.
REG_DLLPUBLIC void typereg_reader_getReferenceTypeName (void *handle, rtl_uString **result, sal_uInt16 index) SAL_THROW_EXTERN_C()
 Returns the type name of a reference of a type reader.

Function Documentation

REG_DLLPUBLIC void typereg_reader_acquire ( void *  handle)

Increments the reference count of a type reader.

Parameters
handlea handle on a type reader; may be null
Since
UDK 3.2.0
REG_DLLPUBLIC sal_Bool typereg_reader_create ( void const *  buffer,
sal_uInt32  length,
sal_Bool  copy,
enum typereg_Version  maxVersion,
void **  result 
)

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

If a non-null handle is returned through result, its reference count will be one. Operations on a non-null handle are not multi-thread–safe.

Parameters
bufferthe binary blob representing the type; must point to at least length bytes, and need only be byte-aligned
lengththe size in bytes of the binary blob representing the type
copyif true, the type reader creates an internal copy of the given buffer, and the given buffer is not accessed after this function returns; if false, the type reader works directly on the given buffer, which must remain available unmodified until the type reader is destroyed
maxVersionthe maximum binary blob version the client is prepared to handle; must not be negative
resultan out-parameter obtaining a handle on the type reader; must not be null; if the given binary blob is malformed, or of a version larger than maxVersion, null is returned
Returns
false iff an out-of-memory condition occurred, in which case result is left unchanged, and no type reader is created
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getDocumentation ( void *  handle,
rtl_uString **  result 
)

Returns the documentation of a type reader.

Parameters
handlea handle on a type reader; may be null
resultan out-parameter obtaining the documentation string; must not be null; if handle is null, an empty string is returned; if an out-of-memory condition occurs, a pointer to a null pointer is returned
Since
UDK 3.2.0
REG_DLLPUBLIC sal_uInt16 typereg_reader_getFieldCount ( void *  handle)

Returns the number of fields of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of fields of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getFieldDocumentation ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the documentation of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the field's documentation string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of fields of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getFieldFileName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the file name of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the field's file name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of fields of the given type reader
Since
UDK 3.2.0
Deprecated:
REG_DLLPUBLIC RTFieldAccess typereg_reader_getFieldFlags ( void *  handle,
sal_uInt16  index 
)

Returns the flags of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of fields of the given type reader
Returns
the flags of the given field of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getFieldName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the name of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the field's name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of fields of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getFieldTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the type name of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the field's type name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of fields of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC sal_Bool typereg_reader_getFieldValue ( void *  handle,
sal_uInt16  index,
enum RTValueType type,
union RTConstValueUnion value 
)

Returns the value of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of fields of the given type reader
typean out-parameter obtaining the field value's type; must not be null
valuean out-parameter obtaining the field value's value; must not be null
Returns
false iff an out-of-memory condition occurred, in which case type and value are left unchanged
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getFileName ( void *  handle,
rtl_uString **  result 
)

Returns the file name of a type reader.

Parameters
handlea handle on a type reader; may be null
resultan out-parameter obtaining the file name string; must not be null; if handle is null, an empty string is returned; if an out-of-memory condition occurs, a pointer to a null pointer is returned
Since
UDK 3.2.0
Deprecated:
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodCount ( void *  handle)

Returns the number of methods of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of methods of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getMethodDocumentation ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the documentation of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the methods's documentation string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of methods of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodExceptionCount ( void *  handle,
sal_uInt16  index 
)

Returns the number of exceptions of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of methods of the given type reader
Returns
the number of exceptions of the given method of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getMethodExceptionTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  methodIndex,
sal_uInt16  exceptionIndex 
)

Returns the type name of an exception of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the exception's type name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
methodIndexa valid index into the range of methods of the given type reader
exceptionIndexa valid index into the range of exceptions of the given method
Since
UDK 3.2.0
REG_DLLPUBLIC enum RTMethodMode typereg_reader_getMethodFlags ( void *  handle,
sal_uInt16  index 
)

Returns the flags of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of methods of the given type reader
Returns
the flags of the given method of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getMethodName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the name of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the methods's name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of methods of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodParameterCount ( void *  handle,
sal_uInt16  index 
)

Returns the number of parameters of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of methods of the given type reader
Returns
the number of parameters of the given method of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC enum RTParamMode typereg_reader_getMethodParameterFlags ( void *  handle,
sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
)

Returns the flags of a parameter of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
methodIndexa valid index into the range of methods of the given type reader
parameterIndexa valid index into the range of parameters of the given method
Returns
the flags of the given parameter of the given method of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getMethodParameterName ( void *  handle,
rtl_uString **  result,
sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
)

Returns the name of a parameter of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the parameter's name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
methodIndexa valid index into the range of methods of the given type reader
parameterIndexa valid index into the range of parameters of the given method
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getMethodParameterTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
)

Returns the type name of a parameter of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the parameter's type name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
methodIndexa valid index into the range of methods of the given type reader
parameterIndexa valid index into the range of parameters of the given method
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getMethodReturnTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the return type name of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the methods's return type name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of methods of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC sal_uInt16 typereg_reader_getReferenceCount ( void *  handle)

Returns the number of references of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of references of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getReferenceDocumentation ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the documentation of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the reference's documentation string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of references of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC RTFieldAccess typereg_reader_getReferenceFlags ( void *  handle,
sal_uInt16  index 
)

Returns the flags of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of references of the given type reader
Returns
the flags of the given reference of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC enum RTReferenceType typereg_reader_getReferenceSort ( void *  handle,
sal_uInt16  index 
)

Returns the sort of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of references of the given type reader
Returns
the sort of the given reference of the type reader
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getReferenceTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the type name of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the reference's type name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of references of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC sal_uInt16 typereg_reader_getSuperTypeCount ( void *  handle)

Returns the number of super types of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of super types of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getSuperTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the type name of a super type of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan out-parameter obtaining the super type's type name string; must not be null; if an out-of-memory condition occurs, a pointer to a null pointer is returned
indexa valid index into the range of super types of the given type reader
Since
UDK 3.2.0
REG_DLLPUBLIC enum RTTypeClass typereg_reader_getTypeClass ( void *  handle)

Returns the type class of a type reader.

This function will always return the type class without the internal RT_TYPE_PUBLISHED flag set. Use typereg_reader_isPublished to determine whether a type reader is published.

Parameters
handlea handle on a type reader; may be null
Returns
the type class of the type reader; if handle is null, RT_TYPE_INVALID is returned
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_getTypeName ( void *  handle,
rtl_uString **  result 
)

Returns the type name of a type reader.

Parameters
handlea handle on a type reader; may be null
resultan out-parameter obtaining the type name string; must not be null; if handle is null, an empty string is returned; if an out-of-memory condition occurs, a pointer to a null pointer is returned
Since
UDK 3.2.0
REG_DLLPUBLIC enum typereg_Version typereg_reader_getVersion ( void *  handle)

Returns the binary blob version of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the version of the binary blob from which the type reader was constructed; if handle is null, TYPEREG_VERSION_0 is returned
Since
UDK 3.2.0
REG_DLLPUBLIC sal_Bool typereg_reader_isPublished ( void *  handle)

Returns whether a type reader is published.

Parameters
handlea handle on a type reader; may be null
Returns
whether the type reader is published; if handle is null, sal_False is returned
Since
UDK 3.2.0
REG_DLLPUBLIC void typereg_reader_release ( void *  handle)

Decrements the reference count of a type reader.

If the reference count drops to zero, the type reader is destroyed.

Parameters
handlea handle on a type reader; may be null
Since
UDK 3.2.0