KB184286 - BUG: Enumerated Type Parameters Break Binary Compatibility

Article ID: 184286

Article Last Modified on 3/11/2005

Microsoft Visual Basic 5.0 Control Creation Edition
Microsoft Visual Basic 5.0 Learning Edition
Microsoft Visual Basic 5.0 Professional Edition
Microsoft Visual Basic 5.0 Enterprise Edition

This article was previously published under Q184286

SYMPTOMS

When developing an ActiveX DLL or ActiveX EXE, Visual Basic might erroneously report that you have broken Binary Compatibility when you try to compile your project. This could happen even if you have not changed a single line of code in your project.

CAUSE

The most common cause for this problem is a known bug, in which ENUMS is used as a function parameter.

For example, if you have the following line of code in an ActiveX DLL:

   Public Property Get MyProp(NewValue As MyEnum) as clsMyClass

When you try to compile this code with Binary Compatibility turned on, you might receive the following error:

MyProp in the MyClass Class Module has arguments and a return type that is incompatible with a similar declaration in version component.

When you receive the error, you can click the "Show Declaration" command button (which shows you the version-compatible declaration of the function and the declaraton in the current project). Note that the two declarations are exactly the same, even though Visual Basic gives the error.

Service Pack 3 for Microsoft Visual Studio addresses this issue, but does not always fix the bug.

For additional information, please see the following article in the Microsoft Knowledge Base:

171819 FIX: Invalid Enum Value Causes Incompatible Binary Compatible

RESOLUTION

The following are three suggested workarounds for this bug:

Do not use Binary Compatibility. This is NOT a good workaround because any client using the ActiveX component must be recompiled each time modifications are made to the component.
Rename all Enum statements as Long. For example, change the following code from:
```
Public Property Get MyProp(NewValue As MyEnum) As clsMyClass

						
```
-to-
```
Public Property Get MyProp(NewValue As Long) as clsMyClass

						
```
This workaround eliminates the Binary Compatibility bug problem; however, there is an associated problem. You lose the "Intellisense" feature when you are programming the ActiveX component.
Place all ENUMS into a separate DLL, and reference the DLL to get the Type Library information about the ENUMS. This workaround ensures that compatibility is kept, and maintains the "Intellisense" feature. This workaround is described in more detail below.

Steps to Implement the Type Library Workaround

The Binary Compatibility bug usually occurs with very large projects, and late in development. However, if you do start receiving broken Binary Compatibility error messages, you should do the following:

Copy all ENUM declarations into a new ActiveX DLL.
Go to the select Project Properties from the Project menu and select the Component tab.
Select the Remote Server Files option. This will make sure that a TLB file is generated when the ActiveX DLL is compiled. A TLB file contains the Type Library for the ActiveX Component it is associated with.
Save the ActiveX DLL for future use.
Compile the ActiveX DLL
Unregister the ActiveX DLL you just compiled by doing the following, select Run from the Windows Start menu and type in the following command:

<Path to RegSvr32>\Regsvr32.Exe /u <Path to Project>\ProjectName.DLL
Load up the actual ActiveX Server that is raising the broken Binary Compatibility error message.
Make sure all the ENUM declarations have been removed.
Select References from the Project menu.
From References, select the "Browse" button.
Locate and select your newly created TLB file.
Compile your ActiveX server. The error message will no longer appear.

You can also bypass unregistering the ActiveX DLL which contains the ENUM declares, and reference the DLL itself instead of the TLB file.

STATUS

Microsoft has confirmed this to be a bug in the Microsoft products listed at the beginning of this article.

Additional query words: kbDSupport kbdss vb6test

Keywords: kbbug kbpending KB184286