Can I embed other files in a DLL?

Question

I'm writing a plug-in for another application through an API. The plug-ins are distributed a DLLs. Is it possible to embed other files in the DLL file like pdfs, images, chm help files etc... I want to be able to provide documentation with my plug-in but I'd still like to retain the ability to distribute the plug-in as a single file the user can just drag and drop onto the application to install.

Answer 1

Resource Files is what you need.

Answer 2

Yes, you can do that.

Add a resource file to your project. Open the resource file in Visual Studio and click Insert Resource. You can select different types of resources, including external files.

Visual Studio will generate code for you so that you can retrieve the files as byte arrays at run time from their names through the Resources identifier.

Answer 3

Sure, you can embed a resource in your DLL. Then at runtime you just do:

Stream stream = Assembly.GetExecutingAssembly().GetManifestResourceStream("com.stackoverflow.plugin.example.Foo.pdf");

This would give you a stream to the Foo.pdf file embedded in your DLL. Pay attention to the fact that the resource name has to be scoped by the namespace of the type from which you're invoking the method.

Answer 4

Sure, just make them "Embedded Resource" in VS.NET (assuming you're using it). You can then read them via resource APIs or simply with Assembly.GetManifestResourceStream().

Answer 5

As an alternate option, if you need to unpack and save the files on the users machine (say a chm file you want accessible outside your app) you can also do the same with zip files.

You said you wanted the file to be "Dragged" onto your app. Simply have your DDE events check to see if the file is a zip (maybe even using something like a jar with metadata) and unpack the necessary files, including the actual plugin.

This is the same idea as openxml docs, they are really just zips in disguise.