/
RegistrationHelper.xml
307 lines (289 loc) · 21.6 KB
/
RegistrationHelper.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<Type Name="RegistrationHelper" FullName="System.EnterpriseServices.RegistrationHelper">
<TypeSignature Language="C#" Value="public sealed class RegistrationHelper : MarshalByRefObject, System.EnterpriseServices.IRegistrationHelper" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RegistrationHelper extends System.MarshalByRefObject implements class System.EnterpriseServices.IRegistrationHelper" />
<TypeSignature Language="DocId" Value="T:System.EnterpriseServices.RegistrationHelper" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RegistrationHelper
Inherits MarshalByRefObject
Implements IRegistrationHelper" />
<TypeSignature Language="F#" Value="type RegistrationHelper = class
 inherit MarshalByRefObject
 interface IRegistrationHelper" />
<TypeSignature Language="C++ CLI" Value="public ref class RegistrationHelper sealed : MarshalByRefObject, System::EnterpriseServices::IRegistrationHelper" />
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.EnterpriseServices.IRegistrationHelper</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.Guid("89a86e7b-c229-4008-9baa-2f5c8411d7e0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("89a86e7b-c229-4008-9baa-2f5c8411d7e0")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Installs and configures assemblies in the COM+ catalog. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.EnterpriseServices.RegistrationHelper> is used by both the .NET Services Installation Tool (Regsvcs.exe) and the automatic registration steps that are performed on first activation of a <xref:System.EnterpriseServices.ServicedComponent>.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RegistrationHelper ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 RegistrationHelper();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.EnterpriseServices.RegistrationHelper" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="InstallAssembly">
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Provides the run-time components available to the COM+ catalog.</summary>
</Docs>
</MemberGroup>
<Member MemberName="InstallAssembly">
<MemberSignature Language="C#" Value="public void InstallAssembly (string assembly, ref string application, ref string tlb, System.EnterpriseServices.InstallationFlags installFlags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void InstallAssembly(string assembly, string& application, string& tlb, valuetype System.EnterpriseServices.InstallationFlags installFlags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.InstallAssembly(System.String,System.String@,System.String@,System.EnterpriseServices.InstallationFlags)" />
<MemberSignature Language="VB.NET" Value="Public Sub InstallAssembly (assembly As String, ByRef application As String, ByRef tlb As String, installFlags As InstallationFlags)" />
<MemberSignature Language="F#" Value="abstract member InstallAssembly : string * string * string * System.EnterpriseServices.InstallationFlags -> unit
override this.InstallAssembly : string * string * string * System.EnterpriseServices.InstallationFlags -> unit" Usage="registrationHelper.InstallAssembly (assembly, application, tlb, installFlags)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void InstallAssembly(System::String ^ assembly, System::String ^ % application, System::String ^ % tlb, System::EnterpriseServices::InstallationFlags installFlags);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.EnterpriseServices.IRegistrationHelper.InstallAssembly(System.String,System.String@,System.String@,System.EnterpriseServices.InstallationFlags)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assembly" Type="System.String" />
<Parameter Name="application" Type="System.String" RefType="ref" />
<Parameter Name="tlb" Type="System.String" RefType="ref" />
<Parameter Name="installFlags" Type="System.EnterpriseServices.InstallationFlags" />
</Parameters>
<Docs>
<param name="assembly">The file name of the assembly to install.</param>
<param name="application">The name of the COM+ application to install into. This parameter can be <see langword="null" />. If the parameter is <see langword="null" /> and the assembly contains a <see cref="T:System.EnterpriseServices.ApplicationNameAttribute" />, then the attribute is used. Otherwise, the name of the application is generated based on the name of the assembly, then is returned.</param>
<param name="tlb">The name of the output Type Library Exporter (Tlbexp.exe) file, or a string that contains <see langword="null" /> if the registration helper is expected to generate the name. The actual name used is placed in the parameter on call completion.</param>
<param name="installFlags">A bitwise combination of the <see cref="T:System.EnterpriseServices.InstallationFlags" /> values.</param>
<summary>Installs the named assembly in a COM+ application.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.EnterpriseServices.RegistrationHelper.InstallAssembly%2A> performs the following steps: registration, generation of a type library, registration of the type library, installation of the type library under the specified application, and configuration of the components contained in the type library.
This method requires the caller to have administrative privileges on the local computer.
## Examples
The following code example shows how to use the `InstalAssembly` method to install a named assembly in a COM+ application.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices Registration/CPP/deployservicedcomponent.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/RegistrationErrorInfo/Overview/deployservicedcomponent.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices Registration/VB/deployservicedcomponent.vb" id="Snippet1":::
]]></format>
</remarks>
<exception cref="T:System.EnterpriseServices.RegistrationException">The input assembly does not have a strong name.</exception>
</Docs>
</Member>
<Member MemberName="InstallAssembly">
<MemberSignature Language="C#" Value="public void InstallAssembly (string assembly, ref string application, string partition, ref string tlb, System.EnterpriseServices.InstallationFlags installFlags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void InstallAssembly(string assembly, string& application, string partition, string& tlb, valuetype System.EnterpriseServices.InstallationFlags installFlags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.InstallAssembly(System.String,System.String@,System.String,System.String@,System.EnterpriseServices.InstallationFlags)" />
<MemberSignature Language="VB.NET" Value="Public Sub InstallAssembly (assembly As String, ByRef application As String, partition As String, ByRef tlb As String, installFlags As InstallationFlags)" />
<MemberSignature Language="F#" Value="member this.InstallAssembly : string * string * string * string * System.EnterpriseServices.InstallationFlags -> unit" Usage="registrationHelper.InstallAssembly (assembly, application, partition, tlb, installFlags)" />
<MemberSignature Language="C++ CLI" Value="public:
 void InstallAssembly(System::String ^ assembly, System::String ^ % application, System::String ^ partition, System::String ^ % tlb, System::EnterpriseServices::InstallationFlags installFlags);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assembly" Type="System.String" />
