Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


Methods of Class Reader


Reader
Reader();

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

Summary
Creates an invalid type reader.

Reader
Reader(
const void * buffer,
sal_uInt32 length,
bool copy,
typereg_Version maxVersion );

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

Summary
Creates a type reader.
Description

If the given binary blob is malformed, or of a version larger than maxVersion, the created type reader is flagged as invalid.

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 constructor
       returns; if false, the type reader works directly on the given buffer,
       which must remain available unmodified until the underlying type reader
       is destroyed (note that the lifetime of the underlying type reader can be
       different from the lifetime of this Reader instance)

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

       

Reader
Reader(
const Reader & other );

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

Summary
Shares a type reader between two Reader instances.
Parameters
other
another Reader instance
     

~Reader
~Reader();

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

Summary
Destroys this Reader instance.
Description

The underlying type reader is only destroyed if this instance was its last user.


operator=
Reader & operator=(
const Reader & other );

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

Summary
Replaces the underlying type reader.
Parameters
other
any Reader instance

       
Return
this Reader instance

isValid
bool isValid();

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

Summary
Returns whether this type reader is valid.
Return
true iff this type reader is valid

getVersion
typereg_Version getVersion();

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

Summary
Returns the binary blob version of this type reader.
Return
the version of the binary blob from which this type reader was constructed; if this type reader is invalid, TYPEREG_VERSION_0 is returned

getDocumentation
rtl::OUString getDocumentation();

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

Summary
Returns the documentation of this type reader.
Return
the documentation of this type reader; if this type reader is invalid, an empty string is returned

getFileName
rtl::OUString getFileName();

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

D E P R E C A T E D
Summary
Returns the file name of this type reader.
Return
the file name of this type reader; if this type reader is invalid, an empty string is returned

getTypeClass
RTTypeClass getTypeClass();

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

Summary
Returns the type class of this type reader.
Description

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

Return
the type class of this type reader; if this type reader is invalid, RT_TYPE_INVALID is returned

isPublished
bool isPublished();

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

Summary
Returns whether this type reader is published.
Return
whether this type reader is published; if this type reader is invalid, false is returned

getTypeName
rtl::OUString getTypeName();

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

Summary
Returns the type name of this type reader.
Return
the type name of this type reader; if this type reader is invalid, an empty string is returned

getSuperTypeCount
sal_uInt16 getSuperTypeCount();

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

Summary
Returns the number of super types of this type reader.
Return
the number of super types of this type reader; if this type reader is invalid, zero is returned

getSuperTypeName
rtl::OUString getSuperTypeName(
sal_uInt16 index ) const;

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

Summary
Returns the type name of a super type of this type reader.
Parameters
index
a valid index into the range of super types of this type
       reader

       
Return
the type name of the given super type

getFieldCount
sal_uInt16 getFieldCount();

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

Summary
Returns the number of fields of this type reader.
Return
the number of fields of this type reader; if this type reader is invalid, zero is returned

getFieldDocumentation
rtl::OUString getFieldDocumentation(
sal_uInt16 index ) const;

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

Summary
Returns the documentation of a field of this type reader.
Parameters
index
a valid index into the range of fields of this type reader

       
Return
the documentation of the given field

getFieldFileName
rtl::OUString getFieldFileName(
sal_uInt16 index ) const;

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

D E P R E C A T E D
Summary
Returns the file name of a field of this type reader.
Parameters
index
a valid index into the range of fields of this type reader

       
Return
the file name of the given field

getFieldFlags
RTFieldAccess getFieldFlags(
sal_uInt16 index ) const;

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

Summary
Returns the flags of a field of this type reader.
Parameters
index
a valid index into the range of fields of this type reader

       
Return
the flags of the given field

getFieldName
rtl::OUString getFieldName(
sal_uInt16 index ) const;

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

Summary
Returns the name of a field of this type reader.
Parameters
index
a valid index into the range of fields of this type reader

       
Return
the name of the given field

getFieldTypeName
rtl::OUString getFieldTypeName(
sal_uInt16 index ) const;

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

Summary
Returns the type name of a field of this type reader.
Parameters
index
a valid index into the range of fields of this type reader

       
Return
the type name of the given field

getFieldValue
RTConstValue getFieldValue(
sal_uInt16 index ) const;

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

