Sun Adapter for COM/DCOM API

com.stc.connector.comadapter.comruntimeimpl
Class STCDispatchDriver

java.lang.Object
  extended by com.stc.connector.comadapter.comruntimeimpl.STCUnknownImpl
      extended by com.stc.connector.comadapter.comruntimeimpl.STCDispatchDriver
All Implemented Interfaces:
STCIDispatch, STCIUnknown

public class STCDispatchDriver
extends STCUnknownImpl
implements STCIDispatch

The STCDispatchDriver class wraps several of the calls on the IDispatch interface. It does not wrap the IDispatch per se. Rather, its purpose is to allow you to create an automation-compatible component and access properties on that object and/or invoke methods on it by name.

Where noted, the methods can throw the STCComException.

See Also:
STCComException, STCUnknownImpl, STCComVariant

Constructor Summary
STCDispatchDriver(int handle)
          The integer parameter is the COM interface handle from C++.
 
Method Summary
 STCComVariant getProperty(java.lang.String propertyName, STCComVariant[] args)
          Gets a property by name.
 STCComVariant invoke(java.lang.String methodName, STCComVariant[] args)
          This method allows you to call a method by name on the underlying COM interface.
 void setProperty(java.lang.String propertyName, STCComVariant[] args)
          Sets a property by name.
 
Methods inherited from class com.stc.connector.comadapter.comruntimeimpl.STCUnknownImpl
AddRef, isValid, Release
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.stc.connector.comadapter.comruntime.STCIUnknown
AddRef, Release
 

Constructor Detail

STCDispatchDriver

public STCDispatchDriver(int handle)
The integer parameter is the COM interface handle from C++.

Method Detail

invoke

public STCComVariant invoke(java.lang.String methodName,
                            STCComVariant[] args)
                     throws STCComException
This method allows you to call a method by name on the underlying COM interface.

Specified by:
invoke in interface STCIDispatch
Parameters:
methodName - The method name. Note that case is significant.
args - An array of STCComVariant. As per COM rules, the arguments in this array are in reverse order.
Returns:
An STCComVariant which will hold the return value of the underlying Invoke, if applicable and if successful.
Throws:
STCComException - if Invoke on the underlying object fails.

setProperty

public void setProperty(java.lang.String propertyName,
                        STCComVariant[] args)
                 throws STCComException
Sets a property by name.

Specified by:
setProperty in interface STCIDispatch
Parameters:
propertyName - The name of the property to set. Note that case is significant.
args - An array of STCComVariant. As per COM rules, the arguments in this array are in reverse order. This parameter must be provided all the time since the array contains at least the new property value.
Throws:
STCComException - Thrown if the method on underlying object fails.

getProperty

public STCComVariant getProperty(java.lang.String propertyName,
                                 STCComVariant[] args)
                          throws STCComException
Gets a property by name.

Specified by:
getProperty in interface STCIDispatch
Parameters:
propertyName - The name of the property to get. Note that case is significant.
args - An array of STCComVariant. As per COM rules, the arguments in this array are in reverse order. This parameter can be null or empty STCComVariant[] when the property does not have any parameters.
Returns:
STCComVariant - Returns an STCComVariant which holds the resulting value.
Throws:
STCComException - Thrown if the method on underlying COM interface fails.

Sun Adapter for COM/DCOM API

Copyright © 1994-2008 Sun Microsystems, Inc. All rights reserved.