org.jinterop.dcom.impls.automation

Interface IJITypeInfo

All Superinterfaces:

IJIComObject, Serializable

public interface IJITypeInfo
extends IJIComObject

Represents the Windows COM ITypeInfo Interface.

Definition from MSDN: ITypeInfo, an interface typically used for reading information about objects. For example, an object browser tool can use ITypeInfo to extract information about the characteristics and capabilities of objects from type libraries. Type information interfaces are intended to describe the parts of the application that can be called by outside clients, rather than those that might be used internally to build an application.

The ITypeInfo interface provides access to the following:

• The set of function descriptions associated with the type. For interfaces, this contains the set of member functions in the interface.
• The set of data member descriptions associated with the type. For structures, this contains the set of fields of the type.
• The general attributes of the type, such as whether it describes a structure, an interface, and so on.

  Please note that all APIs of ITypeInfo have not been implemented.
  

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	IID IID representing the COM ITypeInfo.

Method Summary

Modifier and Type	Method and Description
IJIComObject	createInstance(String riid) Creates a new instance of a type that describes a component object class (coclass).
Object[]	getContainingTypeLib() Retrieves the containing type library and the index of the type description within that type library.
Object[]	getDllEntry(int memberId, int invKind) Retrieves a description or specification of an entry point for a function in a DLL.
Object[]	getDocumentation(int memberId) Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description.
FuncDesc	getFuncDesc(int index) Retrieves the FuncDesc structure that contains information about a specified function.
int	getImplTypeFlags(int index) Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or base interface in a type description.
JIString	getMops(int memberId) Retrieves marshaling information.
Object[]	getNames(int memberId, int maxNames) Retrieves the variable with the specified member ID (or the name of the property or method and its parameters) that correspond to the specified function ID.
IJITypeInfo	getRefTypeInfo(int hrefType) If a type description references other type descriptions, it retrieves the referenced type descriptions.
int	getRefTypeOfImplType(int index) If a type description describes a COM class, it retrieves the type description of the implemented interface types.
TypeAttr	getTypeAttr() Retrieves a TypeAttr structure that contains the attributes of the type description.
VarDesc	getVarDesc(int index) Retrieves a VARDESC structure that describes the specified variable.

Methods inherited from interface org.jinterop.dcom.core.IJIComObject

addRef, call, call, getAssociatedSession, getInstanceLevelSocketTimeout, getInterfaceIdentifier, getIpid, getUnreferencedHandler, internal_getConnectionInfo, internal_getInterfacePointer, internal_removeConnectionInfo, internal_setConnectionInfo, internal_setDeffered, isDispatchSupported, isLocalReference, queryInterface, registerUnreferencedHandler, release, setInstanceLevelSocketTimeout, unregisterUnreferencedHandler

Field Detail

IID

static final String IID

IID representing the COM ITypeInfo.

See Also:

Constant Field Values

Method Detail

getFuncDesc

FuncDesc getFuncDesc(int index)
              throws JIException

Retrieves the FuncDesc structure that contains information about a specified function.

Parameters:

index - index of the function whose description is to be returned. The index should be in the range of 0 to 1 less than the number of functions in this type.

Returns:

Throws:

JIException

getTypeAttr

TypeAttr getTypeAttr()
              throws JIException

Retrieves a TypeAttr structure that contains the attributes of the type description.

Returns:

Throws:

JIException

getContainingTypeLib

Object[] getContainingTypeLib()
                       throws JIException

Retrieves the containing type library and the index of the type description within that type library.

Returns:

Object[0] = IJITypeLib, Object[1] = Integer

Throws:

JIException

getDocumentation

Object[] getDocumentation(int memberId)
                   throws JIException

Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description.

Parameters:

memberId - ID of the member whose documentation is to be returned.

Returns:

Object[0] = JIString of BSTR type, Object[1] = JIString of BSTR type, Object[3] = JIString of BSTR type

Throws:

JIException

getDllEntry

Object[] getDllEntry(int memberId,
                     int invKind)
              throws JIException

Retrieves a description or specification of an entry point for a function in a DLL.

Parameters:

memberId - ID of the member function whose DLL entry description is to be returned.

invKind - Specifies the kind of member identified by memberId. This is important for properties, because one memid can identify up to three separate functions.

Returns:

Object[0] = JIString of BSTR type, Object[1] = JIString of BSTR type, Object[2] = Short

Throws:

JIException

getVarDesc

VarDesc getVarDesc(int index)
            throws JIException

Retrieves a VARDESC structure that describes the specified variable.

Parameters:

index - index of the variable whose description is to be returned. The index should be in the range of 0 to 1 less than the number of variables in this type.

Returns:

Throws:

JIException

getNames

Object[] getNames(int memberId,
                  int maxNames)
           throws JIException

Retrieves the variable with the specified member ID (or the name of the property or method and its parameters) that correspond to the specified function ID.

Parameters:

memberId - ID of the member whose name (or names) is to be returned.

maxNames - Length of the passed-in array.

Returns:

Object[0] = JIString[] of BSTR type, Object[1] = Integer

Throws:

JIException

getRefTypeOfImplType

int getRefTypeOfImplType(int index)
                  throws JIException

If a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, getRefTypeOfImplType returns the type information for inherited interfaces, if any exist.

Parameters:

index - index of the implemented type whose handle is returned. The valid range is 0 to the cImplTypes field in the TypeAttr structure.

Returns:

Throws:

JIException

getImplTypeFlags

int getImplTypeFlags(int index)
              throws JIException

Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or base interface in a type description.

Parameters:

index - index of the implemented interface or base interface for which to get the flags.

Returns:

Throws:

JIException

getRefTypeInfo

IJITypeInfo getRefTypeInfo(int hrefType)
                    throws JIException

If a type description references other type descriptions, it retrieves the referenced type descriptions.

Parameters:

hrefType - handle to the referenced type description to be returned.

Returns:

Throws:

JIException

createInstance

IJIComObject createInstance(String riid)
                     throws JIException

Creates a new instance of a type that describes a component object class (coclass).

Parameters:

riid -

Returns:

Throws:

JIException

getMops

JIString getMops(int memberId)
          throws JIException

Retrieves marshaling information.

Parameters:

memberId - member ID that indicates which marshaling information is needed.

Returns:

Throws:

JIException