You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: xml/Microsoft.Build.Execution/BuildRequestDataFlags.xml
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,17 @@
19
19
</Attributes>
20
20
<Docs>
21
21
<summary>Flags providing additional control over the build request.</summary>
22
-
<remarks>To be added.</remarks>
22
+
<remarks>
23
+
<formattype="text/markdown"><![CDATA[
24
+
25
+
## Remarks
26
+
27
+
The `IgnoreExistingProjectState` flag is provided only for those cases where the client knows that the new build request does not depend on the project state generated by a previous request. Setting this flag can provide a performance boost in the case of incompatible node affinities, because MSBuild would otherwise have to serialize the project state from one node to another. Serializing the project state can be expensive, depending on the amount of data the project has previously generated.
28
+
29
+
The `IgnoreExistingProjectState` flag has no effect on target results, so if a previous request has built a target, the new request will not rebuild the target. Additionally, none of the project state mutations which occurred as a consequence of previously building that target will be reapplied.
30
+
31
+
]]></format>
32
+
</remarks>
23
33
</Docs>
24
34
<Members>
25
35
<MemberMemberName="IgnoreExistingProjectState">
@@ -39,17 +49,7 @@
39
49
</ReturnValue>
40
50
<MemberValue>4</MemberValue>
41
51
<Docs>
42
-
<summary>When this flag is present and the project has previously been built on a node whose affinity is incompatible with the affinity this request requires, this build request ignores the project state (but not the target results) that was previously generated.</summary>
43
-
<remarks>
44
-
<formattype="text/markdown"><![CDATA[
45
-
46
-
## Remarks
47
-
This behavior, when this flag is present, is not usually desired. This flag is provided only for those cases where the client knows that the new build request does not depend on the project state generated by a previous request. Setting this flag can provide a performance boost in the case of incompatible node affinities, because MSBuild would otherwise have to serialize the project state from one node to another, Serializing the project state can be expensive, depending on the amount of data the project has previously generated.
48
-
49
-
This flag has no effect on target results, so if a previous request has built a target, the new request will not re-build the target. Additionally, none of the project state mutations which occurred as a consequence of previously building that target will be re-applied.
50
-
51
-
]]></format>
52
-
</remarks>
52
+
<summary>When this flag is present and the project has previously been built on a node whose affinity is incompatible with the affinity this request requires, this build request ignores the project state (but not the target results) that was previously generated. This behavior is not usually desired; see the [Remarks](#remarks) section for more information.</summary>
Copy file name to clipboardExpand all lines: xml/Microsoft.SqlServer.Server/Format.xml
+36-42Lines changed: 36 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -26,15 +26,43 @@
26
26
<formattype="text/markdown"><![CDATA[
27
27
28
28
## Remarks
29
-
Used by <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute> and <xref:Microsoft.SqlServer.Server.SqlUserDefinedAggregateAttribute> to indicate the serialization format of a user-defined type (UDT) or aggregate.
29
+
30
+
This enumeration is used by <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute> and <xref:Microsoft.SqlServer.Server.SqlUserDefinedAggregateAttribute> to indicate the serialization format of a user-defined type (UDT) or aggregate. Use of the `Native` and `UserDefined` enumeration members has special requirements.
31
+
32
+
- `Format.Native`
33
+
34
+
The requirements for the `Format.Native` format are:
30
35
31
-
36
+
- The <xref:System.Runtime.InteropServices.StructLayoutAttribute> with a <xref:System.Runtime.InteropServices.StructLayoutAttribute.Value> property value of <xref:System.Runtime.InteropServices.LayoutKind.Sequential?displayProperty=nameWithType> must be applied to the aggregate or UDT if it is defined in a class and not a structure. This controls the physical layout of the data fields and is used to force the members to be laid out sequentially in the order they appear. SQL Server uses this attribute to determine the field order for UDTs with multiple fields.
32
37
38
+
- The type must contain at least one member (serialized values cannot be zero bytes in size).
39
+
40
+
- All the fields of the aggregate must be *blittable*; that is, they must have a common representation in both managed and unmanaged memory and not require special handling by the interop marshaler.
41
+
42
+
- All the fields of the UDT should be of one of the following types that can be serialized: `bool`, `byte`, `sbyte`, `short`, `ushort`, `int`, `uint`, `long`, `ulong`, `float`, `double`, <xref:System.Data.SqlTypes.SqlByte>, <xref:System.Data.SqlTypes.SqlInt16>, <xref:System.Data.SqlTypes.SqlInt32>, <xref:System.Data.SqlTypes.SqlInt64>, <xref:System.Data.SqlTypes.SqlDateTime>, <xref:System.Data.SqlTypes.SqlSingle>, <xref:System.Data.SqlTypes.SqlDouble>, <xref:System.Data.SqlTypes.SqlMoney>, or other value types defined by the user that contain fields of one of these types.
43
+
44
+
- The aggregate must not specify a value for `MaxByteSize`.
45
+
46
+
- The aggregate must not have any [NonSerialized] fields.
47
+
48
+
- Fields must not be marked as an explicit layout (with a <xref:System.Runtime.InteropServices.StructLayoutAttribute.Value?displayProperty=nameWithType> of <xref:System.Runtime.InteropServices.LayoutKind.Explicit?displayProperty=nameWithType>).
49
+
50
+
- `Format.UserDefined`
51
+
52
+
The requirements for the `Format.UserDefined` format are:
53
+
54
+
- The aggregate must specify a value for `MaxByteSize`.
55
+
56
+
- Specify the <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute.IsByteOrdered%2A?displayProperty=nameWithType> attribute property. The default value is `false`.
57
+
58
+
- If you omit any field in the <xref:Microsoft.SqlServer.Server.IBinarySerialize.Read%2A?displayProperty=nameWithType> or <xref:Microsoft.SqlServer.Server.IBinarySerialize.Write%2A?displayProperty=nameWithType> methods, the state of that field is not serialized.
59
+
33
60
## Examples
34
-
The following example shows the `UserDefinedType` attribute of the Point UDT. The UDT is byte-ordered, is named "Point", has a validation method named "ValidatePoint", and uses the native serialization format.
61
+
62
+
The following example shows the `UserDefinedType` attribute of the Point UDT. The UDT is byte-ordered, is named "Point", has a validation method named "ValidatePoint", and uses the native serialization format.
<summary>The <seelangword="Native" /> serialization format uses a very simple algorithm that enables SQL Server to store an efficient representation of the UDT on disk. Types marked for <seelangword="Native" /> serialization can only have value types (structs in Microsoft Visual C# and structures in Microsoft Visual Basic .NET) as members. Members of reference types (such as classes in Visual C# and Visual Basic), either user-defined or those existing in the framework (such as <seecref="T:System.String" />), are not supported.</summary>
69
-
<remarks>
70
-
<formattype="text/markdown"><![CDATA[
71
-
72
-
## Remarks
73
-
The requirements for this format are:
74
-
75
-
- The `StructLayout.LayoutKindSequential` attribute must be applied to the aggregate or UDT if it is defined in a class and not a structure. This controls the physical layout of the data fields, and is used to force the members to be laid out sequentially in the order they appear. SQL Server uses this attribute to determine the field order for UDTs with multiple fields.
76
-
77
-
- The type must contain at least one member (serialized values cannot be zero bytes in size).
78
-
79
-
- All the fields of the aggregate must be *blittable*, that is, they must have a common representation in both managed and unmanaged memory and not require special handling by the interop marshaler.
80
-
81
-
- All the fields of the UDT should be of one of the following types that can be serialized: `bool`, `byte`, `sbyte`, `short`, `ushort`, `int`, `uint`, `long`, `ulong`, `float`, `double`, <xref:System.Data.SqlTypes.SqlByte>, <xref:System.Data.SqlTypes.SqlInt16>, <xref:System.Data.SqlTypes.SqlInt32>, <xref:System.Data.SqlTypes.SqlInt64>, <xref:System.Data.SqlTypes.SqlDateTime>, <xref:System.Data.SqlTypes.SqlSingle>, <xref:System.Data.SqlTypes.SqlDouble>, <xref:System.Data.SqlTypes.SqlMoney>, or other value types defined by the user that contain fields of one of these types.
82
-
83
-
- The aggregate must not specify a value for `MaxByteSize`.
84
-
85
-
- The aggregate must not have any [NonSerialized] fields.
86
-
87
-
- Fields must not be marked as an explicit layout (<xref:System.Runtime.InteropServices.StructLayoutAttribute>).
88
-
89
-
]]></format>
90
-
</remarks>
96
+
<summary>This serialization format uses a very simple algorithm that enables SQL Server to store an efficient representation of the UDT on disk. Types marked for <seelangword="Native" /> serialization can only have value types (structs in Microsoft Visual C# and structures in Microsoft Visual Basic .NET) as members. Members of reference types (such as classes in Visual C# and Visual Basic), either user-defined or those existing in .NET class libraries (such as <seecref="T:System.String" />), are not supported.</summary>
91
97
</Docs>
92
98
</Member>
93
99
<MemberMemberName="Unknown">
@@ -143,20 +149,8 @@
143
149
</ReturnValue>
144
150
<MemberValue>2</MemberValue>
145
151
<Docs>
146
-
<summary>The <seelangword="UserDefined" /> serialization format gives the developer full control over the binary format through the <seecref="T:Microsoft.SqlServer.Server.IBinarySerialize" /><seelangword=".Write" /> and <seecref="T:Microsoft.SqlServer.Server.IBinarySerialize" /><seelangword=".Read" /> methods.</summary>
147
-
<remarks>
148
-
<formattype="text/markdown"><![CDATA[
149
-
150
-
## Remarks
151
-
The aggregate must specify a value for `MaxByteSize`.
152
-
153
-
Specify the <xref:Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute.IsByteOrdered%2A> attribute property. The default value is false.
154
-
155
-
If you omit any field in the <xref:Microsoft.SqlServer.Server.IBinarySerialize.Read%2A> or <xref:Microsoft.SqlServer.Server.IBinarySerialize.Write%2A> methods, the state of that field is not serialized.
156
-
157
-
]]></format>
158
-
</remarks>
152
+
<summary>This serialization format gives the developer full control over the binary format through the <seecref="M:Microsoft.SqlServer.Server.IBinarySerialize.Write(System.IO.BinaryWriter)" /> and <seecref="M:Microsoft.SqlServer.Server.IBinarySerialize.Read(System.IO.BinaryReader)" /> methods.</summary>
Copy file name to clipboardExpand all lines: xml/System.Activities.Hosting/WorkflowInstanceState.xml
+4-36Lines changed: 4 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -34,15 +34,7 @@
34
34
</ReturnValue>
35
35
<MemberValue>3</MemberValue>
36
36
<Docs>
37
-
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> is aborted.</summary>
38
-
<remarks>
39
-
<formattype="text/markdown"><![CDATA[
40
-
41
-
## Remarks
42
-
The workflow instance will be in this state after <xref:System.Activities.WorkflowApplication.Abort%2A> has been called. A workflow in this state is capable of being resumed using <xref:System.Activities.WorkflowApplication.Run%2A>.
43
-
44
-
]]></format>
45
-
</remarks>
37
+
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> is aborted. The workflow instance will be in this state after <seecref="Overload:System.Activities.WorkflowApplication.Abort" /> has been called. A workflow in this state is capable of being resumed using <seecref="Overload:System.Activities.WorkflowApplication.Run" />.</summary>
46
38
</Docs>
47
39
</Member>
48
40
<MemberMemberName="Complete">
@@ -62,15 +54,7 @@
62
54
</ReturnValue>
63
55
<MemberValue>2</MemberValue>
64
56
<Docs>
65
-
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> is complete.</summary>
66
-
<remarks>
67
-
<formattype="text/markdown"><![CDATA[
68
-
69
-
## Remarks
70
-
A workflow in this state has exited, and its <xref:System.Activities.WorkflowApplication.Completed%2A> or <xref:System.Activities.WorkflowInvoker.InvokeCompleted> event has executed.
71
-
72
-
]]></format>
73
-
</remarks>
57
+
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> is complete. A workflow in this state has exited, and its <seecref="P:System.Activities.WorkflowApplication.Completed" /> delegate or <seecref="E:System.Activities.WorkflowInvoker.InvokeCompleted" /> event has executed.</summary>
74
58
</Docs>
75
59
</Member>
76
60
<MemberMemberName="Idle">
@@ -90,15 +74,7 @@
90
74
</ReturnValue>
91
75
<MemberValue>0</MemberValue>
92
76
<Docs>
93
-
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> is idle.</summary>
94
-
<remarks>
95
-
<formattype="text/markdown"><![CDATA[
96
-
97
-
## Remarks
98
-
A workflow in this state is waiting on an incoming event, such as when executing a <xref:System.Activities.Statements.Pick> activity, or is waiting for the expiration of a timeout, such as when executing a <xref:System.Activities.Statements.Delay> activity.
99
-
100
-
]]></format>
101
-
</remarks>
77
+
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> is idle. A workflow in this state is waiting on an incoming event, such as when executing a <seecref="T:System.Activities.Statements.Pick" /> activity, or is waiting for the expiration of a timeout, such as when executing a <seecref="T:System.Activities.Statements.Delay" /> activity.</summary>
102
78
</Docs>
103
79
</Member>
104
80
<MemberMemberName="Runnable">
@@ -118,15 +94,7 @@
118
94
</ReturnValue>
119
95
<MemberValue>1</MemberValue>
120
96
<Docs>
121
-
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> can be run.</summary>
122
-
<remarks>
123
-
<formattype="text/markdown"><![CDATA[
124
-
125
-
## Remarks
126
-
A workflow in this state has been created, but <xref:System.Activities.WorkflowApplication.Run%2A> has not been called.
127
-
128
-
]]></format>
129
-
</remarks>
97
+
<summary>The <seecref="T:System.Activities.Hosting.WorkflowInstance" /> can be run. A workflow in this state has been created but <seecref="Overload:System.Activities.WorkflowApplication.Run" /> has not been called.</summary>
Copy file name to clipboardExpand all lines: xml/System.Activities/ActivityInstanceState.xml
+2-18Lines changed: 2 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -44,15 +44,7 @@
44
44
</ReturnValue>
45
45
<MemberValue>2</MemberValue>
46
46
<Docs>
47
-
<summary>Specifies that the activity is in a canceled state.</summary>
48
-
<remarks>
49
-
<formattype="text/markdown"><![CDATA[
50
-
51
-
## Remarks
52
-
Canceled is a terminal state for an activity instance. A Canceled activity completed without performing the function it was designed to perform.
53
-
54
-
]]></format>
55
-
</remarks>
47
+
<summary><para>Specifies that the activity is in a canceled state.</para><para>Canceled is a terminal state for an activity instance. A Canceled activity completes without performing the function it was designed to perform.</para></summary>
56
48
</Docs>
57
49
</Member>
58
50
<MemberMemberName="Closed">
@@ -77,15 +69,7 @@
77
69
</ReturnValue>
78
70
<MemberValue>1</MemberValue>
79
71
<Docs>
80
-
<summary>Specifies that the activity is in a closed state.</summary>
81
-
<remarks>
82
-
<formattype="text/markdown"><![CDATA[
83
-
84
-
## Remarks
85
-
Closed is a terminal state for an activity instance. A Closed activity completed successfully and performed the function it was designed to perform.
86
-
87
-
]]></format>
88
-
</remarks>
72
+
<summary><para>Specifies that the activity is in a closed state.</para><para>Closed is a terminal state for an activity instance. A Closed activity completed successfully and performed the function it was designed to perform.</para></summary>
0 commit comments