Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ComRegisterFunctionAttribute Class

Specifies the method to call when you register an assembly for use from COM; this allows for the execution of user-written code during the registration process.

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

[ComVisibleAttribute(true)] 
[AttributeUsageAttribute(AttributeTargets.Method, Inherited=false)] 
public sealed class ComRegisterFunctionAttribute : Attribute
/** @attribute ComVisibleAttribute(true) */ 
/** @attribute AttributeUsageAttribute(AttributeTargets.Method, Inherited=false) */ 
public final class ComRegisterFunctionAttribute extends Attribute
ComVisibleAttribute(true) 
AttributeUsageAttribute(AttributeTargets.Method, Inherited=false) 
public final class ComRegisterFunctionAttribute extends Attribute

You can apply this attribute to methods.

ComRegisterFunctionAttribute enables you to add abritrary 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 API method. Methods with this attribute can have any visibility (public, private, and so on), but must be static and must take a single Type parameter for the type to register.

The following example demonstrates how to apply ComRegisterFunctionAttribute and ComUnregisterFunctionAttribute to methods with the appropriate signature.

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.
   }
}

import System.*;
import System.Runtime.InteropServices.*;

public class MyClassThatNeedsToRegister
{
    /** @attribute ComRegisterFunctionAttribute()
     */
    public static void RegisterFunction(Type t)
    {
        //Insert code here.
    } //RegisterFunction

    /** @attribute ComUnregisterFunctionAttribute()
     */
    public static void UnregisterFunction(Type t)
    {
        //Insert code here.
    } //UnregisterFunction
} //MyClassThatNeedsToRegister

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 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.