LibreOffice Module registry (master) 1
|
#include <registry/regdllapi.h>
#include <registry/types.hxx>
#include <registry/version.h>
#include <rtl/ustring.h>
#include <sal/types.h>
Go to the source code of this file.
Functions | |
REG_DLLPUBLIC bool | typereg_reader_create (void const *buffer, sal_uInt32 length, void **result) |
Creates a type reader working on a binary blob that represents a UNOIDL type. More... | |
REG_DLLPUBLIC void | typereg_reader_acquire (void *handle) |
Increments the reference count of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_release (void *handle) |
Decrements the reference count of a type reader. More... | |
REG_DLLPUBLIC typereg_Version | typereg_reader_getVersion (void const *handle) |
Returns the binary blob version of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getDocumentation (void *handle, rtl_uString **result) |
Returns the documentation of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getFileName (void *handle, rtl_uString **result) |
Returns the file name of a type reader. More... | |
REG_DLLPUBLIC RTTypeClass | typereg_reader_getTypeClass (void *handle) |
Returns the type class of a type reader. More... | |
REG_DLLPUBLIC bool | typereg_reader_isPublished (void *handle) |
Returns whether a type reader is published. More... | |
REG_DLLPUBLIC void | typereg_reader_getTypeName (void *handle, rtl_uString **result) |
Returns the type name of a type reader. More... | |
REG_DLLPUBLIC sal_uInt16 | typereg_reader_getSuperTypeCount (void *handle) |
Returns the number of super types of a type reader. More... | |
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. More... | |
REG_DLLPUBLIC sal_uInt16 | typereg_reader_getFieldCount (void *handle) |
Returns the number of fields of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getFieldDocumentation (void *handle, rtl_uString **result, sal_uInt16 index) |
Returns the documentation of a field of a type reader. More... | |
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. More... | |
REG_DLLPUBLIC RTFieldAccess | typereg_reader_getFieldFlags (void *handle, sal_uInt16 index) |
Returns the flags of a field of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getFieldName (void *handle, rtl_uString **result, sal_uInt16 index) |
Returns the name of a field of a type reader. More... | |
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. More... | |
REG_DLLPUBLIC bool | typereg_reader_getFieldValue (void *handle, sal_uInt16 index, RTValueType *type, union RTConstValueUnion *value) |
Returns the value of a field of a type reader. More... | |
REG_DLLPUBLIC sal_uInt16 | typereg_reader_getMethodCount (void *handle) |
Returns the number of methods of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getMethodDocumentation (void *handle, rtl_uString **result, sal_uInt16 index) |
Returns the documentation of a method of a type reader. More... | |
REG_DLLPUBLIC RTMethodMode | typereg_reader_getMethodFlags (void *handle, sal_uInt16 index) |
Returns the flags of a method of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getMethodName (void *handle, rtl_uString **result, sal_uInt16 index) |
Returns the name of a method of a type reader. More... | |
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. More... | |
REG_DLLPUBLIC sal_uInt16 | typereg_reader_getMethodParameterCount (void *handle, sal_uInt16 index) |
Returns the number of parameters of a method of a type reader. More... | |
REG_DLLPUBLIC 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. More... | |
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. More... | |
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. More... | |
REG_DLLPUBLIC sal_uInt16 | typereg_reader_getMethodExceptionCount (void *handle, sal_uInt16 index) |
Returns the number of exceptions of a method of a type reader. More... | |
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. More... | |
REG_DLLPUBLIC sal_uInt16 | typereg_reader_getReferenceCount (void *handle) |
Returns the number of references of a type reader. More... | |
REG_DLLPUBLIC void | typereg_reader_getReferenceDocumentation (void *handle, rtl_uString **result, sal_uInt16 index) |
Returns the documentation of a reference of a type reader. More... | |
REG_DLLPUBLIC RTFieldAccess | typereg_reader_getReferenceFlags (void *handle, sal_uInt16 index) |
Returns the flags of a reference of a type reader. More... | |
REG_DLLPUBLIC RTReferenceType | typereg_reader_getReferenceSort (void *handle, sal_uInt16 index) |
Returns the sort of a reference of a type reader. More... | |
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. More... | |
REG_DLLPUBLIC void typereg_reader_acquire | ( | void * | handle | ) |
Increments the reference count of a type reader.
handle | a handle on a type reader; may be null |
Definition at line 1169 of file reflread.cxx.
Referenced by typereg::Reader::Reader().
REG_DLLPUBLIC bool typereg_reader_create | ( | void const * | buffer, |
sal_uInt32 | length, | ||
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.
The type reader works directly on the given buffer, which must remain available unmodified until the type reader is destroyed
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 |
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 |
result
is left unchanged, and no type reader is createdDefinition at line 1135 of file reflread.cxx.
References length, OFFSET_SIZE, result, SAL_MAX_UINT32, SAL_WARN, and TYPEREG_VERSION_1.
Referenced by typereg::Reader::Reader().
REG_DLLPUBLIC void typereg_reader_getDocumentation | ( | void * | handle, |
rtl_uString ** | result | ||
) |
Returns the documentation of a type reader.
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 |
Definition at line 1243 of file reflread.cxx.
References OFFSET_DOKU, and SAL_WARN.
Referenced by typereg::Reader::getDocumentation().
REG_DLLPUBLIC sal_uInt16 typereg_reader_getFieldCount | ( | void * | handle | ) |
Returns the number of fields of a type reader.
handle | a handle on a type reader; may be null |
handle
is null, zero is returnedDefinition at line 1278 of file reflread.cxx.
Referenced by typereg::Reader::getFieldCount().
REG_DLLPUBLIC void typereg_reader_getFieldDocumentation | ( | void * | handle, |
rtl_uString ** | result, | ||
sal_uInt16 | index | ||
) |
Returns the documentation of a field of a type reader.
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 |
Definition at line 1346 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getFieldDocumentation().
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.
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 |
Definition at line 1362 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getFieldFileName().
REG_DLLPUBLIC RTFieldAccess typereg_reader_getFieldFlags | ( | void * | handle, |
sal_uInt16 | index | ||
) |
Returns the flags of a field of a type reader.
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 |
Definition at line 1318 of file reflread.cxx.
References index, and INVALID.
Referenced by typereg::Reader::getFieldFlags().
REG_DLLPUBLIC void typereg_reader_getFieldName | ( | void * | handle, |
rtl_uString ** | result, | ||
sal_uInt16 | index | ||
) |
Returns the name of a field of a type reader.
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 |
Definition at line 1287 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getFieldName().
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.
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 |
Definition at line 1302 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getFieldTypeName().
REG_DLLPUBLIC bool typereg_reader_getFieldValue | ( | void * | handle, |
sal_uInt16 | index, | ||
RTValueType * | type, | ||
union RTConstValueUnion * | value | ||
) |
Returns the value of a field of a type reader.
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 |
value | an out-parameter obtaining the field value's value; must not be null |
type
and value
are left unchangedDefinition at line 1327 of file reflread.cxx.
References index, RT_TYPE_NONE, type, and value.
Referenced by typereg::Reader::getFieldValue().
REG_DLLPUBLIC void typereg_reader_getFileName | ( | void * | handle, |
rtl_uString ** | result | ||
) |
Returns the file name of a type reader.
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 |
Definition at line 1260 of file reflread.cxx.
References OFFSET_FILENAME, and SAL_WARN.
Referenced by typereg::Reader::getFileName().
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodCount | ( | void * | handle | ) |
Returns the number of methods of a type reader.
handle | a handle on a type reader; may be null |
handle
is null, zero is returnedDefinition at line 1379 of file reflread.cxx.
Referenced by typereg::Reader::getMethodCount().
REG_DLLPUBLIC void typereg_reader_getMethodDocumentation | ( | void * | handle, |
rtl_uString ** | result, | ||
sal_uInt16 | index | ||
) |
Returns the documentation of a method of a type reader.
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 |
Definition at line 1506 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodDocumentation().
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodExceptionCount | ( | void * | handle, |
sal_uInt16 | index | ||
) |
Returns the number of exceptions of a method of a type reader.
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 |
Definition at line 1455 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodExceptionCount().
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.
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 |
Definition at line 1465 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodExceptionTypeName().
REG_DLLPUBLIC RTMethodMode typereg_reader_getMethodFlags | ( | void * | handle, |
sal_uInt16 | index | ||
) |
Returns the flags of a method of a type reader.
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 |
Definition at line 1497 of file reflread.cxx.
References index, and INVALID.
Referenced by typereg::Reader::getMethodFlags().
REG_DLLPUBLIC void typereg_reader_getMethodName | ( | void * | handle, |
rtl_uString ** | result, | ||
sal_uInt16 | index | ||
) |
Returns the name of a method of a type reader.
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 |
Definition at line 1388 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodName().
REG_DLLPUBLIC sal_uInt16 typereg_reader_getMethodParameterCount | ( | void * | handle, |
sal_uInt16 | index | ||
) |
Returns the number of parameters of a method of a type reader.
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 |
Definition at line 1404 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodParameterCount().
REG_DLLPUBLIC 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.
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 |
Definition at line 1446 of file reflread.cxx.
References index, and RT_PARAM_INVALID.
Referenced by typereg::Reader::getMethodParameterFlags().
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.
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 |
Definition at line 1430 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodParameterName().
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.
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 |
Definition at line 1414 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodParameterTypeName().
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.
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 |
Definition at line 1481 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getMethodReturnTypeName().
REG_DLLPUBLIC sal_uInt16 typereg_reader_getReferenceCount | ( | void * | handle | ) |
Returns the number of references of a type reader.
handle | a handle on a type reader; may be null |
handle
is null, zero is returnedDefinition at line 1522 of file reflread.cxx.
Referenced by typereg::Reader::getReferenceCount().
REG_DLLPUBLIC void typereg_reader_getReferenceDocumentation | ( | void * | handle, |
rtl_uString ** | result, | ||
sal_uInt16 | index | ||
) |
Returns the documentation of a reference of a type reader.
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 |
Definition at line 1556 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getReferenceDocumentation().
REG_DLLPUBLIC RTFieldAccess typereg_reader_getReferenceFlags | ( | void * | handle, |
sal_uInt16 | index | ||
) |
Returns the flags of a reference of a type reader.
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 |
Definition at line 1572 of file reflread.cxx.
References index, and INVALID.
Referenced by typereg::Reader::getReferenceFlags().
REG_DLLPUBLIC RTReferenceType typereg_reader_getReferenceSort | ( | void * | handle, |
sal_uInt16 | index | ||
) |
Returns the sort of a reference of a type reader.
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 |
Definition at line 1547 of file reflread.cxx.
References index, and INVALID.
Referenced by typereg::Reader::getReferenceSort().
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.
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 |
Definition at line 1531 of file reflread.cxx.
References index.
Referenced by typereg::Reader::getReferenceTypeName().
REG_DLLPUBLIC sal_uInt16 typereg_reader_getSuperTypeCount | ( | void * | handle | ) |
Returns the number of super types of a type reader.
handle | a handle on a type reader; may be null |
handle
is null, zero is returnedDefinition at line 1581 of file reflread.cxx.
Referenced by typereg::Reader::getSuperTypeCount().
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.
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 |
Definition at line 1590 of file reflread.cxx.
References index, and SAL_WARN.
Referenced by typereg::Reader::getSuperTypeName().
REG_DLLPUBLIC 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.
handle | a handle on a type reader; may be null |
handle
is null, RT_TYPE_INVALID
is returnedDefinition at line 1199 of file reflread.cxx.
References OFFSET_TYPE_CLASS, RT_TYPE_INVALID, and SAL_WARN.
Referenced by typereg::Reader::getTypeClass().
REG_DLLPUBLIC void typereg_reader_getTypeName | ( | void * | handle, |
rtl_uString ** | result | ||
) |
Returns the type name of a type reader.
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 |
Definition at line 1225 of file reflread.cxx.
References OFFSET_THIS_TYPE, and SAL_WARN.
Referenced by typereg::Reader::getTypeName().
REG_DLLPUBLIC typereg_Version typereg_reader_getVersion | ( | void const * | handle | ) |
Returns the binary blob version of a type reader.
handle | a handle on a type reader; may be null |
handle
is null, TYPEREG_VERSION_0
is returnedDefinition at line 1188 of file reflread.cxx.
References SAL_WARN, and TYPEREG_VERSION_0.
Referenced by typereg::Reader::getVersion().
REG_DLLPUBLIC bool typereg_reader_isPublished | ( | void * | handle | ) |
Returns whether a type reader is published.
handle | a handle on a type reader; may be null |
handle
is null, false is returnedDefinition at line 1212 of file reflread.cxx.
References OFFSET_TYPE_CLASS, and SAL_WARN.
Referenced by typereg::Reader::isPublished().
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.
handle | a handle on a type reader; may be null |
Definition at line 1177 of file reflread.cxx.
Referenced by typereg::Reader::~Reader().