The Free and Open Productivity Suite
Follow us on Twitter: @ApacheOO

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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


typereg_reader_acquire
extern "C"
void typereg_reader_acquire(
void * handle );

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

Summary
Increments the reference count of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
Since
UDK 3.2.0

typereg_reader_create
extern "C"
sal_Bool typereg_reader_create(
const void * buffer,
sal_uInt32 length,
sal_Bool copy,
typereg_Version maxVersion,
void * * result );

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

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

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
buffer
the binary blob representing the type; must point to at least
   length bytes, and need only be byte-aligned

   
length
the size in bytes of the binary blob representing the type

   
copy
if 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

   
maxVersion
the maximum binary blob version the client is prepared to
   handle; must not be negative

   
result
an 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

   
Return
false iff an out-of-memory condition occured, in which case result is left unchanged, and no type reader is created
Since
UDK 3.2.0

typereg_reader_getDocumentation
extern "C"
void typereg_reader_getDocumentation(
void * handle,
rtl_uString * * result );

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

Summary
Returns the documentation of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
result
an 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

typereg_reader_getFieldCount
extern "C"
sal_uInt16 typereg_reader_getFieldCount(
void * handle );

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

Summary
Returns the number of fields of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
Return
the number of fields of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0

typereg_reader_getFieldDocumentation
extern "C"
void typereg_reader_getFieldDocumentation(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the documentation of a field of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of fields of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getFieldFileName
extern "C"
void typereg_reader_getFieldFileName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

D E P R E C A T E D
Summary
Returns the file name of a field of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of fields of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getFieldFlags
extern "C"
RTFieldAccess typereg_reader_getFieldFlags(
void * handle,
sal_uInt16 index );

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

Summary
Returns the flags of a field of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of fields of the given type reader

   
Return
the flags of the given field of the type reader
Since
UDK 3.2.0

typereg_reader_getFieldName
extern "C"
void typereg_reader_getFieldName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the name of a field of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of fields of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getFieldTypeName
extern "C"
void typereg_reader_getFieldTypeName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the type name of a field of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of fields of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getFieldValue
extern "C"
sal_Bool typereg_reader_getFieldValue(
void * handle,
sal_uInt16 index,
RTValueType * type,
RTConstValueUnion * value );

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

Summary
Returns the value of a field of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of fields of the given type reader

   
type
an out-parameter obtaining the field value's type; must not be
   null

   
result
an out-parameter obtaining the field value's value; must not be
   null

   
Return
false iff an out-of-memory condition occured, in which case type and value are left unchanged
Since
UDK 3.2.0

typereg_reader_getFileName
extern "C"
void typereg_reader_getFileName(
void * handle,
rtl_uString * * result );

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

D E P R E C A T E D
Summary
Returns the file name of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
result
an 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

typereg_reader_getMethodCount
extern "C"
sal_uInt16 typereg_reader_getMethodCount(
void * handle );

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

Summary
Returns the number of methods of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
Return
the number of methods of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0

typereg_reader_getMethodDocumentation
extern "C"
void typereg_reader_getMethodDocumentation(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the documentation of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of methods of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getMethodExceptionCount
extern "C"
sal_uInt16 typereg_reader_getMethodExceptionCount(
void * handle,
sal_uInt16 index );

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

Summary
Returns the number of exceptions of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of methods of the given type reader

   
Return
the number of exceptions of the given method of the type reader
Since
UDK 3.2.0

typereg_reader_getMethodExceptionTypeName
extern "C"
void typereg_reader_getMethodExceptionTypeName(
void * handle,
rtl_uString * * result,
sal_uInt16 methodIndex,
sal_uInt16 exceptionIndex );

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

Summary
Returns the type name of an exception of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
methodIndex
a valid index into the range of methods of the given type
   reader

   
exceptionIndex
a valid index into the range of exceptions of the given
   method

   
Since
UDK 3.2.0

typereg_reader_getMethodFlags
extern "C"
RTMethodMode typereg_reader_getMethodFlags(
void * handle,
sal_uInt16 index );

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

Summary
Returns the flags of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of methods of the given type reader

   
Return
the flags of the given method of the type reader
Since
UDK 3.2.0

typereg_reader_getMethodName
extern "C"
void typereg_reader_getMethodName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the name of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of methods of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getMethodParameterCount
extern "C"
sal_uInt16 typereg_reader_getMethodParameterCount(
void * handle,
sal_uInt16 index );

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

Summary
Returns the number of parameters of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of methods of the given type reader

   
Return
the number of parameters of the given method of the type reader
Since
UDK 3.2.0

typereg_reader_getMethodParameterFlags
extern "C"
RTParamMode typereg_reader_getMethodParameterFlags(
void * handle,
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex );

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

Summary
Returns the flags of a parameter of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
methodIndex
a valid index into the range of methods of the given type
   reader

   
parameterIndex
a valid index into the range of parameters of the given
   method

   
Return
the flags of the given parameter of the given method of the type reader
Since
UDK 3.2.0

typereg_reader_getMethodParameterName
extern "C"
void typereg_reader_getMethodParameterName(
void * handle,
rtl_uString * * result,
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex );

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

Summary
Returns the name of a parameter of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
methodIndex
a valid index into the range of methods of the given type
   reader

   
parameterIndex
a valid index into the range of parameters of the given
   method

   
Since
UDK 3.2.0

typereg_reader_getMethodParameterTypeName
extern "C"
void typereg_reader_getMethodParameterTypeName(
void * handle,
rtl_uString * * result,
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex );

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

Summary
Returns the type name of a parameter of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
methodIndex
a valid index into the range of methods of the given type
   reader

   
parameterIndex
a valid index into the range of parameters of the given
   method

   
Since
UDK 3.2.0

typereg_reader_getMethodReturnTypeName
extern "C"
void typereg_reader_getMethodReturnTypeName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the return type name of a method of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of methods of the given type reader

   
Since
UDK 3.2.0

typereg_reader_getReferenceCount
extern "C"
sal_uInt16 typereg_reader_getReferenceCount(
void * handle );

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

Summary
Returns the number of references of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
Return
the number of references of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0

typereg_reader_getReferenceDocumentation
extern "C"
void typereg_reader_getReferenceDocumentation(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the documentation of a reference of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of references of the given type
   reader

   
Since
UDK 3.2.0

typereg_reader_getReferenceFlags
extern "C"
RTFieldAccess typereg_reader_getReferenceFlags(
void * handle,
sal_uInt16 index );

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

Summary
Returns the flags of a reference of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of references of the given type
   reader

   
Return
the flags of the given reference of the type reader
Since
UDK 3.2.0

typereg_reader_getReferenceSort
extern "C"
RTReferenceType typereg_reader_getReferenceSort(
void * handle,
sal_uInt16 index );

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

Summary
Returns the sort of a reference of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
index
a valid index into the range of references of the given type
   reader

   
Return
the sort of the given reference of the type reader
Since
UDK 3.2.0

typereg_reader_getReferenceTypeName
extern "C"
void typereg_reader_getReferenceTypeName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the type name of a reference of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of references of the given type
   reader

   
Since
UDK 3.2.0

typereg_reader_getSuperTypeCount
extern "C"
sal_uInt16 typereg_reader_getSuperTypeCount(
void * handle );

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

Summary
Returns the number of super types of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
Return
the number of super types of the type reader; if handle is null, zero is returned
Since
UDK 3.2.0

typereg_reader_getSuperTypeName
extern "C"
void typereg_reader_getSuperTypeName(
void * handle,
rtl_uString * * result,
sal_uInt16 index );

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

Summary
Returns the type name of a super type of a type reader.
Parameters
handle
a handle on a type reader; must not be null

   
result
an 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

   
index
a valid index into the range of super types of the given type
   reader

   
Since
UDK 3.2.0

typereg_reader_getTypeClass
extern "C"
RTTypeClass typereg_reader_getTypeClass(
void * handle );

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

Summary
Returns the type class of a type reader.
Description

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
handle
a handle on a type reader; may be null

   
Return
the type class of the type reader; if handle is null, RT_TYPE_INVALID is returned
Since
UDK 3.2.0

typereg_reader_getTypeName
extern "C"
void typereg_reader_getTypeName(
void * handle,
rtl_uString * * result );

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

Summary
Returns the type name of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
result
an 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

typereg_reader_getVersion
extern "C"
typereg_Version typereg_reader_getVersion(
void * handle );

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

Summary
Returns the binary blob version of a type reader.
Parameters
handle
a handle on a type reader; may be null

   
Return
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

typereg_reader_isPublished
extern "C"
sal_Bool typereg_reader_isPublished(
void * handle );

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

Summary
Returns whether a type reader is published.
Parameters
handle
a handle on a type reader; may be null

   
Return
whether the type reader is published; if handle is null, sal_False is returned
Since
UDK 3.2.0

typereg_reader_release
extern "C"
void typereg_reader_release(
void * handle );

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

Summary
Decrements the reference count of a type reader.
Description

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

Parameters
handle
a handle on a type reader; may be null

   
Since
UDK 3.2.0

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.