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 RegistryTypeReader


RegistryTypeReader
RegistryTypeReader(
const sal_uInt8 * buffer,
sal_uInt32 bufferLen,
sal_Bool copyData );

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

Summary
Constructor.
Parameters
buffer
points to the binary data block.
bufferlen
specifies the size of the binary data block.
copyData
specifies if the data block should be copied.
                The block can be copied to ensure that the data
                is valid for the lifetime of this instance.

RegistryTypeReader
RegistryTypeReader(
const RegistryTypeReader & toCopy );

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

Summary
Copy constructcor

~RegistryTypeReader
~RegistryTypeReader();

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

Summary
Destructor. The Destructor frees the data block if the copyData flag was TRUE.

operator==
RegistryTypeReader & operator==(
const RegistryTypeReader & toAssign );

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

Summary
Assign operator

isValid
sal_Bool isValid();

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

Summary
checks if the registry type reader points to a valid Api.

getMinorVersion
sal_uInt16 getMinorVersion();

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 minor version number.
Description
We currently don't support a versioning concept of IDL interfaces and so this function is currently not used.

getMajorVersion
sal_uInt16 getMajorVersion();

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 major version number.
Description
We currently don't support a versioning concept of IDL interfaces and so this function is currently not used.

getTypeClass
RTTypeClass getTypeClass();

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

Summary
returns the typeclass of the type represented by this blob.
Description
This function will always return the type class without the internal RT_TYPE_PUBLISHED flag set.

getTypeName
::rtl::OUString getTypeName();

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

Summary
returns the full qualified name of the type.

getSuperTypeName
::rtl::OUString getSuperTypeName();

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

Summary
returns the full qualified name of the supertype.

getUik
void getUik(
RTUik & uik ) 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 unique identifier for an interface type as an out parameter.
Description
An earlier version of UNO used an unique identifier for interfaces. In the current version of UNO this uik was eliminated and this function is not longer used.

getDoku
::rtl::OUString getDoku();

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

Summary
returns the documentation string of this type.

getFileName
::rtl::OUString getFileName();

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

Summary
returns the IDL filename where the type is defined.

getFieldCount
sal_uInt32 getFieldCount();

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

Summary
returns the number of fields (attributes/properties, enum values or number of constants in a module).

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 the field specified by index.

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

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

Summary
returns the full qualified name of the field specified by index.

getFieldAccess
RTFieldAccess getFieldAccess(
sal_uInt16 index ) const;

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

Summary
returns the access mode of the field specified by index.

getFieldConstValue
RTConstValue getFieldConstValue(
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 the field specified by index.
Description
This function returns the value of an enum value or of a constant.

getFieldDoku
::rtl::OUString getFieldDoku(
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 string for the field specified by index.
Description
Each field of a type can have their own documentation.

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

Summary
returns the IDL filename of the field specified by index.
Description
The IDL filename of a field can differ from the filename of the ype itself because modules and also constants can be defined in different IDL files.

getMethodCount
sal_uInt32 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 an interface type.

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 the method specified by index.

getMethodParamCount
sal_uInt32 getMethodParamCount(
sal_uInt16 index ) const;

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

Summary
returns number of parameters of the method specified by index.

getMethodParamType
::rtl::OUString getMethodParamType(
sal_uInt16 index,
sal_uInt16 paramIndex ) const;

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

Summary
returns the full qualified parameter typename.
Parameters
index
indicates the method
        
paramIndex
indeciates the parameter which type will be returned.
     

getMethodParamName
::rtl::OUString getMethodParamName(
sal_uInt16 index,
sal_uInt16 paramIndex ) 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.
Parameters
index
indicates the method
        
paramIndex
indiciates the parameter which name will be returned.
     

getMethodParamMode
RTParamMode getMethodParamMode(
sal_uInt16 index,
sal_uInt16 paramIndex ) const;

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

Summary
returns the parameter mode, if it is an in, out or inout parameter.
Parameters
index
indicates the method
        
paramIndex
indeciates the parameter which mode will be returned.
     

getMethodExcCount
sal_uInt32 getMethodExcCount(
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 which are declared for the method specified by index.
Parameters
index
indicates the method
     

getMethodExcType
::rtl::OUString getMethodExcType(
sal_uInt16 index,
sal_uInt16 excIndex ) const;

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

Summary
returns the full qualified exception type of the specified exception.
Parameters
index
indicates the method
paramIndex
indeciates the exception which typename will be returned.

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

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

Summary
returns the full qualified return type of the method specified by index.

getMethodMode
RTMethodMode getMethodMode(
sal_uInt16 index ) const;

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

Summary
returns the full qualified exception type of the specified exception.
Parameters
index
indicates the method
paramIndex
indeciates the exception which typename will be returned.

getMethodDoku
::rtl::OUString getMethodDoku(
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 string of the method specified by index.
Parameters
index
indicates the method.
     

getReferenceCount
sal_uInt32 getReferenceCount();

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

Summary
returns the number of references (supported interfaces, exported services).

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

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

Summary
returns the full qualified typename of the reference specified by index.
Parameters
index
indicates the reference.
     

getReferenceType
RTReferenceType getReferenceType(
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 of the reference specified by index.
Parameters
index
indicates the reference.
     

getReferenceDoku
::rtl::OUString getReferenceDoku(
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 string of the reference specified by index.
Parameters
index
indicates the reference.
   

getReferenceAccess
RTFieldAccess getReferenceAccess(
sal_uInt16 index ) const;

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

Summary
returns the access mode of the reference specified by index.
Description
The only valid value is RT_ACCESS_OPTIONAL in the context of references.
Parameters
index
indicates the 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.