UDK 3.2.7 C/C++ API Reference
Public Member Functions
typereg::Reader Class Reference

A type reader working on a binary blob that represents a UNOIDL type. More...

#include <reader.hxx>

List of all members.

Public Member Functions

 Reader ()
 Creates an invalid type reader.
 Reader (void const *buffer, sal_uInt32 length, bool copy, typereg_Version maxVersion)
 Creates a type reader.
 Reader (Reader const &other)
 Shares a type reader between two Reader instances.
 ~Reader ()
 Destroys this Reader instance.
Readeroperator= (Reader const &other)
 Replaces the underlying type reader.
bool isValid () const
 Returns whether this type reader is valid.
typereg_Version getVersion () const
 Returns the binary blob version of this type reader.
rtl::OUString getDocumentation () const
 Returns the documentation of this type reader.
rtl::OUString getFileName () const
 Returns the file name of this type reader.
RTTypeClass getTypeClass () const
 Returns the type class of this type reader.
bool isPublished () const
 Returns whether this type reader is published.
rtl::OUString getTypeName () const
 Returns the type name of this type reader.
sal_uInt16 getSuperTypeCount () const
 Returns the number of super types of this type reader.
rtl::OUString getSuperTypeName (sal_uInt16 index) const
 Returns the type name of a super type of this type reader.
sal_uInt16 getFieldCount () const
 Returns the number of fields of this type reader.
rtl::OUString getFieldDocumentation (sal_uInt16 index) const
 Returns the documentation of a field of this type reader.
rtl::OUString getFieldFileName (sal_uInt16 index) const
 Returns the file name of a field of this type reader.
RTFieldAccess getFieldFlags (sal_uInt16 index) const
 Returns the flags of a field of this type reader.
rtl::OUString getFieldName (sal_uInt16 index) const
 Returns the name of a field of this type reader.
rtl::OUString getFieldTypeName (sal_uInt16 index) const
 Returns the type name of a field of this type reader.
RTConstValue getFieldValue (sal_uInt16 index) const
 Returns the value of a field of this type reader.
sal_uInt16 getMethodCount () const
 Returns the number of methods of this type reader.
rtl::OUString getMethodDocumentation (sal_uInt16 index) const
 Returns the documentation of a method of this type reader.
RTMethodMode getMethodFlags (sal_uInt16 index) const
 Returns the flags of a method of this type reader.
rtl::OUString getMethodName (sal_uInt16 index) const
 Returns the name of a method of this type reader.
rtl::OUString getMethodReturnTypeName (sal_uInt16 index) const
 Returns the return type name of a method of this type reader.
sal_uInt16 getMethodParameterCount (sal_uInt16 index) const
 Returns the number of parameters of a method of this type reader.
RTParamMode getMethodParameterFlags (sal_uInt16 methodIndex, sal_uInt16 parameterIndex) const
 Returns the flags of a parameter of a method of this type reader.
rtl::OUString getMethodParameterName (sal_uInt16 methodIndex, sal_uInt16 parameterIndex) const
 Returns the name of a parameter of a method of this type reader.
rtl::OUString getMethodParameterTypeName (sal_uInt16 methodIndex, sal_uInt16 parameterIndex) const
 Returns the type name of a parameter of a method of this type reader.
sal_uInt16 getMethodExceptionCount (sal_uInt16 index) const
 Returns the number of exceptions of a method of this type reader.
rtl::OUString getMethodExceptionTypeName (sal_uInt16 methodIndex, sal_uInt16 exceptionIndex) const
 Returns the type name of an exception of a method of this type reader.
sal_uInt16 getReferenceCount () const
 Returns the number of references of this type reader.
rtl::OUString getReferenceDocumentation (sal_uInt16 index) const
 Returns the documentation of a reference of this type reader.
RTFieldAccess getReferenceFlags (sal_uInt16 index) const
 Returns the flags of a reference of this type reader.
RTReferenceType getReferenceSort (sal_uInt16 index) const
 Returns the sort of a reference of this type reader.
rtl::OUString getReferenceTypeName (sal_uInt16 index) const
 Returns the type name of a reference of this type reader.

Detailed Description

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

Instances of this class are not multi-thread–safe.

Since:
UDK 3.2.0

Constructor & Destructor Documentation

typereg::Reader::Reader ( ) [inline]

Creates an invalid type reader.

typereg::Reader::Reader ( void const *  buffer,
sal_uInt32  length,
bool  copy,
typereg_Version  maxVersion 
) [inline]

Creates a type reader.

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

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 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)
maxVersionthe maximum binary blob version the client is prepared to handle; must not be negative
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
typereg::Reader::Reader ( Reader const &  other) [inline]

Shares a type reader between two Reader instances.

Parameters:
otheranother Reader instance
typereg::Reader::~Reader ( ) [inline]

Destroys this Reader instance.

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


Member Function Documentation

rtl::OUString typereg::Reader::getDocumentation ( ) const [inline]

Returns the documentation of this type reader.

Returns:
the documentation of this type reader; if this type reader is invalid, an empty string is returned
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
sal_uInt16 typereg::Reader::getFieldCount ( ) const [inline]

Returns the number of fields of this type reader.

Returns:
the number of fields of this type reader; if this type reader is invalid, zero is returned
rtl::OUString typereg::Reader::getFieldDocumentation ( sal_uInt16  index) const [inline]

Returns the documentation of a field of this type reader.

Parameters:
indexa valid index into the range of fields of this type reader
Returns:
the documentation of the given field
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
rtl::OUString typereg::Reader::getFieldFileName ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of fields of this type reader
Returns:
the file name of the given field
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
Deprecated:
RTFieldAccess typereg::Reader::getFieldFlags ( sal_uInt16  index) const [inline]

Returns the flags of a field of this type reader.

Parameters:
indexa valid index into the range of fields of this type reader
Returns:
the flags of the given field
rtl::OUString typereg::Reader::getFieldName ( sal_uInt16  index) const [inline]

Returns the name of a field of this type reader.

Parameters:
indexa valid index into the range of fields of this type reader
Returns:
the name of the given field
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
rtl::OUString typereg::Reader::getFieldTypeName ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of fields of this type reader
Returns:
the type name of the given field
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
RTConstValue typereg::Reader::getFieldValue ( sal_uInt16  index) const [inline]

Returns the value of a field of this type reader.

Parameters:
indexa valid index into the range of fields of this type reader
Returns:
the value of the given field
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
rtl::OUString typereg::Reader::getFileName ( ) const [inline]

Returns the file name of this type reader.

Returns:
the file name of this type reader; if this type reader is invalid, an empty string is returned
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
Deprecated:
sal_uInt16 typereg::Reader::getMethodCount ( ) const [inline]

Returns the number of methods of this type reader.

Returns:
the number of methods of this type reader; if this type reader is invalid, zero is returned
rtl::OUString typereg::Reader::getMethodDocumentation ( sal_uInt16  index) const [inline]

Returns the documentation of a method of this type reader.

Parameters:
indexa valid index into the range of methods of this type reader
Returns:
the documentation of the given method
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
sal_uInt16 typereg::Reader::getMethodExceptionCount ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of methods of this type reader
Returns:
the number of exceptions of the given method
rtl::OUString typereg::Reader::getMethodExceptionTypeName ( sal_uInt16  methodIndex,
sal_uInt16  exceptionIndex 
) const [inline]

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

Parameters:
methodIndexa valid index into the range of methods of this type reader
exceptionIndexa valid index into the range of exceptions of the given method
Returns:
the type name of the given method exception
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
RTMethodMode typereg::Reader::getMethodFlags ( sal_uInt16  index) const [inline]

Returns the flags of a method of this type reader.

Parameters:
indexa valid index into the range of methods of this type reader
Returns:
the flags of the given method
rtl::OUString typereg::Reader::getMethodName ( sal_uInt16  index) const [inline]

