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

ComUnregisterFunctionAttribute Class

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

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

<AttributeUsageAttribute(AttributeTargets.Method, Inherited:=False)> _
<ComVisibleAttribute(True)> _
Public NotInheritable Class ComUnregisterFunctionAttribute
	Inherits Attribute
Dim instance As ComUnregisterFunctionAttribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Method, Inherited=false) */ 
/** @attribute ComVisibleAttribute(true) */ 
public final class ComUnregisterFunctionAttribute extends Attribute
AttributeUsageAttribute(AttributeTargets.Method, Inherited=false) 
public final class ComUnregisterFunctionAttribute extends Attribute
Not applicable.

You can apply this attribute to methods.

ComUnregisterFunctionAttribute enables you to add code that reverses the operations performed by a registration method. If you apply the ComRegisterFunctionAttribute to provide a registration method, you must also provide an unregistration method to reverse the operations done in the registration method. You can have only one unregistration method for a class.

The common language runtime calls the method with this attribute when its containing assembly is unregistered (directly or indirectly) with the Assembly Registration Tool (Regasm.exe) or through the RegistrationServices.UnregisterAssembly 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 unregister.

The following example demonstrates applying 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

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.

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 Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

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

Community Additions

© 2014 Microsoft. All rights reserved.