Java Doc for OleAutomation.java in  » IDE-Eclipse » swt » org » eclipse » swt » ole » win32 » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The OLE Document or ActiveX Control must support the IDispatch interface in order to provide OleAutomation support. The additional functionality provided by the OLE Object is specified in its IDL file. The additional methods can either be to get property values (getProperty), to set property values (setProperty) or to invoke a method (invoke or invokeNoReply). Arguments are passed around in the form of Variant objects.

Here is a sample IDL fragment:

 interface IMyControl : IDispatch
 {
 [propget, id(0)] HRESULT maxFileCount([retval, out] int *c);
 [propput, id(0)] HRESULT maxFileCount([in] int c);
 [id(1)]	HRESULT AddFile([in] BSTR fileName);
 };
 

An example of how to interact with this extended functionality is shown below:

 OleAutomation automation = new OleAutomation(myControlSite);
 // Look up the ID of the maxFileCount parameter
 int[] rgdispid = automation.getIDsOfNames(new String[]{"maxFileCount"});
 int maxFileCountID = rgdispid[0];
 // Set the property maxFileCount to 100:
 if (automation.setProperty(maxFileCountID, new Variant(100))) {
 System.out.println("Max File Count was successfully set.");
 }
 // Get the new value of the maxFileCount parameter:
 Variant pVarResult = automation.getProperty(maxFileCountID);
 if (pVarResult != null) {
 System.out.println("Max File Count is "+pVarResult.getInt());
 }
 // Invoke the AddFile method
 // Look up the IDs of the AddFile method and its parameter
 rgdispid = automation.getIDsOfNames(new String[]{"AddFile", "fileName"}); 
 int dispIdMember = rgdispid[0];
 int[] rgdispidNamedArgs = new int[] {rgdispid[1]};
 // Convert arguments to Variant objects
 Variant[] rgvarg = new Variant[1];
 String fileName = "C:\\testfile";
 rgvarg[0] = new Variant(fileName);
 // Call the method
 Variant pVarResult = automation.invoke(dispIdMember, rgvarg, rgdispidNamedArgs);
 // Check the return value
 if (pVarResult == null || pVarResult.getInt() != OLE.S_OK){
 System.out.println("Failed to add file "+fileName);
 }
 automation.dispose();
 

• ERROR_INVALID_INTERFACE_ADDRESS when called with an invalid client site

This method releases the IDispatch interface on the OLE Document or ActiveX Control. Do not use the OleAutomation object after it has been disposed.

• ERROR_ACTION_NOT_PERFORMED when method invocation fails

• ERROR_ACTION_NOT_PERFORMED when method invocation fails

• ERROR_ACTION_NOT_PERFORMED when method invocation fails