Summary
Returns the value of a field of this type reader.
Parameters
index
a valid index into the range of fields of this type reader

       
Return
the value of the given field

getMethodCount
sal_uInt16 getMethodCount();

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

Summary
Returns the number of methods of this type reader.
Return
the number of methods of this type reader; if this type reader is invalid, zero is returned

getMethodDocumentation
rtl::OUString getMethodDocumentation(
sal_uInt16 index ) const;

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

Summary
Returns the documentation of a method of this type reader.
Parameters
index
a valid index into the range of methods of this type reader

       
Return
the documentation of the given method

getMethodFlags
RTMethodMode getMethodFlags(
sal_uInt16 index ) const;

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

Summary
Returns the flags of a method of this type reader.
Parameters
index
a valid index into the range of methods of this type reader

       
Return
the flags of the given method

getMethodName
rtl::OUString getMethodName(
sal_uInt16 index ) const;

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

Summary
Returns the name of a method of this type reader.
Parameters
index
a valid index into the range of methods of this type reader

       
Return
the name of the given method

getMethodReturnTypeName
rtl::OUString getMethodReturnTypeName(
sal_uInt16 index ) const;

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

Summary
Returns the return type name of a method of this type reader.
Parameters
index
a valid index into the range of methods of this type reader

       
Return
the return type name of the given method

getMethodParameterCount
sal_uInt16 getMethodParameterCount(
sal_uInt16 index ) const;

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

Summary
Returns the number of parameters of a method of this type reader.
Parameters
index
a valid index into the range of methods of this type reader

       
Return
the number of parameters of the given method

getMethodParameterFlags
RTParamMode getMethodParameterFlags(
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex ) const;

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

Summary
Returns the flags of a parameter of a method of this type reader.
Parameters
methodIndex
a valid index into the range of methods of this type
       reader

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

       
Return
the flags of the given method parameter

getMethodParameterName
rtl::OUString getMethodParameterName(
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex ) const;

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

Summary
Returns the name of a parameter of a method of this type reader.
Parameters
methodIndex
a valid index into the range of methods of this type
       reader

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

       
Return
the name of the given method parameter

getMethodParameterTypeName
rtl::OUString getMethodParameterTypeName(
sal_uInt16 methodIndex,
sal_uInt16 parameterIndex ) const;

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

Summary
Returns the type name of a parameter of a method of this type reader.
Parameters
methodIndex
a valid index into the range of methods of this type
       reader

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

       
Return
the type name of the given method parameter

getMethodExceptionCount
sal_uInt16 getMethodExceptionCount(
sal_uInt16 index ) const;

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

Summary
Returns the number of exceptions of a method of this type reader.
Parameters
index
a valid index into the range of methods of this type reader

       
Return
the number of exceptions of the given method

getMethodExceptionTypeName
rtl::OUString getMethodExceptionTypeName(
sal_uInt16 methodIndex,
sal_uInt16 exceptionIndex ) const;

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

Summary
Returns the type name of an exception of a method of this type reader.
Parameters
methodIndex
a valid index into the range of methods of this type
       reader

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

       
Return
the type name of the given method exception

getReferenceCount
sal_uInt16 getReferenceCount();

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

Summary
Returns the number of references of this type reader.
Return
the number of references of this type reader; if this type reader is invalid, zero is returned

getReferenceDocumentation
rtl::OUString getReferenceDocumentation(
sal_uInt16 index ) const;

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

Summary
Returns the documentation of a reference of this type reader.
Parameters
index
a valid index into the range of references of this type
       reader

       
Return
the documentation of the given reference

getReferenceFlags
RTFieldAccess getReferenceFlags(
sal_uInt16 index ) const;

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

Summary
Returns the flags of a reference of this type reader.
Parameters
index
a valid index into the range of references of this type
       reader

       
Return
the flags of the given reference

getReferenceSort
RTReferenceType getReferenceSort(
sal_uInt16 index ) const;

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

Summary
Returns the sort of a reference of this type reader.
Parameters
index
a valid index into the range of references of this type
       reader

       
Return
the sort of the given reference

getReferenceTypeName
rtl::OUString getReferenceTypeName(
sal_uInt16 index ) const;

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

Summary
Returns the type name of a reference of this type reader.
Parameters
index
a valid index into the range of references of this type
       reader

       
Return
the type name of the given reference

Top of Page

Apache Software Foundation

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

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, 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.