Skip to content

Update ComUnregisterFunctionAttribute.xml #2434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 11, 2019
Merged

Update ComUnregisterFunctionAttribute.xml #2434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions xml/System.Runtime.InteropServices/ComUnregisterFunctionAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
## Remarks
You can apply this attribute to methods.

<xref:System.Runtime.InteropServices.ComUnregisterFunctionAttribute> enables you to add code that reverses the operations performed by a registration method. If you apply the <xref:System.Runtime.InteropServices.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 [Regasm.exe (Assembly Registration Tool)](~/docs/framework/tools/regasm-exe-assembly-registration-tool.md) or through the <xref:System.Runtime.InteropServices.RegistrationServices.UnregisterAssembly%2A?displayProperty=nameWithType> API method. Methods with this attribute can have any visibility (public, private, and so on), but must be `static` and must take a single <xref:System.Type> parameter for the <xref:System.Type> to unregister.
`ComUnregisterFunctionAttribute` enables you to add code that reverses the operations performed by a registration method. If you apply the <xref:System.Runtime.InteropServices.ComRegisterFunctionAttribute> to provide a registration method, you should also provide an unregistration method to reverse the operations done in the registration method. You can have only one unregistration method for a class.

**.NET Framework:** The common language runtime calls the method with this attribute when its containing assembly is unregistered (directly or indirectly) with the [Regasm.exe (Assembly Registration) tool)](~/docs/framework/tools/regasm-exe-assembly-registration-tool.md) or through the <xref:System.Runtime.InteropServices.RegistrationServices.RegisterAssembly%2A?displayProperty=nameWithType> method.

**.NET Core:** The common language runtime calls the method with this attribute when its containing assembly's COM host is unregistered via the [RegSvr32.exe tool](https://docs.microsoft.com/windows-server/administration/windows-commands/regsvr32).

## Examples
The following example demonstrates applying <xref:System.Runtime.InteropServices.ComRegisterFunctionAttribute> and <xref:System.Runtime.InteropServices.ComUnregisterFunctionAttribute> to methods with the appropriate signature.
Expand Down Expand Up @@ -93,4 +93,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>