UDK 3.2.7 C/C++ API Reference
|
A type reader working on a binary blob that represents a UNOIDL type. More...
#include <reader.hxx>
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. | |
Reader & | operator= (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. |
A type reader working on a binary blob that represents a UNOIDL type.
Instances of this class are not multi-thread–safe.
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.
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 |
std::bad_alloc | is raised if an out-of-memory condition occurs |
typereg::Reader::Reader | ( | Reader const & | other | ) | [inline] |
typereg::Reader::~Reader | ( | ) | [inline] |
Destroys this Reader
instance.
The underlying type reader is only destroyed if this instance was its last user.
rtl::OUString typereg::Reader::getDocumentation | ( | ) | const [inline] |
Returns the documentation of this type reader.
std::bad_alloc | is raised if an out-of-memory condition occurs |
sal_uInt16 typereg::Reader::getFieldCount | ( | ) | const [inline] |
Returns the number of fields of this type reader.
rtl::OUString typereg::Reader::getFieldDocumentation | ( | sal_uInt16 | index | ) | const [inline] |
Returns the documentation of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is 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.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
RTFieldAccess typereg::Reader::getFieldFlags | ( | sal_uInt16 | index | ) | const [inline] |
Returns the flags of a field of this type reader.
index | a valid index into the range of fields of this type reader |
rtl::OUString typereg::Reader::getFieldName | ( | sal_uInt16 | index | ) | const [inline] |
Returns the name of a field of this type reader.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is 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.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is 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.
index | a valid index into the range of fields of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
rtl::OUString typereg::Reader::getFileName | ( | ) | const [inline] |
Returns the file name of this type reader.
std::bad_alloc | is raised if an out-of-memory condition occurs |
sal_uInt16 typereg::Reader::getMethodCount | ( | ) | const [inline] |
Returns the number of methods of this type reader.
rtl::OUString typereg::Reader::getMethodDocumentation | ( | sal_uInt16 | index | ) | const [inline] |
Returns the documentation of a method of this type reader.
index | a valid index into the range of methods of this type reader |
std::bad_alloc | is 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.
index | a valid index into the range of methods of this type reader |
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.
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 |
std::bad_alloc | is 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.
index | a valid index into the range of methods of this type reader |
rtl::OUString typereg::Reader::getMethodName | ( | sal_uInt16 | index | ) | const [inline] |
Returns the name of a method of this type reader.
index | a valid index into the range of methods of this type reader |
std::bad_alloc | is 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.
index | a valid index into the range of methods of this type reader |
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.
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 |
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.
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 |
std::bad_alloc | is 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.
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 |
std::bad_alloc | is 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.
index | a valid index into the range of methods of this type reader |
std::bad_alloc | is raised if an out-of-memory condition occurs |
sal_uInt16 typereg::Reader::getReferenceCount | ( | ) | const [inline] |
Returns the number of references of this type reader.
rtl::OUString typereg::Reader::getReferenceDocumentation | ( | sal_uInt16 | index | ) | const [inline] |
Returns the documentation of a reference of this type reader.
index | a valid index into the range of references of this type reader |
std::bad_alloc | is 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.
index | a valid index into the range of references of this type reader |
RTReferenceType typereg::Reader::getReferenceSort | ( | sal_uInt16 | index | ) | const [inline] |
Returns the sort of a reference of this type reader.
index | a valid index into the range of references of this type reader |
rtl::OUString typereg::Reader::getReferenceTypeName | ( | sal_uInt16 | index | ) | const [inline] |
Returns the type name of a reference of this type reader.
index | a valid index into the range of references of this type reader |
std::bad_alloc | is 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.
rtl::OUString typereg::Reader::getSuperTypeName | ( | sal_uInt16 | index | ) | const [inline] |
Returns the type name of a super type of this type reader.
index | a valid index into the range of super types of this type reader |
std::bad_alloc | is 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.
RT_TYPE_INVALID
is returned rtl::OUString typereg::Reader::getTypeName | ( | ) | const [inline] |
Returns the type name of this type reader.
std::bad_alloc | is raised if an out-of-memory condition occurs |
typereg_Version typereg::Reader::getVersion | ( | ) | const [inline] |
Returns the binary blob version of this type reader.
TYPEREG_VERSION_0
is returned bool typereg::Reader::isPublished | ( | ) | const [inline] |
Returns whether this type reader is published.
false
is returned bool typereg::Reader::isValid | ( | void | ) | const [inline] |
Returns whether this type reader is valid.