Interop type cannot be embedded

Question

I am creating a web application on the .NET 4.0 framework (beta2) in C#.

When I try to use a assembly called "ActiveHomeScriptLib", I get the following error:

Interop type 'ActiveHomeScriptLib.ActiveHomeClass' cannot be embedded. Use the applicable interface instead.

When I change the framework to version 3.5, I don't have any errors.

What is an Interop Type and why does this only occur when I use the 4.0 framework?

Cavender

I've found this article very helpful for resolving interop/PIA issues. blogs.msdn.com/b/vbteam/archive/2010/06/11/… – Thun

Answer 1

.NET 4.0 allows primary interop assemblies (or rather, the bits of it that you need) to be embedded into your assembly so that you don't need to deploy them alongside your application.

For whatever reason, this assembly can't be embedded - but it sounds like that's not a problem for you. Just open the Properties tab for the assembly in Visual Studio 2010 and set "Embed Interop Types" to "False".

EDIT: See also Michael Gustus's answer, removing the Class suffix from the types you're using.

Melidamelilot

Unfortunately, this sounds like just what I need, but this property doesn't seem to be available anymore. – Disrespectable

I was looking in the Project's property page instead of the right-click | Properties on the effected DLL in the References pane. – Sawyer

Wouldn't it make more sense to do as the error says and "use the applicable interface"? I had this error (from a different class) and was able to instantiate an interface which had that class specified as its CoClass attribute, and it worked. As in Michael Gustus' answer below, the interface for BlahClass was just called Blah, which seems to be the standard convention. – Marble

A great thing about embedding is that the Interop assembly can remain CopyLocal=False, as you don't need it at runtime. – Savona

@TimGoodman for me "applicable interface" was not working, but setting above mentioned embed interop types property to false did the trick. In my case - I was working with Microsoft.Office.Interop.Excel library and needed to access Workbook object. Using it's interface Workbook (btw. naming convention...) was not an option - I received COM object, not the desired Microsoft.Office.Interop.Excel.WorkbookClass – Cavalier

@Cavalier You often need an explicit cast from "object" to the desired type – Tripping

For a strange reason the reference property changed and I was getting this error. Thanks this saved me days of trying to figure out the problem – Microphysics

Answer 2

In most cases, this error is the result of code which tries to instantiate a COM object. For example, here is a piece of code starting up Excel:

Excel.ApplicationClass xlapp = new Excel.ApplicationClass();

Typically, in .NET 4 you just need to remove the 'Class' suffix and compile the code:

Excel.Application xlapp = new Excel.Application();

An MSDN explanation is here.

Workbench

+1 I believe this is what the error message is actually telling you to do when it says "use the applicable interface". Note that Excel.Application is an interface (despite the fact that it can be instantiated with the new keyword, similar to the situation described here: #6961410 ) – Marble

"Embed Interop Types" to "False" or "True" ? – Pantin

@Pantin if you follow the advice here you can set the 'Embed Interop Types' back to True, or at least that worked ok for me – Fiery

Answer 3

Like Jan It took me a while to get it .. =S So for anyone else who's blinded with frustration.

• Right click the offending assembly that you added in the solution explorer under your project References. (In my case WIA)
• Click properties.
• And there should be the option there for Embed Interop Assembly.
• Set it to False

Aspa

Still struggling till I realised you had to right-click the interop assembly under the project References in Solution Explorer, NOT the assembly you're building! – Row

Now, (ten years later) this option is called "Embed Interop Types" – Heckle

Answer 4

Here's where to set the Embed Interop in Visual Studio 2012

Kabul

Answer 5

Expanding on Jon's correct answer.

The problem here is that your are combining the new "Embed Interop Types" (or NoPIA) feature with use of a class type. The "Embed Interop Types" feature works by essentially statically linking in all of the types from a PIA (Primary Interop Assembly) into the referencing assembly removing the overhead of deploying it.

This feature works great for most types in a PIA but it does have restrictions. One of them is that you cannot embed classes (it's a servicing issue). Misha has a detailed blog article on why this is not allowed

• http://blogs.msdn.com/mshneer/archive/2009/12/07/interop-type-xxx-cannot-be-embedded-use-the-applicable-interface-instead.aspx

Chrisse

Answer 6

Got the solution

Go to references right click the desired dll you will get option "Embed Interop Types" to "False" or "True".

Gregory

This also worked for VS2015 c# with .net using PP_COM_Wrapper; given in cypress.com Cypress Semiconductor Corporation C# Lib example. Setting to False got rid of the error. – Gilgilba

Answer 7

I ran into this issue when pulling down a TFS project to my local machine. Allegedly, it was working fine on the guy's machine who wrote it. I simply changed this...

WshShellClass shellClass = new WshShellClass();

To this...

WshShell shellClass = new WshShell();

Now, it is working like a champ!

Philharmonic

This approach worked for me as well! In my case, I was debugging to find where the value I needed was, right-clicked and selected "copy expression". What was given to me was "...HTMLDocumentClass..." Removing the text "Class" from it solved the issue for me. – Berlin

Answer 8

I had same problem in VB.NET 2013 with Office 2007, and this solved it:

VS 2013 VB.NET Project > Props > Refs > Microsoft Word 12.0 Object Lib > Embed Interop Types: change True to False

Andel

Answer 9

http://digital.ni.com/public.nsf/allkb/4EA929B78B5718238625789D0071F307

This error occurs because the default value is true for the Embed Interop Types property of the TestStand API Interop assembly referenced in the new project. To resolve this error, change the value of the Embed Interop Types property to False by following these steps: Select the TestStand Interop Assembly reference in the references section of your project in the Solution Explorer. Find the Embed Interop Types property in the Property Browser, and change the value to False

Amadeus

Answer 10

Visual Studio 2017 version 15.8 made it possible to use the PackageReferencesyntax to reference NuGet packages in Visual Studio Extensibility (VSIX) projects. This makes it much simpler to reason about NuGet packages and opens the door for having a complete meta package containing the entire VSSDK.

Installing below NuGet package will solve the EmbedInteropTypes Issue.

Install-Package Microsoft.VisualStudio.SDK.EmbedInteropTypes

Trenna