/
WellKnownClientTypeEntry.xml
226 lines (215 loc) · 14.5 KB
/
WellKnownClientTypeEntry.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
<Type Name="WellKnownClientTypeEntry" FullName="System.Runtime.Remoting.WellKnownClientTypeEntry">
<TypeSignature Language="C#" Value="public class WellKnownClientTypeEntry : System.Runtime.Remoting.TypeEntry" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WellKnownClientTypeEntry extends System.Runtime.Remoting.TypeEntry" />
<TypeSignature Language="DocId" Value="T:System.Runtime.Remoting.WellKnownClientTypeEntry" />
<TypeSignature Language="VB.NET" Value="Public Class WellKnownClientTypeEntry
Inherits TypeEntry" />
<TypeSignature Language="F#" Value="type WellKnownClientTypeEntry = class
 inherit TypeEntry" />
<TypeSignature Language="C++ CLI" Value="public ref class WellKnownClientTypeEntry : System::Runtime::Remoting::TypeEntry" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Runtime.Remoting.TypeEntry</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Runtime.InteropServices.ComVisible(true)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.ComVisible(true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Holds values for an object type registered on the client as a server-activated type (single call or singleton).</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Server-activated types can be either single call or singleton. If a class is registered as a single call type, a new instance is created each time a call from the client arrives. All calls to a singleton object are handled by one instance of that object, unless that object has been collected.
Any client that knows the URI of a registered server-activated object can obtain a proxy for this object by registering the channel it prefers with <xref:System.Runtime.Remoting.Channels.ChannelServices> and activating the object by calling `new` or <xref:System.Activator.GetObject%2A?displayProperty=nameWithType>. To activate a server-activated object with `new`, you must first register the server-activated object type on the client using the <xref:System.Runtime.Remoting.RemotingConfiguration.RegisterWellKnownClientType%2A> method. By calling <xref:System.Runtime.Remoting.RemotingConfiguration.RegisterWellKnownClientType%2A>, you are giving the remoting infrastructure the location of the remote object, which allows the `new` keyword to create it. If, on the other hand, you use the <xref:System.Activator.GetObject%2A?displayProperty=nameWithType> method to activate a server-activated object, you must supply it with the object's URL as an argument, so no prior registration on the client is necessary.
For a detailed description of server-activated objects and remote object activation, see [Activation of Remote Objects](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/cbzcxy2s(v=vs.100)).
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/WellKnownClientTypeEntry_Client/CPP/wellknownclienttypeentry_client.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System.Runtime.Remoting/WellKnownClientTypeEntry/Overview/wellknownclienttypeentry_client.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/WellKnownClientTypeEntry_Client/VB/wellknownclienttypeentry_client.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="M:System.Runtime.Remoting.RemotingConfiguration.RegisterWellKnownClientType(System.Type,System.String)" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/y0h540a7(v=vs.100)">Server Activation</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.WellKnownClientTypeEntry" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WellKnownClientTypeEntry (Type type, string objectUrl);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type type, string objectUrl) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.Remoting.WellKnownClientTypeEntry.#ctor(System.Type,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (type As Type, objectUrl As String)" />
<MemberSignature Language="F#" Value="new System.Runtime.Remoting.WellKnownClientTypeEntry : Type * string -> System.Runtime.Remoting.WellKnownClientTypeEntry" Usage="new System.Runtime.Remoting.WellKnownClientTypeEntry (type, objectUrl)" />
<MemberSignature Language="C++ CLI" Value="public:
 WellKnownClientTypeEntry(Type ^ type, System::String ^ objectUrl);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="type" Type="System.Type" />
<Parameter Name="objectUrl" Type="System.String" />
</Parameters>
<Docs>
<param name="type">The <see cref="T:System.Type" /> of the server-activated type.</param>
<param name="objectUrl">The URL of the server-activated type.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.WellKnownClientTypeEntry" /> class with the given type and URL.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WellKnownClientTypeEntry (string typeName, string assemblyName, string objectUrl);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string typeName, string assemblyName, string objectUrl) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.Remoting.WellKnownClientTypeEntry.#ctor(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (typeName As String, assemblyName As String, objectUrl As String)" />
<MemberSignature Language="F#" Value="new System.Runtime.Remoting.WellKnownClientTypeEntry : string * string * string -> System.Runtime.Remoting.WellKnownClientTypeEntry" Usage="new System.Runtime.Remoting.WellKnownClientTypeEntry (typeName, assemblyName, objectUrl)" />
<MemberSignature Language="C++ CLI" Value="public:
 WellKnownClientTypeEntry(System::String ^ typeName, System::String ^ assemblyName, System::String ^ objectUrl);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="typeName" Type="System.String" />
<Parameter Name="assemblyName" Type="System.String" />
<Parameter Name="objectUrl" Type="System.String" />
</Parameters>
<Docs>
<param name="typeName">The type name of the server-activated type.</param>
<param name="assemblyName">The assembly name of the server-activated type.</param>
<param name="objectUrl">The URL of the server-activated type.</param>
<summary>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.WellKnownClientTypeEntry" /> class with the given type, assembly name, and URL.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplicationUrl">
<MemberSignature Language="C#" Value="public string ApplicationUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ApplicationUrl" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.WellKnownClientTypeEntry.ApplicationUrl" />
<MemberSignature Language="VB.NET" Value="Public Property ApplicationUrl As String" />
<MemberSignature Language="F#" Value="member this.ApplicationUrl : string with get, set" Usage="System.Runtime.Remoting.WellKnownClientTypeEntry.ApplicationUrl" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ApplicationUrl { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the URL of the application to activate the type in.</summary>
<value>The URL of the application to activate the type in.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The application URL is optional and should be set to the URL of the application corresponding to the server-activated object.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ObjectType">
<MemberSignature Language="C#" Value="public Type ObjectType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type ObjectType" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.WellKnownClientTypeEntry.ObjectType" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ObjectType As Type" />
<MemberSignature Language="F#" Value="member this.ObjectType : Type" Usage="System.Runtime.Remoting.WellKnownClientTypeEntry.ObjectType" />
<MemberSignature Language="C++ CLI" Value="public:
 property Type ^ ObjectType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Type" /> of the server-activated client type.</summary>
<value>Gets the <see cref="T:System.Type" /> of the server-activated client type.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ObjectUrl">
<MemberSignature Language="C#" Value="public string ObjectUrl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ObjectUrl" />
<MemberSignature Language="DocId" Value="P:System.Runtime.Remoting.WellKnownClientTypeEntry.ObjectUrl" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ObjectUrl As String" />
<MemberSignature Language="F#" Value="member this.ObjectUrl : string" Usage="System.Runtime.Remoting.WellKnownClientTypeEntry.ObjectUrl" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ObjectUrl { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the URL of the server-activated client object.</summary>
<value>The URL of the server-activated client object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.Remoting.WellKnownClientTypeEntry.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="wellKnownClientTypeEntry.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the full type name, assembly name, and object URL of the server-activated client type as a <see cref="T:System.String" />.</summary>
<returns>The full type name, assembly name, and object URL of the server-activated client type as a <see cref="T:System.String" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Runtime.Remoting.WellKnownClientTypeEntry.ApplicationUrl%2A> is not `null`, it is returned at the end of the string.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>