<Parameter Name="application" Type="System.String" RefType="ref" />
<Parameter Name="partition" Type="System.String" />
<Parameter Name="tlb" Type="System.String" RefType="ref" />
<Parameter Name="installFlags" Type="System.EnterpriseServices.InstallationFlags" />
</Parameters>
<Docs>
<param name="assembly">The file name of the assembly to install.</param>
<param name="application">The name of the COM+ application to install into. This parameter can be <see langword="null" />. If the parameter is <see langword="null" /> and the assembly contains a <see cref="T:System.EnterpriseServices.ApplicationNameAttribute" />, then the attribute is used. Otherwise, the name of the application is generated based on the name of the assembly, then is returned.</param>
<param name="partition">The name of the partition. This parameter can be <see langword="null" />.</param>
<param name="tlb">The name of the output Type Library Exporter (Tlbexp.exe) file, or a string that contains <see langword="null" /> if the registration helper is expected to generate the name. The actual name used is placed in the parameter on call completion.</param>
<param name="installFlags">A bitwise combination of the <see cref="T:System.EnterpriseServices.InstallationFlags" /> values.</param>
<summary>Installs the named assembly in a COM+ application.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.EnterpriseServices.RegistrationHelper.InstallAssembly%2A> performs the following steps: registration, generation of a type library, registration of the type library, installation of the type library under the specified application, and configuration of the components contained in the type library.
This method requires the caller to have administrative privileges on the local computer.
]]></format>
</remarks>
<exception cref="T:System.EnterpriseServices.RegistrationException">The input assembly does not have a strong name.</exception>
</Docs>
</Member>
<Member MemberName="InstallAssemblyFromConfig">
<MemberSignature Language="C#" Value="public void InstallAssemblyFromConfig (ref System.EnterpriseServices.RegistrationConfig regConfig);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void InstallAssemblyFromConfig(class System.EnterpriseServices.RegistrationConfig& regConfig) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.InstallAssemblyFromConfig(System.EnterpriseServices.RegistrationConfig@)" />
<MemberSignature Language="VB.NET" Value="Public Sub InstallAssemblyFromConfig (ByRef regConfig As RegistrationConfig)" />
<MemberSignature Language="F#" Value="member this.InstallAssemblyFromConfig : RegistrationConfig -> unit" Usage="registrationHelper.InstallAssemblyFromConfig regConfig" />
<MemberSignature Language="C++ CLI" Value="public:
 void InstallAssemblyFromConfig(System::EnterpriseServices::RegistrationConfig ^ % regConfig);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="regConfig" Type="System.EnterpriseServices.RegistrationConfig" RefType="ref" />
