-
Notifications
You must be signed in to change notification settings - Fork 12
/
Broadcast.xml
435 lines (435 loc) · 22.2 KB
/
Broadcast.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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
<Type Name="Broadcast" FullName="Microsoft.Office.Interop.Word.Broadcast">
<TypeSignature Language="C#" Value="public interface Broadcast" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract Broadcast" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.Word.Broadcast" />
<TypeSignature Language="VB.NET" Value="Public Interface Broadcast" />
<TypeSignature Language="C++ CLI" Value="public interface class Broadcast" />
<TypeSignature Language="F#" Value="type Broadcast = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("B67DE22C-BC01-4A73-A99B-070D1B5A795D")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.TypeLibType(4288)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a Windows Live Broadcast Service broadcast session.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddMeetingNotes">
<MemberSignature Language="C#" Value="public void AddMeetingNotes (string notesUrl, string notesWacUrl);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddMeetingNotes([in]string notesUrl, [in]string notesWacUrl) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.Word.Broadcast.AddMeetingNotes(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddMeetingNotes (notesUrl As String, notesWacUrl As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 void AddMeetingNotes(System::String ^ notesUrl, System::String ^ notesWacUrl);" />
<MemberSignature Language="F#" Value="abstract member AddMeetingNotes : string * string -> unit" Usage="broadcast.AddMeetingNotes (notesUrl, notesWacUrl)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(105)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="notesUrl" Type="System.String" />
<Parameter Name="notesWacUrl" Type="System.String" />
</Parameters>
<Docs>
<param name="notesUrl">Specifies the URL where the shared meeting notes are stored, for attendees using the OneNote rich client.</param>
<param name="notesWacUrl">Specifies the URL where the shared meeting notes are stored, for attendees using the OneNote Online client.</param>
<summary>Adds shared meeting notes for the specified broadcast that are accessible to attendees who use either OneNote 2013 rich client or web app.</summary>
<remarks>
<para>If you fail to pass a string for either of the two parameters, the <b>AddMeetingNotes</b> method returns an Invalid Parameter error. If for any reason the method call fails, Word returns a generic broadcast error.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Application">
<MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.Application Application { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.Application Application" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Application" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Interop::Word::Application ^ Application { Microsoft::Office::Interop::Word::Application ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Application : Microsoft.Office.Interop.Word.Application" Usage="Microsoft.Office.Interop.Word.Broadcast.Application" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1000)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1000)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Interop.Word.Application</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <see cref="T:Microsoft.Office.Interop.Word.Application" /> object that represents the Microsoft Word application.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AttendeeUrl">
<MemberSignature Language="C#" Value="public string AttendeeUrl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AttendeeUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.AttendeeUrl" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AttendeeUrl As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ AttendeeUrl { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.AttendeeUrl : string" Usage="Microsoft.Office.Interop.Word.Broadcast.AttendeeUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>If a broadcast is in progress, returns a <b>String</b> (<b>string</b> in C#) that represents the URL of the attendee link. Read-only.</summary>
<value>To be added.</value>
<remarks>
<para>If a broadcast is not in progress, <b>AttendeeUrl</b> returns an empty string.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Capabilities">
<MemberSignature Language="C#" Value="public int Capabilities { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Capabilities" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.Capabilities" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Capabilities As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Capabilities { int get(); };" />
<MemberSignature Language="F#" Value="member this.Capabilities : int" Usage="Microsoft.Office.Interop.Word.Broadcast.Capabilities" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(3)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(3)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a <b>UInteger</b> (<b>uint</b> in C#) that represents the capabilities of the specified broadcast. Read-only.</summary>
<value>To be added.</value>
<remarks>
<para>The <b>Capabilities</b> property can return the following values:</para>
<list type="table">
<item>
<description>
<b>MSOBroadcastCapFileSizeLimited</b>
</description>
<description>1</description>
<description>File size limited</description>
</item>
<item>
<description>
<b>MSOBroadcastCapSupportsMeetingNotes</b>
</description>
<description>2</description>
<description>Supports meeting notes</description>
</item>
<item>
<description>
<b>MSOBroadcastCapSupportsUpdateDoc</b>
</description>
<description>4</description>
<description>Supports document update</description>
</item>
</list>
<para>The values returned correspond to either Microsoft Office 2013 or Microsoft Office 2010 broadcast presentation service capabilities.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="End">
<MemberSignature Language="C#" Value="public void End ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void End() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.Word.Broadcast.End" />
<MemberSignature Language="VB.NET" Value="Public Sub End ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void End();" />
<MemberSignature Language="F#" Value="abstract member End : unit -> unit" Usage="broadcast.End " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(104)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Ends the specified broadcast session.</summary>
<remarks>
<para>Calling the <b>End</b> method terminates the broadcast session without displaying a confirmation prompt to the user. It also sets the value of the <see cref="P:Microsoft.Office.Interop.Word.Broadcast.AttendeeUrlproperty" /> to an empty string.</para>
<para>If the document is not being broadcast, the method returns runtime error 4702.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C#" Value="public object Parent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Parent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Parent { System::Object ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Interop.Word.Broadcast.Parent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1002)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1002)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <b>Object</b> that represents the parent object of the specified <b>Broadcast</b> object</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pause">
<MemberSignature Language="C#" Value="public void Pause ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Pause() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.Word.Broadcast.Pause" />
<MemberSignature Language="VB.NET" Value="Public Sub Pause ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Pause();" />
<MemberSignature Language="F#" Value="abstract member Pause : unit -> unit" Usage="broadcast.Pause " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(102)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Pauses the specified broadcast.</summary>
<remarks>
<para>If the specified broadcast is not in progress, <b>Pause</b> returns runtime error 4702.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="PresenterServiceUrl">
<MemberSignature Language="C#" Value="public string PresenterServiceUrl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PresenterServiceUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.PresenterServiceUrl" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PresenterServiceUrl As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ PresenterServiceUrl { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.PresenterServiceUrl : string" Usage="Microsoft.Office.Interop.Word.Broadcast.PresenterServiceUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(4)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(4)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>If a broadcast is in progress, returns a <b>String</b> (<b>string</b> in C#) that represents the URL of the presenter service hosting the broadcast. Read-only.</summary>
<value>To be added.</value>
<remarks>
<para>If a broadcast is not in progress, <b>PresenterServiceUrl</b> returns an empty string.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Resume">
<MemberSignature Language="C#" Value="public void Resume ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Resume() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.Word.Broadcast.Resume" />
<MemberSignature Language="VB.NET" Value="Public Sub Resume ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Resume();" />
<MemberSignature Language="F#" Value="abstract member Resume : unit -> unit" Usage="broadcast.Resume " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(103)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Resumes the specified broadcast.</summary>
<remarks>
<para>The <b>Resume</b> method returns an error (#4700) if the document is DRM protected, is already being broadcast (#4698), is not being broadcast at all (#4702), or has conflicting edits (is in merge mode, #4701).</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="SessionID">
<MemberSignature Language="C#" Value="public string SessionID { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SessionID" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.SessionID" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SessionID As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ SessionID { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.SessionID : string" Usage="Microsoft.Office.Interop.Word.Broadcast.SessionID" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(5)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(5)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>If a broadcast is in progress, returns a <b>String</b> (<b>string</b> in C#) that specifies the ID of the session. Read-only.</summary>
<value>To be added.</value>
<remarks>
<para>If a broadcast is not in progress, <b>SessionID</b> returns an empty string.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public void Start (string serverUrl);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Start([in]string serverUrl) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.Word.Broadcast.Start(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Start (serverUrl As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Start(System::String ^ serverUrl);" />
<MemberSignature Language="F#" Value="abstract member Start : string -> unit" Usage="broadcast.Start serverUrl" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(101)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serverUrl" Type="System.String" />
</Parameters>
<Docs>
<param name="serverUrl">The URL of the broadcast server.</param>
<summary>Initiates the specified broadcast session.</summary>
<remarks>
<para>Calling the <b>Start</b> method sets up the server, authenticates the user, and uploads the presentation.</para>
<para>If the value passed for <paramref name="serverUrl" /> has invalid formatting, <b>Start</b> returns an “Invalid Parameter” error. Additionally, the method returns an error if the document is DRM protected, is already being broadcast, or has conflicting edits (is in merge mode).</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Microsoft.Office.Core.MsoBroadcastState State { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Office.Core.MsoBroadcastState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.Broadcast.State" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property State As MsoBroadcastState" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Core::MsoBroadcastState State { Microsoft::Office::Core::MsoBroadcastState get(); };" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Office.Core.MsoBroadcastState" Usage="Microsoft.Office.Interop.Word.Broadcast.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(2)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(2)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Core.MsoBroadcastState</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <b>MSOBroadcastState</b> constant that describes the current broadcast state. Read-only.</summary>
<value>To be added.</value>
<remarks>
<para>The <b>State</b> property can return one of the following three states:</para>
<list type="bullet">
<item>
<para>No broadcast (0)</para>
</item>
<item>
<para>Broadcast started (1)</para>
</item>
<item>
<para>Broadcast paused (2)</para>
</item>
</list>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>