ComRegisterFunctionAttribute Class

Definition

Задает метод, вызываемый при регистрации сборки для использования из COM. Это позволяет выполнять код, написанный пользователем, в процессе регистрации.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.

public ref class ComRegisterFunctionAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=false)]
public sealed class ComRegisterFunctionAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=false)]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ComRegisterFunctionAttribute : Attribute
type ComRegisterFunctionAttribute = class
    inherit Attribute
Public NotInheritable Class ComRegisterFunctionAttribute
Inherits Attribute
Inheritance
ComRegisterFunctionAttribute
Attributes

Examples

В следующем примере показано, как применить ComRegisterFunctionAttribute и ComUnregisterFunctionAttribute к методам с соответствующей сигнатурой.The following example demonstrates how to apply ComRegisterFunctionAttribute and ComUnregisterFunctionAttribute to methods with the appropriate signature.

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

};

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

Remarks

Этот атрибут можно применить к методам.You can apply this attribute to methods.

ComRegisterFunctionAttribute позволяет добавить произвольный код регистрации для удовлетворения требований клиентов COM.ComRegisterFunctionAttribute enables you to add arbitrary registration code to accommodate the requirements of COM clients. Например, можно обновить реестр, используя функции регистрации из пространства имен Microsoft.Win32.For example, you can update the registry using registration functions from the Microsoft.Win32 namespace. При предоставлении метода регистрации следует также применить System.Runtime.InteropServices.ComUnregisterFunctionAttribute к методу отмены регистрации, который отменяет операции, выполненные в методе регистрации.If you provide a registration method, you should also apply System.Runtime.InteropServices.ComUnregisterFunctionAttribute to an unregistration method, which reverses the operations done in the registration method.

.NET Framework: Среда CLR вызывает метод с этим атрибутом, когда содержащая его сборка регистрируется (прямо или косвенно) с помощью средства Regasm. exe (регистрация сборки) или метода RegistrationServices.RegisterAssembly..NET Framework: The common language runtime calls the method with this attribute when its containing assembly is registered (directly or indirectly) with the Regasm.exe (Assembly Registration) tool) or through the RegistrationServices.RegisterAssembly method.

.NET Core: Среда CLR вызывает метод с этим атрибутом, когда узел COM содержащей его сборки зарегистрирован с помощью средства Regsvr32. exe..NET Core: The common language runtime calls the method with this attribute when its containing assembly's COM host is registered via the RegSvr32.exe tool.

Этот атрибут может применяться только к методам, имеющим следующие характеристики.This attribute can be applied only to methods that have the following characteristics:

  • Область: любая (открытая, Частная и т. д.).Scope: Any (public, private, and so on).

  • Введите static.Type: static.

  • Параметры: принимает один Type параметр или тип параметра String.Parameters: Accepts a single Type parameter or a String parameter type.

  • Тип возвращаемого значения: void.Return type: void.

Constructors

ComRegisterFunctionAttribute()

Инициализирует новый экземпляр класса ComRegisterFunctionAttribute.Initializes a new instance of the ComRegisterFunctionAttribute class.

Properties

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also