Return array of interface from a .NET method via COM4J

Question

How can I return an array of objects (implementing a COM interface) from a C# method to a Java method via COM4J?

Example C# class that generates an array:

using System;
using System.Runtime.InteropServices;

namespace Example
{

    [ComVisible(true), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface IAnimal
    {
        string Speak();
    }

    [ComVisible(true), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface IFarm
    {
        [return:MarshalAs(UnmanagedType.SafeArray,
        SafeArraySubType=VarEnum.VT_UNKNOWN)]
        IAnimal[] GetAnimals();
    }

    [ComVisible(true), ClassInterface(ClassInterfaceType.None)]
    public class Farm : IFarm
    {
        public IAnimal[] GetAnimals()
        {
            return new IAnimal[] { new Cow(), new Pig() };
        }
    }

    internal class Cow: IAnimal
    {
        public string Speak()
        {
            return "Moo";
        }
    }

    internal class Pig: IAnimal
    {
        public string Speak()
        {
            return "Oink";
        }
    }
}

The interface declaration in the resulting .tlb looks like this:

[
  odl,
  uuid(1FB5E376-E78D-3A2E-BEF3-F3C798FCF44C),
  version(1.0),
  oleautomation,
  custom(0F21F359-AB84-41E8-9A78-36D110E6D2F9, "Example.IFarm")
]
interface IFarm : IUnknown
{
    HRESULT _stdcall GetAnimals([out, retval] SAFEARRAY(IUnknown*)* pRetVal);
};

Java client code:

import com4j.*;

public class Example {
    public static void main(String[] args) {
        IFarm farm = ClassFactory.createFarm();
        Com4jObject[] animals = farm.getAnimals();

        for (Com4jObject o: animals) {
            IAnimal animal = o.queryInterface(IAnimal.class);

            if (animal != null) {
                animal.speak();
            }
        }
    }
}

This compiles but I get this exception at runtime:

Exception in thread "main" com4j.ComException: 
    unexpected conversion type: 500 : .\invoke.cpp:470
        at com4j.Wrapper.invoke(Wrapper.java:185)
        at $Proxy5.getAnimals(Unknown Source)
        at MainClass.main(MainClass.java:7)
Caused by: com4j.ComException: unexpected conversion type: 500 : .\invoke.cpp:470
        at com4j.Native.invoke(Native Method)
        at com4j.StandardComMethod.invoke(StandardComMethod.java:35)
        at com4j.Wrapper$InvocationThunk.call(Wrapper.java:354)
        at com4j.Task.invoke(Task.java:55)
        at com4j.ComThread.run0(ComThread.java:157)
        at com4j.ComThread.run(ComThread.java:137)

Other things I have tried:

Marshalling as a SAFEARRAY(VARIANT)* instead of SAFEARRAY(IUnknown*)*
(this throws the same exception.)
Removing the MarshalAs attribute (tlbimp fails to create the proxy method)

Is there a way to marshal the array so that COM4J can convert it to a valid Java array?

Alternatively is there a way to allocate an array in Java and allow the .NET method to populate it? (I tried this but the .NET method receives a copy of the array and the Java code never sees the objects inserted into the copy. Maybe there's a way to override this?)

Edit: This may be related: https://stackoverflow.com/a/6340144/12048 - something similar appears to be possible from VBScript

Dumb question, but is it GetAnimal or getAnimal. The error said that it could not resolve getAnimal. — zam664
– zam664, Commented Feb 18, 2013 at 2:50
@zam664 Both are correct; COM4J drops the initial caps on method names when it generates the Java classes. — finnw
– finnw, Commented Feb 18, 2013 at 4:20
Pig and Cow are neither ComVisible, nor I see any Java classes for them. Could it be that this is thing that is missing? — Jan Hruby
– Jan Hruby, Commented Apr 3, 2013 at 14:55
@JanHruby: they are not intended to be ComVisible and they should not need to be. They implement a ComVisible interface and are returned by a ComVisible method, which is enough to make them accessible. And as I said in a comment on an answer, it works if I export the same objects through a collection instead of an array. — finnw
– finnw, Commented Apr 3, 2013 at 22:32

csharptest.net · Accepted Answer · 2012-12-20 20:20:56Z

1

Have you tried declaring your interfaces as InterfaceIsDual and/or InterfaceIsIDispatch?

[ComVisible(true), InterfaceType(ComInterfaceType.InterfaceIsDual)]
public interface IAnimal
{
...

Most COM interop libraries require a dispatch interface; however, I'm not sure about COM4J. You could also use an abstract base COM class rather than an interface to achieve the same goal, but I'd be surprised if the above change doesn't get you up and running.

answered Dec 20, 2012 at 20:20

csharptest.net

64.5k11 gold badges78 silver badges91 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

finnw Over a year ago

COM4J uses IUnknown interfaces - Dispatch is not required. My problem is only with arrays (exporting a collection works fine.)

Collectives™ on Stack Overflow

Return array of interface from a .NET method via COM4J

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related