diff --git a/xml/System.Diagnostics.Metrics/Meter.xml b/xml/System.Diagnostics.Metrics/Meter.xml index 76a955280bf..557f684efd6 100644 --- a/xml/System.Diagnostics.Metrics/Meter.xml +++ b/xml/System.Diagnostics.Metrics/Meter.xml @@ -765,6 +765,9 @@ Example uses for Histogram: The request duration and the size of the response pa ## Remarks +> [!NOTE] +> Unlike `Counter`, which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + Example uses for ObservableCounter: The number of page faults for each process. ]]> @@ -836,6 +839,9 @@ Example uses for ObservableCounter: The number of page faults for each process. ## Remarks +> [!NOTE] +> Unlike Counter which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + Example uses for ObservableCounter: The number of page faults for each process. ]]> @@ -907,6 +913,9 @@ Example uses for ObservableCounter: The number of page faults for each process. ## Remarks +> [!NOTE] +> Unlike Counter which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + Example uses for ObservableCounter: The number of page faults for each process. ]]> @@ -992,7 +1001,18 @@ Example uses for ObservableCounter: The number of page faults for each process. The tags to attach to the counter. Creates an ObservableCounter instance, which is an Instrument that reports monotonically increasing value(s) when the instrument is being observed. A new observable counter. - Example uses for ObservableCounter: The number of page faults for each process. + + [!NOTE] +> Unlike `Counter`, which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + +Example uses for `ObservableCounter`: The number of page faults for each process. + + ]]> + @@ -1074,7 +1094,17 @@ Example uses for ObservableCounter: The number of page faults for each process. The tags to attach to the counter. Creates an ObservableCounter instance, which is an Instrument that reports monotonically increasing value(s) when the instrument is being observed. A new observable counter. - Example uses for ObservableCounter: The number of page faults for each process. + + [!NOTE] +> Unlike Counter which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + +Example uses for ObservableCounter: The number of page faults for each process. + + ]]> + @@ -1156,7 +1186,18 @@ Example uses for ObservableCounter: The number of page faults for each process. The tags to attach to the counter. Creates an ObservableCounter instance, which is an Instrument that reports monotonically increasing value(s) when the instrument is being observed. A new observable counter. - Example uses for ObservableCounter: The number of page faults for each process. + + [!NOTE] +> Unlike Counter which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + +Example uses for ObservableCounter: The number of page faults for each process. + + ]]> + @@ -1658,6 +1699,9 @@ Example uses for ObservableCounter: The number of page faults for each process. ## Remarks +> [!NOTE] +> Unlike UpDownCounter which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate the ObservableUpDownCounter is changing, the difference between successive measurements is used. + Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. ]]> @@ -1728,6 +1772,9 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima ## Remarks +> [!NOTE] +> Unlike UpDownCounter which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate the ObservableUpDownCounter is changing, the difference between successive measurements is used. + Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. ]]> @@ -1798,6 +1845,9 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima ## Remarks +> [!NOTE] +> Unlike UpDownCounter which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate the ObservableUpDownCounter is changing, the difference between successive measurements is used. + Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. ]]> @@ -1883,7 +1933,19 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima tags to attach to the counter. Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed. A new observable up down counter. - Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. + + [!NOTE] +> Unlike `UpDownCounter`, which takes the increment/delta value, the callback function reports the absolute value of the `ObservableUpDownCounter`. To determine the reported rate the `ObservableUpDownCounter` is changing, the difference between successive measurements is used. + +Example uses for `ObservableUpDownCounter`: the process heap size or the approximate number of items in a lock-free circular buffer. + + ]]> + + @@ -1965,7 +2027,19 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima tags to attach to the counter. Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed. A new observable up down counter. - Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. + + [!NOTE] +> Unlike UpDownCounter which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate the ObservableUpDownCounter is changing, the difference between successive measurements is used. + +Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. + + ]]> + + @@ -2047,7 +2121,18 @@ Example uses for ObservableUpDownCounter: the process heap size or the approxima tags to attach to the counter. Create an ObservableUpDownCounter object. ObservableUpDownCounter is an Instrument which reports increasing or decreasing value(s) when the instrument is being observed. A new observable up down counter. - Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. + + [!NOTE] +> Unlike UpDownCounter which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate the ObservableUpDownCounter is changing, the difference between successive measurements is used. + +Example uses for ObservableUpDownCounter: the process heap size or the approximate number of items in a lock-free circular buffer. + + ]]> + diff --git a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml index 392a7608d6a..9ce29f28366 100644 --- a/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableCounter`1.xml @@ -36,6 +36,9 @@ ## Remarks +> [!NOTE] +> Unlike `Counter`, which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + This class supports only the following generic parameter types: , , , , , , and . ]]> @@ -65,7 +68,16 @@ This class supports only the following generic parameter types: Fetches the current measurements being tracked by this observable counter. The current measurements being tracked by this observable counter. - To be added. + + [!NOTE] +> Unlike Counter which takes the increment/delta value, the callback function reports the absolute value of the counter. To determine the reported rate the counter is changing, the difference between successive measurements is used. + + ]]> + diff --git a/xml/System.Diagnostics.Metrics/ObservableUpDownCounter`1.xml b/xml/System.Diagnostics.Metrics/ObservableUpDownCounter`1.xml index d221143d4ed..fba54f5a1fc 100644 --- a/xml/System.Diagnostics.Metrics/ObservableUpDownCounter`1.xml +++ b/xml/System.Diagnostics.Metrics/ObservableUpDownCounter`1.xml @@ -37,6 +37,9 @@ To create an ObservableUpDownCounter object, use the [!NOTE] +> Unlike UpDownCounter which takes the increment/delta value, the callback function reports the absolute value of the ObservableUpDownCounter. To determine the reported rate the ObservableUpDownCounter is changing, the difference between successive measurements is used. + + ]]> + + diff --git a/xml/System.Globalization/CultureInfo.xml b/xml/System.Globalization/CultureInfo.xml index eb6b4b35083..08bace12f6c 100644 --- a/xml/System.Globalization/CultureInfo.xml +++ b/xml/System.Globalization/CultureInfo.xml @@ -173,6 +173,9 @@ Predefined culture identifiers for cultures available on Windows system are list > [!NOTE] > For backwards compatibility, a culture constructed using a `culture` parameter of 0x0004 or 0x7c04 will have a property of `zh-CHS` or `zh-CHT`, respectively. You should instead prefer to construct the culture using the current standard culture names of `zh-Hans` or `zh-Hant`, unless you have a reason for using the older names. +> [!NOTE] +> LCIDs are being deprecated, and implementers are strongly encouraged to use newer versions of APIs that support BCP 47 locale names instead. Each LCID can be represented by a BCP 47 locale name, but the reverse is not true. The LCID range is restricted and unable to uniquely identify all the possible combinations of language and region. + ]]> @@ -361,6 +364,9 @@ Predefined culture identifiers available on Windows systems are listed in the ** > [!NOTE] > For backwards compatibility, a culture constructed using a `culture` parameter of 0x0004 or 0x7c04 will have a property of zh-CHS or zh-CHT, respectively. You should instead prefer to construct the culture using the current standard culture names of `zh-Hans` or zh-Hant, unless you have a reason for using the older names. +> [!NOTE] +> LCIDs are being deprecated, and implementers are strongly encouraged to use newer versions of APIs that support BCP 47 locale names instead. Each LCID can be represented by a BCP 47 locale name, but the reverse is not true. The LCID range is restricted and unable to uniquely identify all the possible combinations of language and region. + ]]> @@ -1775,6 +1781,9 @@ csc /resource:GreetingStrings.resources Example1.cs If `culture` is the locale identifier of the current culture, the returned object does not reflect any user overrides. +> [!NOTE] +> LCIDs are being deprecated, and implementers are strongly encouraged to use newer versions of APIs that support BCP 47 locale names instead. Each LCID can be represented by a BCP 47 locale name, but the reverse is not true. The LCID range is restricted and unable to uniquely identify all the possible combinations of language and region. + ]]> @@ -2690,7 +2699,8 @@ Setting `predefinedOnly` to `true` will ensure a culture is created only if the In versions of Windows prior to Windows 10, the locale identifier `LOCALE_CUSTOM_UNSPECIFIED` (0x1000, or 4096) is assigned to custom cultures created by the user. Starting with Windows 10, it is assigned to any culture that does not have a unique locale identifier and does not have complete system-provided data. As a result, code that iterates cultures and retrieves those with an value of `LOCALE_CUSTOM_UNSPECIFIED` returns a larger subset of objects if run under Windows 10. - +> [!NOTE] +> LCIDs are being deprecated, and implementers are strongly encouraged to use newer versions of APIs that support BCP 47 locale names instead. Each LCID can be represented by a BCP 47 locale name, but the reverse is not true. The LCID range is restricted and unable to uniquely identify all the possible combinations of language and region. ## Examples The following code example shows how to create a for Spanish (Spain) with the international sort order and another with the traditional sort order.