CA1411: COM registration methods should not be visible
TypeName |
ComRegistrationMethodsShouldNotBeVisible |
CheckId |
CA1411 |
Category |
Microsoft.Interoperability |
Breaking Change |
Breaking |
Cause
A method that is marked with the ComRegisterFunctionAttribute or the ComUnregisterFunctionAttribute attribute is externally visible.
Rule Description
When an assembly is registered with Component Object Model (COM), entries are added to the registry for each COM-visible type in the assembly. Methods that are marked with the ComRegisterFunctionAttribute and ComUnregisterFunctionAttribute attributes are called during the registration and unregistration processes, respectively, to run user code that is specific to the registration/unregistration of these types. This code should not be called outside these processes.
How to Fix Violations
To fix a violation of this rule, change the accessibility of the method to private or internal (Friend in Visual Basic).
When to Suppress Warnings
Do not suppress a warning from this rule.
Example
The following example shows two methods that violate the rule.
Imports System
Imports System.Runtime.InteropServices
<Assembly: ComVisibleAttribute(True)>
Namespace InteroperabilityLibrary
Public Class ClassToRegister
End Class
Public Class ComRegistration
<ComRegisterFunctionAttribute> _
Public Shared Sub RegisterFunction(typeToRegister As Type)
End Sub
<ComUnregisterFunctionAttribute> _
Public Shared Sub UnregisterFunction(typeToRegister As Type)
End Sub
End Class
End Namespace
using System;
using System.Runtime.InteropServices;
[assembly: ComVisible(true)]
namespace InteroperabilityLibrary
{
public class ClassToRegister
{
}
public class ComRegistration
{
[ComRegisterFunction]
public static void RegisterFunction(Type typeToRegister) {}
[ComUnregisterFunction]
public static void UnregisterFunction(Type typeToRegister) {}
}
}
Related Rules
CA1410: COM registration methods should be matched
See Also
Reference
Regasm.exe (Assembly Registration Tool)