LibreOffice Module registry (master) 1
Functions | Variables
reflread.cxx File Reference
#include <sal/config.h>
#include <cstring>
#include <memory>
#include <new>
#include <vector>
#include <sal/types.h>
#include <osl/endian.h>
#include <osl/diagnose.h>
#include <sal/log.hxx>
#include <registry/refltype.hxx>
#include <registry/typereg_reader.hxx>
#include <registry/version.h>
#include "reflcnst.hxx"
#include <cstddef>
Include dependency graph for reflread.cxx:

Go to the source code of this file.

Functions

bool TYPEREG_CALLTYPE 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...
 
void TYPEREG_CALLTYPE typereg_reader_acquire (void *hEntry)
 Increments the reference count of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_release (void *hEntry)
 Decrements the reference count of a type reader. More...
 
typereg_Version TYPEREG_CALLTYPE typereg_reader_getVersion (void const *handle)
 Returns the binary blob version of a type reader. More...
 
RTTypeClass TYPEREG_CALLTYPE typereg_reader_getTypeClass (void *hEntry)
 Returns the type class of a type reader. More...
 
bool TYPEREG_CALLTYPE typereg_reader_isPublished (void *hEntry)
 Returns whether a type reader is published. More...
 
void TYPEREG_CALLTYPE typereg_reader_getTypeName (void *hEntry, rtl_uString **pTypeName)
 Returns the type name of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getDocumentation (void *hEntry, rtl_uString **pDoku)
 Returns the documentation of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getFileName (void *hEntry, rtl_uString **pFileName)
 Returns the file name of a type reader. More...
 
sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getFieldCount (void *hEntry)
 Returns the number of fields of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getFieldName (void *hEntry, rtl_uString **pFieldName, sal_uInt16 index)
 Returns the name of a field of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getFieldTypeName (void *hEntry, rtl_uString **pFieldType, sal_uInt16 index)
 Returns the type name of a field of a type reader. More...
 
RTFieldAccess TYPEREG_CALLTYPE typereg_reader_getFieldFlags (void *hEntry, sal_uInt16 index)
 Returns the flags of a field of a type reader. More...
 
bool TYPEREG_CALLTYPE typereg_reader_getFieldValue (void *hEntry, sal_uInt16 index, RTValueType *type, RTConstValueUnion *value)
 Returns the value of a field of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getFieldDocumentation (void *hEntry, rtl_uString **pDoku, sal_uInt16 index)
 Returns the documentation of a field of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getFieldFileName (void *hEntry, rtl_uString **pFieldFileName, sal_uInt16 index)
 Returns the file name of a field of a type reader. More...
 
sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getMethodCount (void *hEntry)
 Returns the number of methods of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getMethodName (void *hEntry, rtl_uString **pMethodName, sal_uInt16 index)
 Returns the name of a method of a type reader. More...
 
sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getMethodParameterCount (void *hEntry, sal_uInt16 index)
 Returns the number of parameters of a method of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getMethodParameterTypeName (void *hEntry, rtl_uString **pMethodParamType, sal_uInt16 index, sal_uInt16 paramIndex)
 Returns the type name of a parameter of a method of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getMethodParameterName (void *hEntry, rtl_uString **pMethodParamName, sal_uInt16 index, sal_uInt16 paramIndex)
 Returns the name of a parameter of a method of a type reader. More...
 
RTParamMode TYPEREG_CALLTYPE typereg_reader_getMethodParameterFlags (void *hEntry, sal_uInt16 index, sal_uInt16 paramIndex)
 Returns the flags of a parameter of a method of a type reader. More...
 
sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getMethodExceptionCount (void *hEntry, sal_uInt16 index)
 Returns the number of exceptions of a method of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getMethodExceptionTypeName (void *hEntry, rtl_uString **pMethodExcpType, sal_uInt16 index, sal_uInt16 excIndex)
 Returns the type name of an exception of a method of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getMethodReturnTypeName (void *hEntry, rtl_uString **pMethodReturnType, sal_uInt16 index)
 Returns the return type name of a method of a type reader. More...
 
RTMethodMode TYPEREG_CALLTYPE typereg_reader_getMethodFlags (void *hEntry, sal_uInt16 index)
 Returns the flags of a method of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getMethodDocumentation (void *hEntry, rtl_uString **pMethodDoku, sal_uInt16 index)
 Returns the documentation of a method of a type reader. More...
 
sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getReferenceCount (void *hEntry)
 Returns the number of references of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getReferenceTypeName (void *hEntry, rtl_uString **pReferenceName, sal_uInt16 index)
 Returns the type name of a reference of a type reader. More...
 
RTReferenceType TYPEREG_CALLTYPE typereg_reader_getReferenceSort (void *hEntry, sal_uInt16 index)
 Returns the sort of a reference of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getReferenceDocumentation (void *hEntry, rtl_uString **pReferenceDoku, sal_uInt16 index)
 Returns the documentation of a reference of a type reader. More...
 
RTFieldAccess TYPEREG_CALLTYPE typereg_reader_getReferenceFlags (void *hEntry, sal_uInt16 index)
 Returns the flags of a reference of a type reader. More...
 
sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getSuperTypeCount (void *hEntry)
 Returns the number of super types of a type reader. More...
 
void TYPEREG_CALLTYPE typereg_reader_getSuperTypeName (void *hEntry, rtl_uString **pSuperTypeName, sal_uInt16 index)
 Returns the type name of a super type of a type reader. More...
 

Variables

const char NULL_STRING [1] = { 0 }
 
const sal_Unicode NULL_WSTRING [1] = { 0 }
 
const sal_uInt32 magic = 0x12345678
 
const sal_uInt16 minorVersion = 0x0000
 
const sal_uInt16 majorVersion = 0x0001
 

Function Documentation

◆ typereg_reader_acquire()

void TYPEREG_CALLTYPE typereg_reader_acquire ( void *  handle)

Increments the reference count of a type reader.

Parameters
handlea handle on a type reader; may be null
Available since: \n UDK 3.2.0

Definition at line 1169 of file reflread.cxx.

Referenced by typereg::Reader::Reader().

◆ typereg_reader_create()

bool TYPEREG_CALLTYPE 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

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
resultan 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
Returns
false iff an out-of-memory condition occurred, in which case result is left unchanged, and no type reader is created
Available since: \n UDK 3.2.0

Definition 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().

◆ typereg_reader_getDocumentation()

void TYPEREG_CALLTYPE typereg_reader_getDocumentation ( void *  handle,
rtl_uString **  result 
)

Returns the documentation of a type reader.

Parameters
handlea handle on a type reader; may be null
resultan 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
Available since: \n UDK 3.2.0

Definition at line 1243 of file reflread.cxx.

References OFFSET_DOKU, and SAL_WARN.

Referenced by typereg::Reader::getDocumentation().

◆ typereg_reader_getFieldCount()

sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getFieldCount ( void *  handle)

Returns the number of fields of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of fields of the type reader; if handle is null, zero is returned
Available since: \n UDK 3.2.0

Definition at line 1278 of file reflread.cxx.

Referenced by typereg::Reader::getFieldCount().

◆ typereg_reader_getFieldDocumentation()

void TYPEREG_CALLTYPE typereg_reader_getFieldDocumentation ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the documentation of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of fields of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1346 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getFieldDocumentation().

◆ typereg_reader_getFieldFileName()

void TYPEREG_CALLTYPE typereg_reader_getFieldFileName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of fields of the given type reader
Available since: \n UDK 3.2.0
Deprecated:

Definition at line 1362 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getFieldFileName().

◆ typereg_reader_getFieldFlags()

RTFieldAccess TYPEREG_CALLTYPE typereg_reader_getFieldFlags ( void *  handle,
sal_uInt16  index 
)

Returns the flags of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of fields of the given type reader
Returns
the flags of the given field of the type reader
Available since: \n UDK 3.2.0

Definition at line 1318 of file reflread.cxx.

References index, and INVALID.

Referenced by typereg::Reader::getFieldFlags().

◆ typereg_reader_getFieldName()

void TYPEREG_CALLTYPE typereg_reader_getFieldName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the name of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of fields of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1287 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getFieldName().

◆ typereg_reader_getFieldTypeName()

void TYPEREG_CALLTYPE typereg_reader_getFieldTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of fields of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1302 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getFieldTypeName().

◆ typereg_reader_getFieldValue()

bool TYPEREG_CALLTYPE typereg_reader_getFieldValue ( void *  handle,
sal_uInt16  index,
RTValueType type,
union RTConstValueUnion value 
)

Returns the value of a field of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of fields of the given type reader
typean out-parameter obtaining the field value's type; must not be null
valuean out-parameter obtaining the field value's value; must not be null
Returns
false iff an out-of-memory condition occurred, in which case type and value are left unchanged
Available since: \n UDK 3.2.0

Definition at line 1327 of file reflread.cxx.

References index, RT_TYPE_NONE, type, and value.

Referenced by typereg::Reader::getFieldValue().

◆ typereg_reader_getFileName()

void TYPEREG_CALLTYPE typereg_reader_getFileName ( void *  handle,
rtl_uString **  result 
)

Returns the file name of a type reader.

Parameters
handlea handle on a type reader; may be null
resultan 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
Available since: \n UDK 3.2.0
Deprecated:

