Click here to Skip to main content
Click here to Skip to main content

Exporting C++ Classes from an MFC Extension DLL

, 15 Dec 1999
Rate this:
Please Sign up or sign in to vote.
How to simplify importing and exporting classes from an extension DLL
<!-- Article Starts -->

Exporting C++ classes from extension DLLs and importing those classes into applications can be a little confusing at times.  This article discusses one of many ways to simplify this.  Also discussed is a technique to ensure that your DLL's .LIB file is automatically linked into any application (or other DLL) using your DLL, avoiding the need to alter your project link settings.

When building an extension DLL, you want the compiler/linker to export selected C++ classes, but when building your application you want to import those classes.

Traditionally, this has been done by using the AFX_CLASS_EXPORT and AFX_CLASS_IMPORT defines (defined in afxv_dll.h). Swapping these #defines in and out depending on whether you're building the DLL itself or building an application (or another DLL) which uses your exported classes.

If we look at how  AFX_CLASS_EXPORT and AFX_CLASS_IMPORT are defined in afxv_dll.h we see the following.

#define AFX_CLASS_EXPORT __declspec(dllexport)
#define AFX_CLASS_IMPORT __declspec(dllimport)

So, when exporting our classes from our DLL we want the class declarations from the DLL to look like this:-

class __declspec(dllexport) CMyClass : public CObject
{
	...
}

And, when importing our C++ classes into our application we want the class declarations from the DLL to look like this:-

class __declspec(dllimport) CMyClass : public CObject
{
	...
}

OK, so here's how I do things.

In the stdafx.h file for the export DLL, include two #defines at the bottom of the file like this:-

#define _MYLIB_DLLAPI_
#define _MYLIB_NOAUTOLIB_

Now, in the main header file for your DLL, say mylib.h (the main 'point of entry' header for your DLL that you will include in you application later), add the following at the top:-

// The following will ensure that we are exporting our C++ classes when 
// building the DLL and importing the classes when build an application 
// using this DLL.

#ifdef _MYLIB_DLLAPI_
    #define MYLIB_DLLAPI  __declspec( dllexport )
#else
    #define MYLIB_DLLAPI  __declspec( dllimport )
#endif

// The following will ensure that when building an application (or another
// DLL) using this DLL, the appropriate .LIB file will automatically be used
// when linking.

#ifndef _MYLIB_NOAUTOLIB_
#ifdef _DEBUG
#pragma comment(lib, "mylibd.lib")
#else
#pragma comment(lib, "mylib.lib")
#endif
#endif

Now, just declare all the C++ classes you want exported from the DLL like this:-
(Note: Any C++ classes not declared with MYLIB_DLLAPI will not be exported from the DLL)

class MYLIB_DLLAPI CMyClass : public CObject
{
	...
}

So, how does it work? 

When building your DLL, _MYLIB_DLLAPI_ is defined in the DLL's stdafx.h file, so MYLIB_DLLAPI is then defined as __declspec( dllexport ) and your C++ classes will be exported.

When building your application, _MYLIB_DLLAPI_ isn't defined, so MYLIB_DLLAPI will be defined as __declspec( dllimport ) and your classes will be imported.

The other nifty part is the _MYLIB_NOAUTOLIB_.  If _MYLIB_NOAUTOLIB_ isn't defined, (i.e. when building your application), an entry like #pragma comment(lib, "mylibd.lib") appears which tells the linker to automatically link in your DLL's .LIB file.  Hence, there's no need to add the .LIB file to the Object/library modules section in your application project link settings (something I invariable forgot to do!).

The above is basically a 'set and forget' technique.  All you'll ever need to do to use you extension DLL is just include it's header in your application, and all the ugly class export/import stuff is sorted for you.

(I can't remember where I picked up this technique originally, but full credit to it's originator as it's proved invaluable over the years.)

 

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Steve Driessens
Web Developer
Australia Australia
Sole programmer for a small Brisbane (Australia) based software company.

Comments and Discussions

 
GeneralMy vote of 5 PinmemberBraga4215-May-13 12:21 
QuestionVB.NET dll in MFC? PinmemberG_T18-Oct-07 3:46 
QuestionDo we need those defines in vc8? PinmemberSwinefeaster30-Jan-06 16:03 
AnswerRe: Do we need those defines in vc8? PinmemberJohn M. Drescher30-Jan-06 17:22 
QuestionHow to import? PinmemberarkopII9-Apr-05 6:19 
AnswerRe: How to import? PinmemberJohn M. Drescher30-Jan-06 17:24 
GeneralDeserialization in MFC PinsussET1984inside21-Oct-04 3:42 
GeneralCan't add a reference to the specified file. PinsussKay PEE31-Aug-04 19:09 
GeneralRe: Can't add a reference to the specified file. PinsussAnonymous28-Feb-05 10:51 
GeneralRe: Can't add a reference to the specified file. PinsussAnonymous18-Oct-05 22:59 
GeneralRe: Can't add a reference to the specified file. PinmemberJeffrey Walton5-Aug-07 5:48 
Generalincluding functions of a DLL into ObjectARX Pinsusssmartgms113-Jan-04 16:16 
QuestionHow to port extension dll for VB use? Pinmemberinglooi10-Nov-03 19:34 
QuestionHow Can I Export a DLL ActiveX VB ? Pinmemberziadin8-Aug-03 0:53 

 
Hello
 
I have created a DLL ActiveX in VB, and generate de DLL ,but when a try to use the GetProcAddress function in VC I can't find my function...
 
Is there any equivalent sentence in VB to the extern "C" __declspec(dllexport)
 
Thanks a lot
 
Ziadin
Generalhi PinsussAnonymous26-Mar-03 18:03 
QuestionHow can one use VC++ class through VB? PinsussAnonymous9-Feb-03 19:04 
GeneralProblems importing DLL extension Classes PinsussAnonymous21-Aug-02 23:22 
GeneralRe: Problems importing DLL extension Classes PinsussKay PEE31-Aug-04 19:24 
General#pragma comment(lib, "mylib.lib") doesn't work PinsussAnonymous17-Jul-02 22:19 
GeneralRe: #pragma comment(lib, &quot;mylib.lib&quot;) doesn't work PinsussKay PEE31-Aug-04 19:20 
GeneralExporting a class that contains STL string PinmemberSteffen.Knoll21-Jun-02 23:52 
GeneralExporting a class that contains STL string PinmemberSteffen.Knoll21-Jun-02 23:51 
GeneralRe: Exporting a class that contains STL string PinmemberNeville Franks15-Jan-03 1:12 
GeneralRe: Exporting a class that contains STL string PinsussAnonymous15-Jul-04 15:31 
GeneralRe: Exporting a class that contains STL string PinmemberJohn M. Drescher30-Jan-06 17:29 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web02 | 2.8.140709.1 | Last Updated 16 Dec 1999
Article Copyright 1999 by Steve Driessens
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid