Specifies the method to call when you register an assembly for use from COM; this enables the execution of user-written code during the registration process.
(in mscorlib.dll)
Visual Basic (Declaration)
<ComVisibleAttribute(True)> _
<AttributeUsageAttribute(AttributeTargets.Method, Inherited := False)> _
Public NotInheritable Class ComRegisterFunctionAttribute _
Inherits Attribute
Dim instance As ComRegisterFunctionAttribute
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets.Method, Inherited = false)]
public sealed class ComRegisterFunctionAttribute : Attribute
[ComVisibleAttribute(true)]
[AttributeUsageAttribute(AttributeTargets::Method, Inherited = false)]
public ref class ComRegisterFunctionAttribute sealed : public Attribute
public final class ComRegisterFunctionAttribute extends Attribute
You can apply this attribute to methods.
ComRegisterFunctionAttribute enables you to add arbitrary registration code to accommodate the requirements of COM clients. For example, you can update the registry using registration functions from the Microsoft.Win32 namespace. If you provide a registration method, you must also apply System.Runtime.InteropServices..::.ComUnregisterFunctionAttribute to an unregistration method, which reverses the operations done in the registration method.
The common language runtime calls the method with this attribute when its containing assembly is registered (directly or indirectly) with the Assembly Registration Tool (Regasm.exe)or through the RegistrationServices..::.RegisterAssembly method.
This attribute can be applied only to methods that have the following characteristics:
Scope: Any (public, private, and so on).
Type: static.
Parameters: Accepts a single Type parameter or a String parameter type.
Return type: void.
The following example demonstrates how to apply ComRegisterFunctionAttribute and ComUnregisterFunctionAttribute to methods with the appropriate signature.
Imports System
Imports System.Runtime.InteropServices
Public Class MyClassThatNeedsToRegister
<ComRegisterFunctionAttribute()> Public Shared Sub _
RegisterFunction(t As Type)
'Insert code here.
End Sub
<ComUnregisterFunctionAttribute()> Public Shared Sub _
UnregisterFunction(t As Type)
'Insert code here.
End Sub
End Class
using System;
using System.Runtime.InteropServices;
public class MyClassThatNeedsToRegister
{
[ComRegisterFunctionAttribute]
public static void RegisterFunction(Type t)
{
//Insert code here.
}
[ComUnregisterFunctionAttribute]
public static void UnregisterFunction(Type t)
{
//Insert code here.
}
}
using namespace System;
using namespace System::Runtime::InteropServices;
public ref class MyClassThatNeedsToRegister
{
public:
[ComRegisterFunctionAttribute]
static void RegisterFunction( Type^ t )
{
//Insert code here.
}
[ComUnregisterFunctionAttribute]
static void UnregisterFunction( Type^ t )
{
//Insert code here.
}
};
import System;
import System.Runtime.InteropServices;
public class MyClassThatNeedsToRegister
{
ComRegisterFunctionAttribute public static function RegisterFunction(t : Type) : void
{
//Insert code here.
}
ComUnregisterFunctionAttribute public static function UnregisterFunction(t : Type) : void
{
//Insert code here.
}
}
System..::.Object
System..::.Attribute
System.Runtime.InteropServices..::.ComRegisterFunctionAttribute
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Reference
Other Resources