Returns the name of a method of this type reader.

Parameters:
indexa valid index into the range of methods of this type reader
Returns:
the name of the given method
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
sal_uInt16 typereg::Reader::getMethodParameterCount ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of methods of this type reader
Returns:
the number of parameters of the given method
RTParamMode typereg::Reader::getMethodParameterFlags ( sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
) const [inline]

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

Parameters:
methodIndexa valid index into the range of methods of this type reader
parameterIndexa valid index into the range of parameters of the given method
Returns:
the flags of the given method parameter
rtl::OUString typereg::Reader::getMethodParameterName ( sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
) const [inline]

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

Parameters:
methodIndexa valid index into the range of methods of this type reader
parameterIndexa valid index into the range of parameters of the given method
Returns:
the name of the given method parameter
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
rtl::OUString typereg::Reader::getMethodParameterTypeName ( sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
) const [inline]

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

Parameters:
methodIndexa valid index into the range of methods of this type reader
parameterIndexa valid index into the range of parameters of the given method
Returns:
the type name of the given method parameter
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
rtl::OUString typereg::Reader::getMethodReturnTypeName ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of methods of this type reader
Returns:
the return type name of the given method
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
sal_uInt16 typereg::Reader::getReferenceCount ( ) const [inline]

Returns the number of references of this type reader.

Returns:
the number of references of this type reader; if this type reader is invalid, zero is returned
rtl::OUString typereg::Reader::getReferenceDocumentation ( sal_uInt16  index) const [inline]

Returns the documentation of a reference of this type reader.

Parameters:
indexa valid index into the range of references of this type reader
Returns:
the documentation of the given reference
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
RTFieldAccess typereg::Reader::getReferenceFlags ( sal_uInt16  index) const [inline]

Returns the flags of a reference of this type reader.

Parameters:
indexa valid index into the range of references of this type reader
Returns:
the flags of the given reference
RTReferenceType typereg::Reader::getReferenceSort ( sal_uInt16  index) const [inline]

Returns the sort of a reference of this type reader.

Parameters:
indexa valid index into the range of references of this type reader
Returns:
the sort of the given reference
rtl::OUString typereg::Reader::getReferenceTypeName ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of references of this type reader
Returns:
the type name of the given reference
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
sal_uInt16 typereg::Reader::getSuperTypeCount ( ) const [inline]

Returns the number of super types of this type reader.

Returns:
the number of super types of this type reader; if this type reader is invalid, zero is returned
rtl::OUString typereg::Reader::getSuperTypeName ( sal_uInt16  index) const [inline]

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

Parameters:
indexa valid index into the range of super types of this type reader
Returns:
the type name of the given super type
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
RTTypeClass typereg::Reader::getTypeClass ( ) const [inline]

Returns the type class of this type reader.

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.

Returns:
the type class of this type reader; if this type reader is invalid, RT_TYPE_INVALID is returned
rtl::OUString typereg::Reader::getTypeName ( ) const [inline]

Returns the type name of this type reader.

Returns:
the type name of this type reader; if this type reader is invalid, an empty string is returned
Exceptions:
std::bad_allocis raised if an out-of-memory condition occurs
typereg_Version typereg::Reader::getVersion ( ) const [inline]

Returns the binary blob version of this type reader.

Returns:
the version of the binary blob from which this type reader was constructed; if this type reader is invalid, TYPEREG_VERSION_0 is returned
bool typereg::Reader::isPublished ( ) const [inline]

Returns whether this type reader is published.

Returns:
whether this type reader is published; if this type reader is invalid, false is returned
bool typereg::Reader::isValid ( void  ) const [inline]

Returns whether this type reader is valid.

Returns:
true iff this type reader is valid
Reader& typereg::Reader::operator= ( Reader const &  other) [inline]

Replaces the underlying type reader.

Parameters:
otherany Reader instance
Returns:
this Reader instance

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines