TFS Build server and COM references - does this work?

Question

On my Developer PC i have registered the according dll´s and referenced them. (Add reference -> COM) On the TFS build server this of course causes errors since the references are not registered there and wont be in the future.

What is the best way to circumvent this?

possible duplicate of [Registering COM referenced DLLs on a build server](http://stackoverflow.com/questions/7460910/registering-com-referenced-dlls-on-a-build-server) — Hans Passant, Sep 21 '11 at 13:03
thats correct Hans, thanks a lot - tlbimp is your friend here. — Enrico, Sep 21 '11 at 16:09
Possible duplicate of [Registering COM referenced DLLs on a build server](https://stackoverflow.com/questions/7460910/registering-com-referenced-dlls-on-a-build-server) — StayOnTarget, Jan 25 '19 at 13:05

David Johnston · Answer 1 · 2018-09-07T16:47:43.623

Using tlbimp.exe directly is not necessary. Try replacing any <COMReference> items in the project file with <COMFileReference>. An example would look like this:

<ItemGroup>
   <COMFileReference Include="MyComLibrary.dll">
     <EmbedInteropTypes>True</EmbedInteropTypes>
   </COMFileReference>
</ItemGroup>

The COM dll doesn't need to be registered on the machine for this to work.

Each COMFileReference item can also have a WrapperTool attribute but the default seems to work fine. The EmbedInteropTypes attribute is not documented as being applicable to COMFileReference, but it seems to work as intended.

See https://learn.microsoft.com/en-ca/visualstudio/msbuild/common-msbuild-project-items#comfilereference for a little more detail. This MSBuild item has been available since .NET 3.5.

thanks for the hint, seems like the more professional solution — Enrico, Jan 18 '12 at 09:46

score 3 · Accepted Answer · answered Sep 22 '11 at 07:23

OK, the answer was more easy than one might think. Just use "tlbimp.exe" to create an according intrerop.dll which you include in your project and reference to this dll instead to the COM objects.

You may save the time using tlbimp.exe because Visual Studio creates this dll automatically when you reference a COM object. But it does not upload it to TFS. So finally I just used the automatically created dll and the TFS build Server was happy.

One may find the automatically created Interop dll in: "ProjectFolder\obj\x86\Development"

This really helped me with a reference only interop dll that is already on the app server. VS 2019 would only add a COMReference without a hint path which does not work for a Azure DevOps pipeline build. Taking the tlbimp processed DLL out of the obj folder work perfectly. — merekel, May 13 '20 at 00:00

score 1 · Answer 3 · answered Apr 13 '21 at 19:45

For anyone who's having trouble with namespace:

tl;dr: use tlbImp /namespace: YOUR_NAMESPACE to give your dll a namespace

This solution worked for Azure Pipeline too. But at first I was having trouble with COMFileReference. When I replaced COMReference with COMFileReference my VS build was failing saying "Namespace can't be found". Finally found the solution here.

I used tlbImp to generate a dll of the COM file using /namespace attribute following this article. Only then you can use the dll in COMFileReference. Here's a bit elaborate example:

<ItemGroup>
   <COMFileReference Include="My/Folder/MyComLibrary.dll">
     <EmbedInteropTypes>True</EmbedInteropTypes>
   </COMFileReference>
</ItemGroup>

or

<ItemGroup>
   <COMFileReference Include="..\My\parent\folder\MyComLibrary.dll">
     <EmbedInteropTypes>True</EmbedInteropTypes>
   </COMFileReference>
</ItemGroup>

TFS Build server and COM references - does this work?

3 Answers3

Linked