org.jinterop.dcom.impls.automation
Interface IJITypeLib

All Superinterfaces:
IJIComObject, java.io.Serializable

public interface IJITypeLib
extends IJIComObject

Represents the Windows COM ITypeLib Interface.

Definition from MSDN: The ITypeLib interface provides methods for accessing a library of type descriptions. This interface supports the following: Generalized containment for type information. ITypeLib allows iteration over the type descriptions contained in the library.

Global functions and data. A type library can contain descriptions of a set of modules, each of which is the equivalent of a C or C++ source file that exports data and functions. The type library supports compiling references to the exported data and functions.

General information, including a user-readable name for the library and help for the library as a whole.

Since:
1.0

Field Summary
static java.lang.String IID
          IID representing the COM ITypeLib.
 
Method Summary
 java.lang.Object[] findName(JIString nameBuf, int hashValue, short found)
          Finds occurrences of a type description in a type library.
 java.lang.Object[] getDocumentation(int memberId)
          Retrieves the library's documentation string, the complete Help file name and path, and the context identifier for the library Help topic in the Help file.
 void getLibAttr()
          Retrieves the structure that contains the library's attributes.
 IJITypeInfo getTypeInfo(int index)
          Retrieves the specified type description in the library.
 int getTypeInfoCount()
          Returns the number of type descriptions in the type library.
 IJITypeInfo getTypeInfoOfGuid(java.lang.String uuid)
          Retrieves the type description that corresponds to the specified GUID.
 int getTypeInfoType(int index)
          Retrieves the type of a type description.
 
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 java.lang.String IID
IID representing the COM ITypeLib.

See Also:
Constant Field Values
Method Detail

getTypeInfoCount

int getTypeInfoCount()
                     throws JIException
Returns the number of type descriptions in the type library.

Returns:
Throws:
JIException

getTypeInfo

IJITypeInfo getTypeInfo(int index)
                        throws JIException
Retrieves the specified type description in the library.

Parameters:
index - index of the ITypeInfo interface to be returned.
Returns:
Throws:
JIException

getTypeInfoType

int getTypeInfoType(int index)
                    throws JIException
Retrieves the type of a type description.

Parameters:
index - ihe index of the type description within the type library.
Returns:
Throws:
JIException

getTypeInfoOfGuid

IJITypeInfo getTypeInfoOfGuid(java.lang.String uuid)
                              throws JIException
Retrieves the type description that corresponds to the specified GUID.

Parameters:
uuid - GUID of the type description.
Returns:
Throws:
JIException

getLibAttr

void getLibAttr()
                throws JIException
Retrieves the structure that contains the library's attributes.

Throws:
JIException

getDocumentation

java.lang.Object[] getDocumentation(int memberId)
                                    throws JIException
Retrieves the library's documentation string, the complete Help file name and path, and the context identifier for the library Help topic in the Help file.

Parameters:
memberId -
Returns:
Throws:
JIException

findName

java.lang.Object[] findName(JIString nameBuf,
                            int hashValue,
                            short found)
                            throws JIException
Finds occurrences of a type description in a type library. This may be used to quickly verify that a name exists in a type library.

Parameters:
nameBuf -
hashValue -
found -
Returns:
Throws:
JIException