</Parameters>
<Docs>
<param name="regConfig">A <see cref="T:System.EnterpriseServices.RegistrationConfig" /> identifying the assembly to install.</param>
<summary>Installs the named assembly in a COM+ application.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method requires the caller to have administrative privileges on the local computer.
## Examples
The following code example shows how to use the `InstalAssemblyFromConfig` method to install a named assembly in a COM+ application.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices Registration/CPP/deployservicedcomponent.cpp" id="Snippet2":::
:::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/RegistrationErrorInfo/Overview/deployservicedcomponent.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices Registration/VB/deployservicedcomponent.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="UninstallAssembly">
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Uninstalls an assembly previous registered with <see cref="M:System.EnterpriseServices.RegistrationHelper.InstallAssembly(System.String,System.String@,System.String@,System.EnterpriseServices.InstallationFlags)" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName="UninstallAssembly">
<MemberSignature Language="C#" Value="public void UninstallAssembly (string assembly, string application);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UninstallAssembly(string assembly, string application) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.UninstallAssembly(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub UninstallAssembly (assembly As String, application As String)" />
<MemberSignature Language="F#" Value="abstract member UninstallAssembly : string * string -> unit
override this.UninstallAssembly : string * string -> unit" Usage="registrationHelper.UninstallAssembly (assembly, application)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void UninstallAssembly(System::String ^ assembly, System::String ^ application);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.EnterpriseServices.IRegistrationHelper.UninstallAssembly(System.String,System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assembly" Type="System.String" />
<Parameter Name="application" Type="System.String" />
</Parameters>
<Docs>
<param name="assembly">The file name of the assembly to uninstall.</param>
<param name="application">If this name is not <see langword="null" />, it is the name of the application that contains the components in the assembly.</param>
<summary>Uninstalls the assembly from the given application.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.EnterpriseServices.RegistrationException">The input assembly does not have a strong name.</exception>
</Docs>
</Member>
<Member MemberName="UninstallAssembly">
<MemberSignature Language="C#" Value="public void UninstallAssembly (string assembly, string application, string partition);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UninstallAssembly(string assembly, string application, string partition) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.UninstallAssembly(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub UninstallAssembly (assembly As String, application As String, partition As String)" />
<MemberSignature Language="F#" Value="member this.UninstallAssembly : string * string * string -> unit" Usage="registrationHelper.UninstallAssembly (assembly, application, partition)" />
<MemberSignature Language="C++ CLI" Value="public:
 void UninstallAssembly(System::String ^ assembly, System::String ^ application, System::String ^ partition);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="assembly" Type="System.String" />
<Parameter Name="application" Type="System.String" />
<Parameter Name="partition" Type="System.String" />
</Parameters>
<Docs>
<param name="assembly">The file name of the assembly to uninstall.</param>
<param name="application">If this name is not <see langword="null" />, it is the name of the application that contains the components in the assembly.</param>
<param name="partition">The name of the partition. This parameter can be <see langword="null" />.</param>
<summary>Uninstalls the assembly from the given application.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.EnterpriseServices.RegistrationException">The input assembly does not have a strong name.</exception>
</Docs>
</Member>
<Member MemberName="UninstallAssemblyFromConfig">
<MemberSignature Language="C#" Value="public void UninstallAssemblyFromConfig (ref System.EnterpriseServices.RegistrationConfig regConfig);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UninstallAssemblyFromConfig(class System.EnterpriseServices.RegistrationConfig& regConfig) cil managed" />
<MemberSignature Language="DocId" Value="M:System.EnterpriseServices.RegistrationHelper.UninstallAssemblyFromConfig(System.EnterpriseServices.RegistrationConfig@)" />
<MemberSignature Language="VB.NET" Value="Public Sub UninstallAssemblyFromConfig (ByRef regConfig As RegistrationConfig)" />
<MemberSignature Language="F#" Value="member this.UninstallAssemblyFromConfig : RegistrationConfig -> unit" Usage="registrationHelper.UninstallAssemblyFromConfig regConfig" />
<MemberSignature Language="C++ CLI" Value="public:
 void UninstallAssemblyFromConfig(System::EnterpriseServices::RegistrationConfig ^ % regConfig);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.EnterpriseServices</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="regConfig" Type="System.EnterpriseServices.RegistrationConfig" RefType="ref" />
</Parameters>
<Docs>
<param name="regConfig">A <see cref="T:System.EnterpriseServices.RegistrationConfig" /> identifying the assembly to uninstall.</param>
<summary>Uninstalls the assembly from the given application.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>