Definition at line 1260 of file reflread.cxx.

References OFFSET_FILENAME, and SAL_WARN.

Referenced by typereg::Reader::getFileName().

◆ typereg_reader_getMethodCount()

sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getMethodCount ( void *  handle)

Returns the number of methods of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of methods of the type reader; if handle is null, zero is returned
Available since: \n UDK 3.2.0

Definition at line 1379 of file reflread.cxx.

Referenced by typereg::Reader::getMethodCount().

◆ typereg_reader_getMethodDocumentation()

void TYPEREG_CALLTYPE typereg_reader_getMethodDocumentation ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the documentation of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of methods of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1506 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodDocumentation().

◆ typereg_reader_getMethodExceptionCount()

sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getMethodExceptionCount ( void *  handle,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of methods of the given type reader
Returns
the number of exceptions of the given method of the type reader
Available since: \n UDK 3.2.0

Definition at line 1455 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodExceptionCount().

◆ typereg_reader_getMethodExceptionTypeName()

void TYPEREG_CALLTYPE 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.

Parameters
handlea handle on a type reader; must not be null
resultan 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
methodIndexa valid index into the range of methods of the given type reader
exceptionIndexa valid index into the range of exceptions of the given method
Available since: \n UDK 3.2.0

Definition at line 1465 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodExceptionTypeName().

◆ typereg_reader_getMethodFlags()

RTMethodMode TYPEREG_CALLTYPE typereg_reader_getMethodFlags ( void *  handle,
sal_uInt16  index 
)

Returns the flags of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of methods of the given type reader
Returns
the flags of the given method of the type reader
Available since: \n UDK 3.2.0

Definition at line 1497 of file reflread.cxx.

References index, and INVALID.

Referenced by typereg::Reader::getMethodFlags().

◆ typereg_reader_getMethodName()

void TYPEREG_CALLTYPE typereg_reader_getMethodName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the name of a method of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of methods of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1388 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodName().

◆ typereg_reader_getMethodParameterCount()

sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getMethodParameterCount ( void *  handle,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of methods of the given type reader
Returns
the number of parameters of the given method of the type reader
Available since: \n UDK 3.2.0

Definition at line 1404 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodParameterCount().

◆ typereg_reader_getMethodParameterFlags()

RTParamMode TYPEREG_CALLTYPE typereg_reader_getMethodParameterFlags ( void *  handle,
sal_uInt16  methodIndex,
sal_uInt16  parameterIndex 
)

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

Parameters
handlea handle on a type reader; must not be null
methodIndexa valid index into the range of methods of the given type reader
parameterIndexa valid index into the range of parameters of the given method
Returns
the flags of the given parameter of the given method of the type reader
Available since: \n UDK 3.2.0

Definition at line 1446 of file reflread.cxx.

References index, and RT_PARAM_INVALID.

Referenced by typereg::Reader::getMethodParameterFlags().

◆ typereg_reader_getMethodParameterName()

void TYPEREG_CALLTYPE 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.

Parameters
handlea handle on a type reader; must not be null
resultan 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
methodIndexa valid index into the range of methods of the given type reader
parameterIndexa valid index into the range of parameters of the given method
Available since: \n UDK 3.2.0

Definition at line 1430 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodParameterName().

◆ typereg_reader_getMethodParameterTypeName()

void TYPEREG_CALLTYPE 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.

Parameters
handlea handle on a type reader; must not be null
resultan 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
methodIndexa valid index into the range of methods of the given type reader
parameterIndexa valid index into the range of parameters of the given method
Available since: \n UDK 3.2.0

Definition at line 1414 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodParameterTypeName().

◆ typereg_reader_getMethodReturnTypeName()

void TYPEREG_CALLTYPE typereg_reader_getMethodReturnTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of methods of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1481 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getMethodReturnTypeName().

◆ typereg_reader_getReferenceCount()

sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getReferenceCount ( void *  handle)

Returns the number of references of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of references of the type reader; if handle is null, zero is returned
Available since: \n UDK 3.2.0

Definition at line 1522 of file reflread.cxx.

Referenced by typereg::Reader::getReferenceCount().

◆ typereg_reader_getReferenceDocumentation()

void TYPEREG_CALLTYPE typereg_reader_getReferenceDocumentation ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

Returns the documentation of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of references of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1556 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getReferenceDocumentation().

◆ typereg_reader_getReferenceFlags()

RTFieldAccess TYPEREG_CALLTYPE typereg_reader_getReferenceFlags ( void *  handle,
sal_uInt16  index 
)

Returns the flags of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of references of the given type reader
Returns
the flags of the given reference of the type reader
Available since: \n UDK 3.2.0

Definition at line 1572 of file reflread.cxx.

References index, and INVALID.

Referenced by typereg::Reader::getReferenceFlags().

◆ typereg_reader_getReferenceSort()

RTReferenceType TYPEREG_CALLTYPE typereg_reader_getReferenceSort ( void *  handle,
sal_uInt16  index 
)

Returns the sort of a reference of a type reader.

Parameters
handlea handle on a type reader; must not be null
indexa valid index into the range of references of the given type reader
Returns
the sort of the given reference of the type reader
Available since: \n UDK 3.2.0

Definition at line 1547 of file reflread.cxx.

References index, and INVALID.

Referenced by typereg::Reader::getReferenceSort().

◆ typereg_reader_getReferenceTypeName()

void TYPEREG_CALLTYPE typereg_reader_getReferenceTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of references of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1531 of file reflread.cxx.

References index.

Referenced by typereg::Reader::getReferenceTypeName().

◆ typereg_reader_getSuperTypeCount()

sal_uInt16 TYPEREG_CALLTYPE typereg_reader_getSuperTypeCount ( void *  handle)

Returns the number of super types of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the number of super types of the type reader; if handle is null, zero is returned
Available since: \n UDK 3.2.0

Definition at line 1581 of file reflread.cxx.

Referenced by typereg::Reader::getSuperTypeCount().

◆ typereg_reader_getSuperTypeName()

void TYPEREG_CALLTYPE typereg_reader_getSuperTypeName ( void *  handle,
rtl_uString **  result,
sal_uInt16  index 
)

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

Parameters
handlea handle on a type reader; must not be null
resultan 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
indexa valid index into the range of super types of the given type reader
Available since: \n UDK 3.2.0

Definition at line 1590 of file reflread.cxx.

References index, and SAL_WARN.

Referenced by typereg::Reader::getSuperTypeName().

◆ typereg_reader_getTypeClass()

RTTypeClass TYPEREG_CALLTYPE 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.

Parameters
handlea handle on a type reader; may be null
Returns
the type class of the type reader; if handle is null, RT_TYPE_INVALID is returned
Available since: \n UDK 3.2.0

Definition at line 1199 of file reflread.cxx.

References OFFSET_TYPE_CLASS, RT_TYPE_INVALID, and SAL_WARN.

Referenced by typereg::Reader::getTypeClass().

◆ typereg_reader_getTypeName()

void TYPEREG_CALLTYPE typereg_reader_getTypeName ( void *  handle,
rtl_uString **  result 
)

Returns the type name of a type reader.

Parameters
handlea handle on a type reader; may be null
resultan 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
Available since: \n UDK 3.2.0

Definition at line 1225 of file reflread.cxx.

References OFFSET_THIS_TYPE, and SAL_WARN.

Referenced by typereg::Reader::getTypeName().

◆ typereg_reader_getVersion()

typereg_Version TYPEREG_CALLTYPE typereg_reader_getVersion ( void const *  handle)

Returns the binary blob version of a type reader.

Parameters
handlea handle on a type reader; may be null
Returns
the version of the binary blob from which the type reader was constructed; if handle is null, TYPEREG_VERSION_0 is returned
Available since: \n UDK 3.2.0

Definition at line 1188 of file reflread.cxx.

References SAL_WARN, and TYPEREG_VERSION_0.

Referenced by typereg::Reader::getVersion().

◆ typereg_reader_isPublished()

bool TYPEREG_CALLTYPE typereg_reader_isPublished ( void *  handle)

Returns whether a type reader is published.

Parameters
handlea handle on a type reader; may be null
Returns
whether the type reader is published; if handle is null, false is returned
Available since: \n UDK 3.2.0

Definition at line 1212 of file reflread.cxx.

References OFFSET_TYPE_CLASS, and SAL_WARN.

Referenced by typereg::Reader::isPublished().

◆ typereg_reader_release()

void TYPEREG_CALLTYPE 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.

Parameters
handlea handle on a type reader; may be null
Available since: \n UDK 3.2.0

Definition at line 1177 of file reflread.cxx.

Referenced by typereg::Reader::~Reader().

Variable Documentation

◆ magic

const sal_uInt32 magic = 0x12345678

Definition at line 43 of file reflread.cxx.

◆ majorVersion

const sal_uInt16 majorVersion = 0x0001

Definition at line 45 of file reflread.cxx.

◆ minorVersion

const sal_uInt16 minorVersion = 0x0000

Definition at line 44 of file reflread.cxx.

◆ NULL_STRING

const char NULL_STRING[1] = { 0 }

Definition at line 40 of file reflread.cxx.

◆ NULL_WSTRING

const sal_Unicode NULL_WSTRING[1] = { 0 }

Definition at line 41 of file reflread.cxx.