|
17 | 17 | <Docs> |
18 | 18 | <summary>Provides an external process for running add-ins out-of-process from the host application.</summary> |
19 | 19 | <remarks> |
20 | | - <format type="text/markdown"><![CDATA[ |
21 | | - |
22 | | -## Remarks |
23 | | - To activate an add-in in an external process, pass an <xref:System.AddIn.Hosting.AddInProcess> object to the appropriate <xref:System.AddIn.Hosting.AddInToken.Activate%60%601%28System.AddIn.Hosting.AddInProcess%2CSystem.Security.PermissionSet%29?displayProperty=nameWithType> method overload. |
24 | | - |
25 | | - The executable that runs the add-in is obtained from one of two files installed with the .NET Framework under the Windows directory. By default, the executable that matches the bits-per-word of the host application is used. If the host is a 64-bit process, AddInProcess.exe is run; otherwise, AddInProcess32.exe is run. To specify the way the executable is selected, use the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor to create the <xref:System.AddIn.Hosting.AddInProcess> object. |
26 | | - |
27 | | - |
28 | | - |
29 | | -## Examples |
30 | | - The following example activates an add-in in an external process. |
31 | | - |
| 20 | + <format type="text/markdown"><![CDATA[ |
| 21 | +
|
| 22 | +## Remarks |
| 23 | + To activate an add-in in an external process, pass an <xref:System.AddIn.Hosting.AddInProcess> object to the appropriate <xref:System.AddIn.Hosting.AddInToken.Activate%60%601%28System.AddIn.Hosting.AddInProcess%2CSystem.Security.PermissionSet%29?displayProperty=nameWithType> method overload. |
| 24 | +
|
| 25 | + The executable that runs the add-in is obtained from one of two files installed with the .NET Framework under the Windows directory. By default, the executable that matches the bits-per-word of the host application is used. If the host is a 64-bit process, AddInProcess.exe is run; otherwise, AddInProcess32.exe is run. To specify the way the executable is selected, use the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor to create the <xref:System.AddIn.Hosting.AddInProcess> object. |
| 26 | +
|
| 27 | +
|
| 28 | +
|
| 29 | +## Examples |
| 30 | + The following example activates an add-in in an external process. |
| 31 | +
|
32 | 32 | :::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet10"::: |
33 | | - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10"::: |
34 | | - |
| 33 | + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10"::: |
| 34 | +
|
35 | 35 | ]]></format> |
36 | 36 | </remarks> |
37 | 37 | <related type="Article" href="/previous-versions/dotnet/netframework-4.0/bb384200(v=vs.100)">Add-Ins and Extensibility</related> |
|
72 | 72 | <Docs> |
73 | 73 | <summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class.</summary> |
74 | 74 | <remarks> |
75 | | - <format type="text/markdown"><![CDATA[ |
76 | | - |
77 | | -## Remarks |
78 | | - This constructor has the same effect as using the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor with the <xref:System.AddIn.Hosting.Platform.Host?displayProperty=nameWithType> flag, to specify that the process that runs the add-in will have the same bits-per-word as the host process. |
79 | | - |
| 75 | + <format type="text/markdown"><![CDATA[ |
| 76 | +
|
| 77 | +## Remarks |
| 78 | + This constructor has the same effect as using the <xref:System.AddIn.Hosting.AddInProcess.%23ctor%28System.AddIn.Hosting.Platform%29> constructor with the <xref:System.AddIn.Hosting.Platform.Host?displayProperty=nameWithType> flag, to specify that the process that runs the add-in will have the same bits-per-word as the host process. |
| 79 | +
|
80 | 80 | ]]></format> |
81 | 81 | </remarks> |
82 | 82 | </Docs> |
|
106 | 106 | <param name="platform">A value that specifies the bits-per-word of the process that runs the add-in.</param> |
107 | 107 | <summary>Initializes a new instance of the <see cref="T:System.AddIn.Hosting.AddInProcess" /> class, specifying the bits-per-word of the process in which the add-in runs.</summary> |
108 | 108 | <remarks> |
109 | | - <format type="text/markdown"><![CDATA[ |
110 | | - |
111 | | -## Remarks |
112 | | - The following table shows how `platform` affects the bits-per-word of the process on different operating systems: |
113 | | - |
114 | | -||32-bit operating system|64-bit operating system| |
115 | | -|-|------------------------------|------------------------------| |
116 | | -|Host|32-bit|Same as the host process| |
117 | | -|AnyCPU|32-bit|64-bit| |
118 | | -|X86|32-bit|32-bit| |
119 | | -|X64|Exception is thrown|64-bit| |
120 | | - |
| 109 | + <format type="text/markdown"><![CDATA[ |
| 110 | +
|
| 111 | +## Remarks |
| 112 | + The following table shows how `platform` affects the bits-per-word of the process on different operating systems: |
| 113 | +
|
| 114 | +| `platform` | 32-bit operating system | 64-bit operating system | |
| 115 | +|------------|-------------------------|--------------------------| |
| 116 | +| Host | 32-bit | Same as the host process | |
| 117 | +| AnyCPU | 32-bit | 64-bit | |
| 118 | +| X86 | 32-bit | 32-bit | |
| 119 | +| X64 | Exception is thrown | 64-bit | |
| 120 | +
|
121 | 121 | ]]></format> |
122 | 122 | </remarks> |
123 | | - <exception cref="T:System.InvalidOperationException">The registry entry for the path to the executable (AddInProcess.exe or AddInProcess32.exe) is missing. |
124 | | - |
125 | | - -or- |
126 | | - |
| 123 | + <exception cref="T:System.InvalidOperationException">The registry entry for the path to the executable (AddInProcess.exe or AddInProcess32.exe) is missing. |
| 124 | + |
| 125 | + -or- |
| 126 | + |
127 | 127 | The executable is missing.</exception> |
128 | 128 | </Docs> |
129 | 129 | </Member> |
|
148 | 148 | <value> |
149 | 149 | <see langword="true" /> if the <see cref="T:System.AddIn.Hosting.AddInProcess" /> object corresponds to the current process; otherwise, <see langword="false" />.</value> |
150 | 150 | <remarks> |
151 | | - <format type="text/markdown"><![CDATA[ |
152 | | - |
153 | | -## Remarks |
154 | | - If the value of this property is `true`, the add-in is running in-process with the host application. In that case, using the <xref:System.AddIn.Hosting.AddInProcess.Start%2A> or <xref:System.AddIn.Hosting.AddInProcess.Shutdown%2A> method throws an <xref:System.InvalidOperationException>. |
155 | | - |
| 151 | + <format type="text/markdown"><![CDATA[ |
| 152 | +
|
| 153 | +## Remarks |
| 154 | + If the value of this property is `true`, the add-in is running in-process with the host application. In that case, using the <xref:System.AddIn.Hosting.AddInProcess.Start%2A> or <xref:System.AddIn.Hosting.AddInProcess.Shutdown%2A> method throws an <xref:System.InvalidOperationException>. |
| 155 | +
|
156 | 156 | > [!NOTE] |
157 | | -> The <xref:System.AddIn.Hosting.AddInEnvironment.Process%2A?displayProperty=nameWithType> property returns an <xref:System.AddIn.Hosting.AddInProcess> object that represents the host application process if the add-in is running in-process. |
158 | | - |
159 | | - |
160 | | - |
161 | | -## Examples |
162 | | - The following example activates an add-in in an external process and uses the <xref:System.AddIn.Hosting.AddInProcess.IsCurrentProcess%2A> property to determine whether the add-in is in the same process as the host application process. |
163 | | - |
| 157 | +> The <xref:System.AddIn.Hosting.AddInEnvironment.Process%2A?displayProperty=nameWithType> property returns an <xref:System.AddIn.Hosting.AddInProcess> object that represents the host application process if the add-in is running in-process. |
| 158 | +
|
| 159 | +
|
| 160 | +
|
| 161 | +## Examples |
| 162 | + The following example activates an add-in in an external process and uses the <xref:System.AddIn.Hosting.AddInProcess.IsCurrentProcess%2A> property to determine whether the add-in is in the same process as the host application process. |
| 163 | +
|
164 | 164 | :::code language="csharp" source="~/snippets/csharp/System.AddIn.Hosting/AddInController/Overview/P3Host.cs" id="Snippet10"::: |
165 | | - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10"::: |
166 | | - |
| 165 | + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/addinP3Host/vb/p3host.vb" id="Snippet10"::: |
| 166 | +
|
167 | 167 | ]]></format> |
168 | 168 | </remarks> |
169 | 169 | </Docs> |
|
199 | 199 | <value> |
200 | 200 | <see langword="true" /> if the external process should be kept alive; otherwise, <see langword="false" />. The default is <see langword="false" />.</value> |
201 | 201 | <remarks> |
202 | | - <format type="text/markdown"><![CDATA[ |
203 | | - |
204 | | -## Remarks |
205 | | - Set this property to `false` to aggressively shut down the external process after the last add-in inside the process has been shut down. |
206 | | - |
| 202 | + <format type="text/markdown"><![CDATA[ |
| 203 | +
|
| 204 | +## Remarks |
| 205 | + Set this property to `false` to aggressively shut down the external process after the last add-in inside the process has been shut down. |
| 206 | +
|
207 | 207 | ]]></format> |
208 | 208 | </remarks> |
209 | 209 | </Docs> |
|
233 | 233 | <summary>Gets the bits-per-word of the process in which the out-of-process add-in is run.</summary> |
234 | 234 | <value>The bits-per-word of the process that runs the add-in.</value> |
235 | 235 | <remarks> |
236 | | - <format type="text/markdown"><![CDATA[ |
237 | | - |
238 | | -## Remarks |
239 | | - The bits-per-word is set when the <xref:System.AddIn.Hosting.AddInProcess> object is initialized, and cannot be changed. |
240 | | - |
| 236 | + <format type="text/markdown"><![CDATA[ |
| 237 | +
|
| 238 | +## Remarks |
| 239 | + The bits-per-word is set when the <xref:System.AddIn.Hosting.AddInProcess> object is initialized, and cannot be changed. |
| 240 | +
|
241 | 241 | ]]></format> |
242 | 242 | </remarks> |
243 | 243 | </Docs> |
|
262 | 262 | <summary>Gets the process ID of the external process.</summary> |
263 | 263 | <value>The process ID, or -1 if the external process has not started.</value> |
264 | 264 | <remarks> |
265 | | - <format type="text/markdown"><![CDATA[ |
266 | | - |
267 | | -## Remarks |
268 | | - Use this property for debugging. |
269 | | - |
| 265 | + <format type="text/markdown"><![CDATA[ |
| 266 | +
|
| 267 | +## Remarks |
| 268 | + Use this property for debugging. |
| 269 | +
|
270 | 270 | ]]></format> |
271 | 271 | </remarks> |
272 | 272 | </Docs> |
|
374 | 374 | <summary>Gets or sets the number of seconds to allow for the process to start.</summary> |
375 | 375 | <value>The number of seconds to allow for process startup.</value> |
376 | 376 | <remarks> |
377 | | - <format type="text/markdown"><![CDATA[ |
378 | | - |
379 | | -## Remarks |
380 | | - The default value is 10 seconds. This property is usually used during debugging, to increase the startup time for the process that runs the out-of-process add-in. |
381 | | - |
| 377 | + <format type="text/markdown"><![CDATA[ |
| 378 | +
|
| 379 | +## Remarks |
| 380 | + The default value is 10 seconds. This property is usually used during debugging, to increase the startup time for the process that runs the out-of-process add-in. |
| 381 | +
|
382 | 382 | ]]></format> |
383 | 383 | </remarks> |
384 | 384 | <exception cref="T:System.InvalidOperationException">The process is already running.</exception> |
|
0 commit comments