Global Functions in Global Namespace C++
in Sourcefile reader.h
- typereg_reader_acquire
- extern "C"
void typereg_reader_acquire(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Increments the reference count of a type reader.
- Parameters
handle |
a handle on a type reader; may be null
|
- Since
- UDK 3.2.0
- typereg_reader_create
- extern "C"
sal_Bool typereg_reader_create(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Creates a type reader working on a binary blob that represents a UNOIDL type.
- Description
-
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.
- Parameters
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 function returns; if
false, the type reader works directly on the given buffer, which must remain
available unmodified until the type reader is destroyed
|
maxVersion |
the maximum binary blob version the client is prepared to
handle; must not be negative
|
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
|
- Return
- false iff an out-of-memory condition occurred, in which case
result
is left unchanged, and no type reader is created
- Since
- UDK 3.2.0
- typereg_reader_getDocumentation
- extern "C"
void typereg_reader_getDocumentation(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the documentation of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getFieldCount
- extern "C"
sal_uInt16 typereg_reader_getFieldCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the number of fields of a type reader.
- Parameters
handle |
a handle on a type reader; may be null
|
- Return
- the number of fields of the type reader; if
handle
is
null, zero is returned
- Since
- UDK 3.2.0
- typereg_reader_getFieldDocumentation
- extern "C"
void typereg_reader_getFieldDocumentation(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the documentation of a field of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getFieldFileName
- extern "C"
void typereg_reader_getFieldFileName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- D E P R E C A T E D
- Summary
- Returns the file name of a field of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getFieldFlags
- extern "C"
RTFieldAccess typereg_reader_getFieldFlags(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the flags of a field of a type reader.
- Parameters
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
|
- Return
- the flags of the given field of the type reader
- Since
- UDK 3.2.0
- typereg_reader_getFieldName
- extern "C"
void typereg_reader_getFieldName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the name of a field of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getFieldTypeName
- extern "C"
void typereg_reader_getFieldTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type name of a field of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getFieldValue
- extern "C"
sal_Bool typereg_reader_getFieldValue(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the value of a field of a type reader.
- Parameters
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
|
result |
an out-parameter obtaining the field value's value; must not be
null
|
- Return
- false iff an out-of-memory condition occurred, in which case
type
and value
are left unchanged
- Since
- UDK 3.2.0
- typereg_reader_getFileName
- extern "C"
void typereg_reader_getFileName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- D E P R E C A T E D
- Summary
- Returns the file name of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getMethodCount
- extern "C"
sal_uInt16 typereg_reader_getMethodCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the number of methods of a type reader.
- Parameters
handle |
a handle on a type reader; may be null
|
- Return
- the number of methods of the type reader; if
handle
is
null, zero is returned
- Since
- UDK 3.2.0
- typereg_reader_getMethodDocumentation
- extern "C"
void typereg_reader_getMethodDocumentation(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the documentation of a method of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getMethodExceptionCount
- extern "C"
sal_uInt16 typereg_reader_getMethodExceptionCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the number of exceptions of a method of a type reader.
- Parameters
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
|
- Return
- the number of exceptions of the given method of the type reader
- Since
- UDK 3.2.0
- typereg_reader_getMethodExceptionTypeName
- extern "C"
void typereg_reader_getMethodExceptionTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type name of an exception of a method of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getMethodFlags
- extern "C"
RTMethodMode typereg_reader_getMethodFlags(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the flags of a method of a type reader.
- Parameters
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
|
- Return
- the flags of the given method of the type reader
- Since
- UDK 3.2.0
- typereg_reader_getMethodName
- extern "C"
void typereg_reader_getMethodName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the name of a method of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getMethodParameterCount
- extern "C"
sal_uInt16 typereg_reader_getMethodParameterCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the number of parameters of a method of a type reader.
- Parameters
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
|
- Return
- the number of parameters of the given method of the type reader
- Since
- UDK 3.2.0
- typereg_reader_getMethodParameterFlags
- extern "C"
RTParamMode typereg_reader_getMethodParameterFlags(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the flags of a parameter of a method of a type reader.
- Parameters
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
|
- Return
- the flags of the given parameter of the given method of the type
reader
- Since
- UDK 3.2.0
- typereg_reader_getMethodParameterName
- extern "C"
void typereg_reader_getMethodParameterName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the name of a parameter of a method of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getMethodParameterTypeName
- extern "C"
void typereg_reader_getMethodParameterTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type name of a parameter of a method of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getMethodReturnTypeName
- extern "C"
void typereg_reader_getMethodReturnTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the return type name of a method of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getReferenceCount
- extern "C"
sal_uInt16 typereg_reader_getReferenceCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the number of references of a type reader.
- Parameters
handle |
a handle on a type reader; may be null
|
- Return
- the number of references of the type reader; if
handle
is null, zero is returned
- Since
- UDK 3.2.0
- typereg_reader_getReferenceDocumentation
- extern "C"
void typereg_reader_getReferenceDocumentation(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the documentation of a reference of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getReferenceFlags
- extern "C"
RTFieldAccess typereg_reader_getReferenceFlags(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the flags of a reference of a type reader.
- Parameters
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
|
- Return
- the flags of the given reference of the type reader
- Since
- UDK 3.2.0
- typereg_reader_getReferenceSort
- extern "C"
RTReferenceType typereg_reader_getReferenceSort(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the sort of a reference of a type reader.
- Parameters
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
|
- Return
- the sort of the given reference of the type reader
- Since
- UDK 3.2.0
- typereg_reader_getReferenceTypeName
- extern "C"
void typereg_reader_getReferenceTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type name of a reference of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getSuperTypeCount
- extern "C"
sal_uInt16 typereg_reader_getSuperTypeCount(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the number of super types of a type reader.
- Parameters
handle |
a handle on a type reader; may be null
|
- Return
- the number of super types of the type reader; if
handle
is null, zero is returned
- Since
- UDK 3.2.0
- typereg_reader_getSuperTypeName
- extern "C"
void typereg_reader_getSuperTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type name of a super type of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getTypeClass
- extern "C"
RTTypeClass typereg_reader_getTypeClass(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type class of a type reader.
- Description
-
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
handle |
a handle on a type reader; may be null
|
- Return
- the type class of the type reader; if
handle
is null,
RT_TYPE_INVALID
is returned
- Since
- UDK 3.2.0
- typereg_reader_getTypeName
- extern "C"
void typereg_reader_getTypeName(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the type name of a type reader.
- Parameters
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
|
- Since
- UDK 3.2.0
- typereg_reader_getVersion
- extern "C"
typereg_Version typereg_reader_getVersion(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns the binary blob version of a type reader.
- Parameters
handle |
a handle on a type reader; may be null
|
- Return
- the version of the binary blob from which the type reader was
constructed; if
handle
is null, TYPEREG_VERSION_0
is returned
- Since
- UDK 3.2.0
- typereg_reader_isPublished
- extern "C"
sal_Bool typereg_reader_isPublished(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Returns whether a type reader is published.
- Parameters
handle |
a handle on a type reader; may be null
|
- Return
- whether the type reader is published; if
handle
is null,
sal_False
is returned
- Since
- UDK 3.2.0
- typereg_reader_release
- extern "C"
void typereg_reader_release(
-
virtual |
abstract |
const |
volatile |
template |
static |
inline |
C-linkage |
NO |
NO |
NO |
NO |
NO |
NO |
NO |
YES |
- Summary
- Decrements the reference count of a type reader.
- Description
-
If the reference count drops to zero, the type reader is destroyed.
- Parameters
handle |
a handle on a type reader; may be null
|
- Since
- UDK 3.2.0
Top of Page
Copyright © 1995, 2012, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.