You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

1260 lines
129 KiB

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Diagnostics.PerformanceCounter</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Diagnostics.CounterCreationData">
  8. <summary>Defines the counter type, name, and Help string for a custom counter.</summary>
  9. </member>
  10. <member name="M:System.Diagnostics.CounterCreationData.#ctor">
  11. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterCreationData" /> class, to a counter of type <see langword="NumberOfItems32" />, and with empty name and help strings.</summary>
  12. </member>
  13. <member name="M:System.Diagnostics.CounterCreationData.#ctor(System.String,System.String,System.Diagnostics.PerformanceCounterType)">
  14. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterCreationData" /> class, to a counter of the specified type, using the specified counter name and Help strings.</summary>
  15. <param name="counterName">The name of the counter, which must be unique within its category.</param>
  16. <param name="counterHelp">The text that describes the counter's behavior.</param>
  17. <param name="counterType">A <see cref="T:System.Diagnostics.PerformanceCounterType" /> that identifies the counter's behavior.</param>
  18. <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">You have specified a value for <paramref name="counterType" /> that is not a member of the <see cref="T:System.Diagnostics.PerformanceCounterType" /> enumeration.</exception>
  19. <exception cref="T:System.ArgumentNullException">
  20. <paramref name="counterHelp" /> is <see langword="null" />.</exception>
  21. </member>
  22. <member name="P:System.Diagnostics.CounterCreationData.CounterHelp">
  23. <summary>Gets or sets the custom counter's description.</summary>
  24. <returns>The text that describes the counter's behavior.</returns>
  25. <exception cref="T:System.ArgumentNullException">The specified value is <see langword="null" />.</exception>
  26. </member>
  27. <member name="P:System.Diagnostics.CounterCreationData.CounterName">
  28. <summary>Gets or sets the name of the custom counter.</summary>
  29. <returns>A name for the counter, which is unique in its category.</returns>
  30. <exception cref="T:System.ArgumentNullException">The specified value is <see langword="null" />.</exception>
  31. <exception cref="T:System.ArgumentException">The specified value is not between 1 and 80 characters long or contains double quotes, control characters or leading or trailing spaces.</exception>
  32. </member>
  33. <member name="P:System.Diagnostics.CounterCreationData.CounterType">
  34. <summary>Gets or sets the performance counter type of the custom counter.</summary>
  35. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterType" /> that defines the behavior of the performance counter.</returns>
  36. <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">You have specified a type that is not a member of the <see cref="T:System.Diagnostics.PerformanceCounterType" /> enumeration.</exception>
  37. </member>
  38. <member name="T:System.Diagnostics.CounterCreationDataCollection">
  39. <summary>Provides a strongly typed collection of <see cref="T:System.Diagnostics.CounterCreationData" /> objects.</summary>
  40. </member>
  41. <member name="M:System.Diagnostics.CounterCreationDataCollection.#ctor">
  42. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> class, with no associated <see cref="T:System.Diagnostics.CounterCreationData" /> instances.</summary>
  43. </member>
  44. <member name="M:System.Diagnostics.CounterCreationDataCollection.#ctor(System.Diagnostics.CounterCreationData[])">
  45. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> class by using the specified array of <see cref="T:System.Diagnostics.CounterCreationData" /> instances.</summary>
  46. <param name="value">An array of <see cref="T:System.Diagnostics.CounterCreationData" /> instances with which to initialize this <see cref="T:System.Diagnostics.CounterCreationDataCollection" />.</param>
  47. <exception cref="T:System.ArgumentNullException">
  48. <paramref name="value" /> is <see langword="null" />.</exception>
  49. </member>
  50. <member name="M:System.Diagnostics.CounterCreationDataCollection.#ctor(System.Diagnostics.CounterCreationDataCollection)">
  51. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> class by using the specified collection of <see cref="T:System.Diagnostics.CounterCreationData" /> instances.</summary>
  52. <param name="value">A <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> that holds <see cref="T:System.Diagnostics.CounterCreationData" /> instances with which to initialize this <see cref="T:System.Diagnostics.CounterCreationDataCollection" />.</param>
  53. <exception cref="T:System.ArgumentNullException">
  54. <paramref name="value" /> is <see langword="null" />.</exception>
  55. </member>
  56. <member name="M:System.Diagnostics.CounterCreationDataCollection.Add(System.Diagnostics.CounterCreationData)">
  57. <summary>Adds an instance of the <see cref="T:System.Diagnostics.CounterCreationData" /> class to the collection.</summary>
  58. <param name="value">A <see cref="T:System.Diagnostics.CounterCreationData" /> object to append to the existing collection.</param>
  59. <returns>The index of the new <see cref="T:System.Diagnostics.CounterCreationData" /> object.</returns>
  60. <exception cref="T:System.ArgumentNullException">
  61. <paramref name="value" /> is <see langword="null" />.</exception>
  62. <exception cref="T:System.ArgumentException">
  63. <paramref name="value" /> is not a <see cref="T:System.Diagnostics.CounterCreationData" /> object.</exception>
  64. </member>
  65. <member name="M:System.Diagnostics.CounterCreationDataCollection.AddRange(System.Diagnostics.CounterCreationData[])">
  66. <summary>Adds the specified array of <see cref="T:System.Diagnostics.CounterCreationData" /> instances to the collection.</summary>
  67. <param name="value">An array of <see cref="T:System.Diagnostics.CounterCreationData" /> instances to append to the existing collection.</param>
  68. <exception cref="T:System.ArgumentNullException">
  69. <paramref name="value" /> is <see langword="null" />.</exception>
  70. </member>
  71. <member name="M:System.Diagnostics.CounterCreationDataCollection.AddRange(System.Diagnostics.CounterCreationDataCollection)">
  72. <summary>Adds the specified collection of <see cref="T:System.Diagnostics.CounterCreationData" /> instances to the collection.</summary>
  73. <param name="value">A collection of <see cref="T:System.Diagnostics.CounterCreationData" /> instances to append to the existing collection.</param>
  74. <exception cref="T:System.ArgumentNullException">
  75. <paramref name="value" /> is <see langword="null" />.</exception>
  76. </member>
  77. <member name="M:System.Diagnostics.CounterCreationDataCollection.Contains(System.Diagnostics.CounterCreationData)">
  78. <summary>Determines whether a <see cref="T:System.Diagnostics.CounterCreationData" /> instance exists in the collection.</summary>
  79. <param name="value">The <see cref="T:System.Diagnostics.CounterCreationData" /> object to find in the collection.</param>
  80. <returns>
  81. <see langword="true" /> if the specified <see cref="T:System.Diagnostics.CounterCreationData" /> object exists in the collection; otherwise, <see langword="false" />.</returns>
  82. </member>
  83. <member name="M:System.Diagnostics.CounterCreationDataCollection.CopyTo(System.Diagnostics.CounterCreationData[],System.Int32)">
  84. <summary>Copies the elements of the <see cref="T:System.Diagnostics.CounterCreationData" /> to an array, starting at the specified index of the array.</summary>
  85. <param name="array">An array of <see cref="T:System.Diagnostics.CounterCreationData" /> instances to add to the collection.</param>
  86. <param name="index">The location at which to add the new instances.</param>
  87. <exception cref="T:System.ArgumentNullException">
  88. <paramref name="array" /> is <see langword="null" />.</exception>
  89. <exception cref="T:System.ArgumentOutOfRangeException">
  90. <paramref name="index" /> is less than 0.</exception>
  91. <exception cref="T:System.ArgumentException">The number of elements in the <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination array.</exception>
  92. </member>
  93. <member name="M:System.Diagnostics.CounterCreationDataCollection.IndexOf(System.Diagnostics.CounterCreationData)">
  94. <summary>Returns the index of a <see cref="T:System.Diagnostics.CounterCreationData" /> object in the collection.</summary>
  95. <param name="value">The <see cref="T:System.Diagnostics.CounterCreationData" /> object to locate in the collection.</param>
  96. <returns>The zero-based index of the specified <see cref="T:System.Diagnostics.CounterCreationData" />, if it is found, in the collection; otherwise, -1.</returns>
  97. </member>
  98. <member name="M:System.Diagnostics.CounterCreationDataCollection.Insert(System.Int32,System.Diagnostics.CounterCreationData)">
  99. <summary>Inserts a <see cref="T:System.Diagnostics.CounterCreationData" /> object into the collection, at the specified index.</summary>
  100. <param name="index">The zero-based index of the location at which the <see cref="T:System.Diagnostics.CounterCreationData" /> is to be inserted.</param>
  101. <param name="value">The <see cref="T:System.Diagnostics.CounterCreationData" /> to insert into the collection.</param>
  102. <exception cref="T:System.ArgumentNullException">
  103. <paramref name="value" /> is <see langword="null" />.</exception>
  104. <exception cref="T:System.ArgumentException">
  105. <paramref name="value" /> is not a <see cref="T:System.Diagnostics.CounterCreationData" /> object.</exception>
  106. <exception cref="T:System.ArgumentOutOfRangeException">
  107. <paramref name="index" /> is less than 0.
  108. -or-
  109. <paramref name="index" /> is greater than the number of items in the collection.</exception>
  110. </member>
  111. <member name="P:System.Diagnostics.CounterCreationDataCollection.Item(System.Int32)">
  112. <summary>Indexes the <see cref="T:System.Diagnostics.CounterCreationData" /> collection.</summary>
  113. <param name="index">An index into the <see cref="T:System.Diagnostics.CounterCreationDataCollection" />.</param>
  114. <returns>The collection index, which is used to access individual elements of the collection.</returns>
  115. <exception cref="T:System.ArgumentOutOfRangeException">
  116. <paramref name="index" /> is less than 0.
  117. -or-
  118. <paramref name="index" /> is equal to or greater than the number of items in the collection.</exception>
  119. </member>
  120. <member name="M:System.Diagnostics.CounterCreationDataCollection.OnValidate(System.Object)">
  121. <summary>Checks the specified object to determine whether it is a valid <see cref="T:System.Diagnostics.CounterCreationData" /> type.</summary>
  122. <param name="value">The object that will be validated.</param>
  123. <exception cref="T:System.ArgumentNullException">
  124. <paramref name="value" /> is <see langword="null" />.</exception>
  125. <exception cref="T:System.ArgumentException">
  126. <paramref name="value" /> is not a <see cref="T:System.Diagnostics.CounterCreationData" /> object.</exception>
  127. </member>
  128. <member name="M:System.Diagnostics.CounterCreationDataCollection.Remove(System.Diagnostics.CounterCreationData)">
  129. <summary>Removes a <see cref="T:System.Diagnostics.CounterCreationData" /> object from the collection.</summary>
  130. <param name="value">The <see cref="T:System.Diagnostics.CounterCreationData" /> to remove from the collection.</param>
  131. <exception cref="T:System.ArgumentNullException">
  132. <paramref name="value" /> is <see langword="null" />.</exception>
  133. <exception cref="T:System.ArgumentException">
  134. <paramref name="value" /> is not a <see cref="T:System.Diagnostics.CounterCreationData" /> object.
  135. -or-
  136. <paramref name="value" /> does not exist in the collection.</exception>
  137. </member>
  138. <member name="T:System.Diagnostics.CounterSample">
  139. <summary>Defines a structure that holds the raw data for a performance counter.</summary>
  140. </member>
  141. <member name="M:System.Diagnostics.CounterSample.#ctor(System.Int64,System.Int64,System.Int64,System.Int64,System.Int64,System.Int64,System.Diagnostics.PerformanceCounterType)">
  142. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterSample" /> structure and sets the <see cref="P:System.Diagnostics.CounterSample.CounterTimeStamp" /> property to 0 (zero).</summary>
  143. <param name="rawValue">The numeric value associated with the performance counter sample.</param>
  144. <param name="baseValue">An optional, base raw value for the counter, to use only if the sample is based on multiple counters.</param>
  145. <param name="counterFrequency">The frequency with which the counter is read.</param>
  146. <param name="systemFrequency">The frequency with which the system reads from the counter.</param>
  147. <param name="timeStamp">The raw time stamp.</param>
  148. <param name="timeStamp100nSec">The raw, high-fidelity time stamp.</param>
  149. <param name="counterType">A <see cref="T:System.Diagnostics.PerformanceCounterType" /> object that indicates the type of the counter for which this sample is a snapshot.</param>
  150. </member>
  151. <member name="M:System.Diagnostics.CounterSample.#ctor(System.Int64,System.Int64,System.Int64,System.Int64,System.Int64,System.Int64,System.Diagnostics.PerformanceCounterType,System.Int64)">
  152. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CounterSample" /> structure and sets the <see cref="P:System.Diagnostics.CounterSample.CounterTimeStamp" /> property to the value that is passed in.</summary>
  153. <param name="rawValue">The numeric value associated with the performance counter sample.</param>
  154. <param name="baseValue">An optional, base raw value for the counter, to use only if the sample is based on multiple counters.</param>
  155. <param name="counterFrequency">The frequency with which the counter is read.</param>
  156. <param name="systemFrequency">The frequency with which the system reads from the counter.</param>
  157. <param name="timeStamp">The raw time stamp.</param>
  158. <param name="timeStamp100nSec">The raw, high-fidelity time stamp.</param>
  159. <param name="counterType">A <see cref="T:System.Diagnostics.PerformanceCounterType" /> object that indicates the type of the counter for which this sample is a snapshot.</param>
  160. <param name="counterTimeStamp">The time at which the sample was taken.</param>
  161. </member>
  162. <member name="P:System.Diagnostics.CounterSample.BaseValue">
  163. <summary>Gets an optional, base raw value for the counter.</summary>
  164. <returns>The base raw value, which is used only if the sample is based on multiple counters.</returns>
  165. </member>
  166. <member name="M:System.Diagnostics.CounterSample.Calculate(System.Diagnostics.CounterSample)">
  167. <summary>Calculates the performance data of the counter, using a single sample point. This method is generally used for uncalculated performance counter types.</summary>
  168. <param name="counterSample">The <see cref="T:System.Diagnostics.CounterSample" /> structure to use as a base point for calculating performance data.</param>
  169. <returns>The calculated performance value.</returns>
  170. </member>
  171. <member name="M:System.Diagnostics.CounterSample.Calculate(System.Diagnostics.CounterSample,System.Diagnostics.CounterSample)">
  172. <summary>Calculates the performance data of the counter, using two sample points. This method is generally used for calculated performance counter types, such as averages.</summary>
  173. <param name="counterSample">The <see cref="T:System.Diagnostics.CounterSample" /> structure to use as a base point for calculating performance data.</param>
  174. <param name="nextCounterSample">The <see cref="T:System.Diagnostics.CounterSample" /> structure to use as an ending point for calculating performance data.</param>
  175. <returns>The calculated performance value.</returns>
  176. </member>
  177. <member name="P:System.Diagnostics.CounterSample.CounterFrequency">
  178. <summary>Gets the raw counter frequency.</summary>
  179. <returns>The frequency with which the counter is read.</returns>
  180. </member>
  181. <member name="P:System.Diagnostics.CounterSample.CounterTimeStamp">
  182. <summary>Gets the counter's time stamp.</summary>
  183. <returns>The time at which the sample was taken.</returns>
  184. </member>
  185. <member name="P:System.Diagnostics.CounterSample.CounterType">
  186. <summary>Gets the performance counter type.</summary>
  187. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterType" /> object that indicates the type of the counter for which this sample is a snapshot.</returns>
  188. </member>
  189. <member name="F:System.Diagnostics.CounterSample.Empty">
  190. <summary>Defines an empty, uninitialized performance counter sample of type <see langword="NumberOfItems32" />.</summary>
  191. </member>
  192. <member name="M:System.Diagnostics.CounterSample.Equals(System.Diagnostics.CounterSample)">
  193. <summary>Indicates whether the specified <see cref="T:System.Diagnostics.CounterSample" /> structure is equal to the current <see cref="T:System.Diagnostics.CounterSample" /> structure.</summary>
  194. <param name="sample">The <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared with this instance.</param>
  195. <returns>
  196. <see langword="true" /> if <paramref name="sample" /> is equal to the current instance; otherwise, <see langword="false" />.</returns>
  197. </member>
  198. <member name="M:System.Diagnostics.CounterSample.Equals(System.Object)">
  199. <summary>Indicates whether the specified structure is a <see cref="T:System.Diagnostics.CounterSample" /> structure and is identical to the current <see cref="T:System.Diagnostics.CounterSample" /> structure.</summary>
  200. <param name="o">The <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared with the current structure.</param>
  201. <returns>
  202. <see langword="true" /> if <paramref name="o" /> is a <see cref="T:System.Diagnostics.CounterSample" /> structure and is identical to the current instance; otherwise, <see langword="false" />.</returns>
  203. </member>
  204. <member name="M:System.Diagnostics.CounterSample.GetHashCode">
  205. <summary>Gets a hash code for the current counter sample.</summary>
  206. <returns>A hash code for the current counter sample.</returns>
  207. </member>
  208. <member name="M:System.Diagnostics.CounterSample.op_Equality(System.Diagnostics.CounterSample,System.Diagnostics.CounterSample)">
  209. <summary>Returns a value that indicates whether two <see cref="T:System.Diagnostics.CounterSample" /> structures are equal.</summary>
  210. <param name="a">A <see cref="T:System.Diagnostics.CounterSample" /> structure.</param>
  211. <param name="b">Another <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared to the structure specified by the <paramref name="a" /> parameter.</param>
  212. <returns>
  213. <see langword="true" /> if <paramref name="a" /> and <paramref name="b" /> are equal; otherwise, <see langword="false" />.</returns>
  214. </member>
  215. <member name="M:System.Diagnostics.CounterSample.op_Inequality(System.Diagnostics.CounterSample,System.Diagnostics.CounterSample)">
  216. <summary>Returns a value that indicates whether two <see cref="T:System.Diagnostics.CounterSample" /> structures are not equal.</summary>
  217. <param name="a">A <see cref="T:System.Diagnostics.CounterSample" /> structure.</param>
  218. <param name="b">Another <see cref="T:System.Diagnostics.CounterSample" /> structure to be compared to the structure specified by the <paramref name="a" /> parameter.</param>
  219. <returns>
  220. <see langword="true" /> if <paramref name="a" /> and <paramref name="b" /> are not equal; otherwise, <see langword="false" /></returns>
  221. </member>
  222. <member name="P:System.Diagnostics.CounterSample.RawValue">
  223. <summary>Gets the raw value of the counter.</summary>
  224. <returns>The numeric value that is associated with the performance counter sample.</returns>
  225. </member>
  226. <member name="P:System.Diagnostics.CounterSample.SystemFrequency">
  227. <summary>Gets the raw system frequency.</summary>
  228. <returns>The frequency with which the system reads from the counter.</returns>
  229. </member>
  230. <member name="P:System.Diagnostics.CounterSample.TimeStamp">
  231. <summary>Gets the raw time stamp.</summary>
  232. <returns>The system time stamp.</returns>
  233. </member>
  234. <member name="P:System.Diagnostics.CounterSample.TimeStamp100nSec">
  235. <summary>Gets the raw, high-fidelity time stamp.</summary>
  236. <returns>The system time stamp, represented within 0.1 millisecond.</returns>
  237. </member>
  238. <member name="T:System.Diagnostics.CounterSampleCalculator">
  239. <summary>Provides a set of utility functions for interpreting performance counter data.</summary>
  240. </member>
  241. <member name="M:System.Diagnostics.CounterSampleCalculator.ComputeCounterValue(System.Diagnostics.CounterSample)">
  242. <summary>Computes the calculated value of a single raw counter sample.</summary>
  243. <param name="newSample">A <see cref="T:System.Diagnostics.CounterSample" /> that indicates the most recent sample the system has taken.</param>
  244. <returns>A floating-point representation of the performance counter's calculated value.</returns>
  245. </member>
  246. <member name="M:System.Diagnostics.CounterSampleCalculator.ComputeCounterValue(System.Diagnostics.CounterSample,System.Diagnostics.CounterSample)">
  247. <summary>Computes the calculated value of two raw counter samples.</summary>
  248. <param name="oldSample">A <see cref="T:System.Diagnostics.CounterSample" /> that indicates a previous sample the system has taken.</param>
  249. <param name="newSample">A <see cref="T:System.Diagnostics.CounterSample" /> that indicates the most recent sample the system has taken.</param>
  250. <returns>A floating-point representation of the performance counter's calculated value.</returns>
  251. <exception cref="T:System.InvalidOperationException">
  252. <paramref name="oldSample" /> uses a counter type that is different from <paramref name="newSample" />.</exception>
  253. <exception cref="T:System.ComponentModel.Win32Exception">
  254. <paramref name="newSample" /> counter type has a Performance Data Helper (PDH) error. For more information, see "Checking PDH Interface Return Values" in the Win32 and COM Development section of this documentation.</exception>
  255. </member>
  256. <member name="T:System.Diagnostics.ICollectData">
  257. <summary>Prepares performance data for the performance DLL the system loads when working with performance counters.</summary>
  258. </member>
  259. <member name="M:System.Diagnostics.ICollectData.CloseData">
  260. <summary>Called by the performance DLL's close performance data function.</summary>
  261. </member>
  262. <member name="M:System.Diagnostics.ICollectData.CollectData(System.Int32,System.IntPtr,System.IntPtr,System.Int32,System.IntPtr@)">
  263. <summary>Collects the performance data for the performance DLL.</summary>
  264. <param name="id">The call index.</param>
  265. <param name="valueName">A pointer to a Unicode string list with the requested object identifiers.</param>
  266. <param name="data">A pointer to the data buffer.</param>
  267. <param name="totalBytes">A pointer to a number of bytes.</param>
  268. <param name="res">When this method returns, contains a <see cref="T:System.IntPtr" /> to the first byte after the data, -1 for an error, or -2 if a larger buffer is required. This parameter is passed uninitialized.</param>
  269. </member>
  270. <member name="T:System.Diagnostics.InstanceData">
  271. <summary>Holds instance data associated with a performance counter sample.</summary>
  272. </member>
  273. <member name="M:System.Diagnostics.InstanceData.#ctor(System.String,System.Diagnostics.CounterSample)">
  274. <summary>Initializes a new instance of the InstanceData class, using the specified sample and performance counter instance.</summary>
  275. <param name="instanceName">The name of an instance associated with the performance counter.</param>
  276. <param name="sample">A <see cref="T:System.Diagnostics.CounterSample" /> taken from the instance specified by the <paramref name="instanceName" /> parameter.</param>
  277. </member>
  278. <member name="P:System.Diagnostics.InstanceData.InstanceName">
  279. <summary>Gets the instance name associated with this instance data.</summary>
  280. <returns>The name of an instance associated with the performance counter.</returns>
  281. </member>
  282. <member name="P:System.Diagnostics.InstanceData.RawValue">
  283. <summary>Gets the raw data value associated with the performance counter sample.</summary>
  284. <returns>The raw value read by the performance counter sample associated with the <see cref="P:System.Diagnostics.InstanceData.Sample" /> property.</returns>
  285. </member>
  286. <member name="P:System.Diagnostics.InstanceData.Sample">
  287. <summary>Gets the performance counter sample that generated this data.</summary>
  288. <returns>A <see cref="T:System.Diagnostics.CounterSample" /> taken from the instance specified by the <see cref="P:System.Diagnostics.InstanceData.InstanceName" /> property.</returns>
  289. </member>
  290. <member name="T:System.Diagnostics.InstanceDataCollection">
  291. <summary>Provides a strongly typed collection of <see cref="T:System.Diagnostics.InstanceData" /> objects.</summary>
  292. </member>
  293. <member name="M:System.Diagnostics.InstanceDataCollection.#ctor(System.String)">
  294. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.InstanceDataCollection" /> class, using the specified performance counter (which defines a performance instance).</summary>
  295. <param name="counterName">The name of the counter, which often describes the quantity that is being counted.</param>
  296. <exception cref="T:System.ArgumentNullException">The <paramref name="counterName" /> parameter is <see langword="null" />.</exception>
  297. </member>
  298. <member name="M:System.Diagnostics.InstanceDataCollection.Contains(System.String)">
  299. <summary>Determines whether a performance instance with a specified name (identified by one of the indexed <see cref="T:System.Diagnostics.InstanceData" /> objects) exists in the collection.</summary>
  300. <param name="instanceName">The name of the instance to find in this collection.</param>
  301. <returns>
  302. <see langword="true" /> if the instance exists in the collection; otherwise, <see langword="false" />.</returns>
  303. <exception cref="T:System.ArgumentNullException">The <paramref name="instanceName" /> parameter is <see langword="null" />.</exception>
  304. </member>
  305. <member name="M:System.Diagnostics.InstanceDataCollection.CopyTo(System.Diagnostics.InstanceData[],System.Int32)">
  306. <summary>Copies the items in the collection to the specified one-dimensional array at the specified index.</summary>
  307. <param name="instances">The one-dimensional <see cref="T:System.Array" /> that is the destination of the values copied from the collection.</param>
  308. <param name="index">The zero-based index value at which to add the new instances.</param>
  309. </member>
  310. <member name="P:System.Diagnostics.InstanceDataCollection.CounterName">
  311. <summary>Gets the name of the performance counter whose instance data you want to get.</summary>
  312. <returns>The performance counter name.</returns>
  313. </member>
  314. <member name="P:System.Diagnostics.InstanceDataCollection.Item(System.String)">
  315. <summary>Gets the instance data associated with this counter. This is typically a set of raw counter values.</summary>
  316. <param name="instanceName">The name of the performance counter category instance, or an empty string ("") if the category contains a single instance.</param>
  317. <returns>An <see cref="T:System.Diagnostics.InstanceData" /> item, by which the <see cref="T:System.Diagnostics.InstanceDataCollection" /> object is indexed.</returns>
  318. <exception cref="T:System.ArgumentNullException">The <paramref name="instanceName" /> parameter is <see langword="null" />.</exception>
  319. </member>
  320. <member name="P:System.Diagnostics.InstanceDataCollection.Keys">
  321. <summary>Gets the object and counter registry keys for the objects associated with this instance data.</summary>
  322. <returns>An <see cref="T:System.Collections.ICollection" /> that represents a set of object-specific registry keys.</returns>
  323. </member>
  324. <member name="P:System.Diagnostics.InstanceDataCollection.Values">
  325. <summary>Gets the raw counter values that comprise the instance data for the counter.</summary>
  326. <returns>An <see cref="T:System.Collections.ICollection" /> that represents the counter's raw data values.</returns>
  327. </member>
  328. <member name="T:System.Diagnostics.InstanceDataCollectionCollection">
  329. <summary>Provides a strongly typed collection of <see cref="T:System.Diagnostics.InstanceDataCollection" /> objects.</summary>
  330. </member>
  331. <member name="M:System.Diagnostics.InstanceDataCollectionCollection.#ctor">
  332. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.InstanceDataCollectionCollection" /> class.</summary>
  333. </member>
  334. <member name="M:System.Diagnostics.InstanceDataCollectionCollection.Contains(System.String)">
  335. <summary>Determines whether an instance data collection for the specified counter (identified by one of the indexed <see cref="T:System.Diagnostics.InstanceDataCollection" /> objects) exists in the collection.</summary>
  336. <param name="counterName">The name of the performance counter.</param>
  337. <returns>
  338. <see langword="true" /> if an instance data collection containing the specified counter exists in the collection; otherwise, <see langword="false" />.</returns>
  339. <exception cref="T:System.ArgumentNullException">The <paramref name="counterName" /> parameter is <see langword="null" />.</exception>
  340. </member>
  341. <member name="M:System.Diagnostics.InstanceDataCollectionCollection.CopyTo(System.Diagnostics.InstanceDataCollection[],System.Int32)">
  342. <summary>Copies an array of <see cref="T:System.Diagnostics.InstanceDataCollection" /> instances to the collection, at the specified index.</summary>
  343. <param name="counters">An array of <see cref="T:System.Diagnostics.InstanceDataCollection" /> instances (identified by the counters they contain) to add to the collection.</param>
  344. <param name="index">The location at which to add the new instances.</param>
  345. </member>
  346. <member name="P:System.Diagnostics.InstanceDataCollectionCollection.Item(System.String)">
  347. <summary>Gets the instance data for the specified counter.</summary>
  348. <param name="counterName">The name of the performance counter.</param>
  349. <returns>An <see cref="T:System.Diagnostics.InstanceDataCollection" /> item, by which the <see cref="T:System.Diagnostics.InstanceDataCollectionCollection" /> object is indexed.</returns>
  350. <exception cref="T:System.ArgumentNullException">The <paramref name="counterName" /> parameter is <see langword="null" />.</exception>
  351. </member>
  352. <member name="P:System.Diagnostics.InstanceDataCollectionCollection.Keys">
  353. <summary>Gets the object and counter registry keys for the objects associated with this instance data collection.</summary>
  354. <returns>An <see cref="T:System.Collections.ICollection" /> that represents a set of object-specific registry keys.</returns>
  355. </member>
  356. <member name="P:System.Diagnostics.InstanceDataCollectionCollection.Values">
  357. <summary>Gets the instance data values that comprise the collection of instances for the counter.</summary>
  358. <returns>An <see cref="T:System.Collections.ICollection" /> that represents the counter's instances and their associated data values.</returns>
  359. </member>
  360. <member name="T:System.Diagnostics.PerformanceCounter">
  361. <summary>Represents a Windows NT performance counter component.</summary>
  362. </member>
  363. <member name="M:System.Diagnostics.PerformanceCounter.#ctor">
  364. <summary>Initializes a new, read-only instance of the <see cref="T:System.Diagnostics.PerformanceCounter" /> class, without associating the instance with any system or custom performance counter.</summary>
  365. </member>
  366. <member name="M:System.Diagnostics.PerformanceCounter.#ctor(System.String,System.String)">
  367. <summary>Initializes a new, read-only instance of the <see cref="T:System.Diagnostics.PerformanceCounter" /> class and associates it with the specified system or custom performance counter on the local computer. This constructor requires that the category have a single instance.</summary>
  368. <param name="categoryName">The name of the performance counter category (performance object) with which this performance counter is associated.</param>
  369. <param name="counterName">The name of the performance counter.</param>
  370. <exception cref="T:System.InvalidOperationException">
  371. <paramref name="categoryName" /> is an empty string ("").
  372. -or-
  373. <paramref name="counterName" /> is an empty string ("").
  374. -or-
  375. The category specified does not exist.
  376. -or-
  377. The category specified is marked as multi-instance and requires the performance counter to be created with an instance name.
  378. -or-
  379. <paramref name="categoryName" /> and <paramref name="counterName" /> have been localized into different languages.</exception>
  380. <exception cref="T:System.ArgumentNullException">
  381. <paramref name="categoryName" /> or <paramref name="counterName" /> is <see langword="null" />.</exception>
  382. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  383. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  384. </member>
  385. <member name="M:System.Diagnostics.PerformanceCounter.#ctor(System.String,System.String,System.Boolean)">
  386. <summary>Initializes a new, read-only or read/write instance of the <see cref="T:System.Diagnostics.PerformanceCounter" /> class and associates it with the specified system or custom performance counter on the local computer. This constructor requires that the category contain a single instance.</summary>
  387. <param name="categoryName">The name of the performance counter category (performance object) with which this performance counter is associated.</param>
  388. <param name="counterName">The name of the performance counter.</param>
  389. <param name="readOnly">
  390. <see langword="true" /> to access the counter in read-only mode (although the counter itself could be read/write); <see langword="false" /> to access the counter in read/write mode.</param>
  391. <exception cref="T:System.InvalidOperationException">The <paramref name="categoryName" /> is an empty string ("").
  392. -or-
  393. The <paramref name="counterName" /> is an empty string ("").
  394. -or-
  395. The category specified does not exist. (if <paramref name="readOnly" /> is <see langword="true" />).
  396. -or-
  397. The category specified is not a .NET Framework custom category (if <paramref name="readOnly" /> is <see langword="false" />).
  398. -or-
  399. The category specified is marked as multi-instance and requires the performance counter to be created with an instance name.
  400. -or-
  401. <paramref name="categoryName" /> and <paramref name="counterName" /> have been localized into different languages.</exception>
  402. <exception cref="T:System.ArgumentNullException">
  403. <paramref name="categoryName" /> or <paramref name="counterName" /> is <see langword="null" />.</exception>
  404. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  405. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  406. </member>
  407. <member name="M:System.Diagnostics.PerformanceCounter.#ctor(System.String,System.String,System.String)">
  408. <summary>Initializes a new, read-only instance of the <see cref="T:System.Diagnostics.PerformanceCounter" /> class and associates it with the specified system or custom performance counter and category instance on the local computer.</summary>
  409. <param name="categoryName">The name of the performance counter category (performance object) with which this performance counter is associated.</param>
  410. <param name="counterName">The name of the performance counter.</param>
  411. <param name="instanceName">The name of the performance counter category instance, or an empty string (""), if the category contains a single instance.</param>
  412. <exception cref="T:System.InvalidOperationException">
  413. <paramref name="categoryName" /> is an empty string ("").
  414. -or-
  415. <paramref name="counterName" /> is an empty string ("").
  416. -or-
  417. The category specified is not valid.
  418. -or-
  419. The category specified is marked as multi-instance and requires the performance counter to be created with an instance name.
  420. -or-
  421. <paramref name="instanceName" /> is longer than 127 characters.
  422. -or-
  423. <paramref name="categoryName" /> and <paramref name="counterName" /> have been localized into different languages.</exception>
  424. <exception cref="T:System.ArgumentNullException">
  425. <paramref name="categoryName" /> or <paramref name="counterName" /> is <see langword="null" />.</exception>
  426. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  427. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  428. </member>
  429. <member name="M:System.Diagnostics.PerformanceCounter.#ctor(System.String,System.String,System.String,System.Boolean)">
  430. <summary>Initializes a new, read-only or read/write instance of the <see cref="T:System.Diagnostics.PerformanceCounter" /> class and associates it with the specified system or custom performance counter and category instance on the local computer.</summary>
  431. <param name="categoryName">The name of the performance counter category (performance object) with which this performance counter is associated.</param>
  432. <param name="counterName">The name of the performance counter.</param>
  433. <param name="instanceName">The name of the performance counter category instance, or an empty string (""), if the category contains a single instance.</param>
  434. <param name="readOnly">
  435. <see langword="true" /> to access a counter in read-only mode; <see langword="false" /> to access a counter in read/write mode.</param>
  436. <exception cref="T:System.InvalidOperationException">
  437. <paramref name="categoryName" /> is an empty string ("").
  438. -or-
  439. <paramref name="counterName" /> is an empty string ("").
  440. -or-
  441. The read/write permission setting requested is invalid for this counter.
  442. -or-
  443. The category specified does not exist (if <paramref name="readOnly" /> is <see langword="true" />).
  444. -or-
  445. The category specified is not a .NET Framework custom category (if <paramref name="readOnly" /> is <see langword="false" />).
  446. -or-
  447. The category specified is marked as multi-instance and requires the performance counter to be created with an instance name.
  448. -or-
  449. <paramref name="instanceName" /> is longer than 127 characters.
  450. -or-
  451. <paramref name="categoryName" /> and <paramref name="counterName" /> have been localized into different languages.</exception>
  452. <exception cref="T:System.ArgumentNullException">
  453. <paramref name="categoryName" /> or <paramref name="counterName" /> is <see langword="null" />.</exception>
  454. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  455. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  456. </member>
  457. <member name="M:System.Diagnostics.PerformanceCounter.#ctor(System.String,System.String,System.String,System.String)">
  458. <summary>Initializes a new, read-only instance of the <see cref="T:System.Diagnostics.PerformanceCounter" /> class and associates it with the specified system or custom performance counter and category instance, on the specified computer.</summary>
  459. <param name="categoryName">The name of the performance counter category (performance object) with which this performance counter is associated.</param>
  460. <param name="counterName">The name of the performance counter.</param>
  461. <param name="instanceName">The name of the performance counter category instance, or an empty string (""), if the category contains a single instance.</param>
  462. <param name="machineName">The computer on which the performance counter and its associated category exist.</param>
  463. <exception cref="T:System.InvalidOperationException">
  464. <paramref name="categoryName" /> is an empty string ("").
  465. -or-
  466. <paramref name="counterName" /> is an empty string ("").
  467. -or-
  468. The read/write permission setting requested is invalid for this counter.
  469. -or-
  470. The counter does not exist on the specified computer.
  471. -or-
  472. The category specified is marked as multi-instance and requires the performance counter to be created with an instance name.
  473. -or-
  474. <paramref name="instanceName" /> is longer than 127 characters.
  475. -or-
  476. <paramref name="categoryName" /> and <paramref name="counterName" /> have been localized into different languages.</exception>
  477. <exception cref="T:System.ArgumentException">The <paramref name="machineName" /> parameter is not valid.</exception>
  478. <exception cref="T:System.ArgumentNullException">
  479. <paramref name="categoryName" /> or <paramref name="counterName" /> is <see langword="null" />.</exception>
  480. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  481. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  482. </member>
  483. <member name="M:System.Diagnostics.PerformanceCounter.BeginInit">
  484. <summary>Begins the initialization of a <see cref="T:System.Diagnostics.PerformanceCounter" /> instance used on a form or by another component. The initialization occurs at runtime.</summary>
  485. </member>
  486. <member name="P:System.Diagnostics.PerformanceCounter.CategoryName">
  487. <summary>Gets or sets the name of the performance counter category for this performance counter.</summary>
  488. <returns>The name of the performance counter category (performance object) with which this performance counter is associated.</returns>
  489. <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Diagnostics.PerformanceCounter.CategoryName" /> is <see langword="null" />.</exception>
  490. </member>
  491. <member name="M:System.Diagnostics.PerformanceCounter.Close">
  492. <summary>Closes the performance counter and frees all the resources allocated by this performance counter instance.</summary>
  493. </member>
  494. <member name="M:System.Diagnostics.PerformanceCounter.CloseSharedResources">
  495. <summary>Frees the performance counter library shared state allocated by the counters.</summary>
  496. </member>
  497. <member name="P:System.Diagnostics.PerformanceCounter.CounterHelp">
  498. <summary>Gets the description for this performance counter.</summary>
  499. <returns>A description of the item or quantity that this performance counter measures.</returns>
  500. <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Diagnostics.PerformanceCounter" /> instance is not associated with a performance counter.
  501. -or-
  502. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  503. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  504. </member>
  505. <member name="P:System.Diagnostics.PerformanceCounter.CounterName">
  506. <summary>Gets or sets the name of the performance counter that is associated with this <see cref="T:System.Diagnostics.PerformanceCounter" /> instance.</summary>
  507. <returns>The name of the counter, which generally describes the quantity being counted. This name is displayed in the list of counters of the Performance Counter Manager MMC snap in's Add Counters dialog box.</returns>
  508. <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Diagnostics.PerformanceCounter.CounterName" /> is <see langword="null" />.</exception>
  509. </member>
  510. <member name="P:System.Diagnostics.PerformanceCounter.CounterType">
  511. <summary>Gets the counter type of the associated performance counter.</summary>
  512. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterType" /> that describes both how the counter interacts with a monitoring application and the nature of the values it contains (for example, calculated or uncalculated).</returns>
  513. <exception cref="T:System.InvalidOperationException">The instance is not correctly associated with a performance counter.
  514. -or-
  515. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  516. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  517. </member>
  518. <member name="M:System.Diagnostics.PerformanceCounter.Decrement">
  519. <summary>Decrements the associated performance counter by one through an efficient atomic operation.</summary>
  520. <returns>The decremented counter value.</returns>
  521. <exception cref="T:System.InvalidOperationException">The counter is read-only, so the application cannot decrement it.
  522. -or-
  523. The instance is not correctly associated with a performance counter.
  524. -or-
  525. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  526. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  527. </member>
  528. <member name="F:System.Diagnostics.PerformanceCounter.DefaultFileMappingSize">
  529. <summary>Specifies the size, in bytes, of the global memory shared by performance counters. The default size is 524,288 bytes.</summary>
  530. </member>
  531. <member name="M:System.Diagnostics.PerformanceCounter.EndInit">
  532. <summary>Ends the initialization of a <see cref="T:System.Diagnostics.PerformanceCounter" /> instance that is used on a form or by another component. The initialization occurs at runtime.</summary>
  533. </member>
  534. <member name="M:System.Diagnostics.PerformanceCounter.Increment">
  535. <summary>Increments the associated performance counter by one through an efficient atomic operation.</summary>
  536. <returns>The incremented counter value.</returns>
  537. <exception cref="T:System.InvalidOperationException">The counter is read-only, so the application cannot increment it.
  538. -or-
  539. The instance is not correctly associated with a performance counter.
  540. -or-
  541. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  542. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  543. </member>
  544. <member name="M:System.Diagnostics.PerformanceCounter.IncrementBy(System.Int64)">
  545. <summary>Increments or decrements the value of the associated performance counter by a specified amount through an efficient atomic operation.</summary>
  546. <param name="value">The value to increment by. (A negative value decrements the counter.)</param>
  547. <returns>The new counter value.</returns>
  548. <exception cref="T:System.InvalidOperationException">The counter is read-only, so the application cannot increment it.
  549. -or-
  550. The instance is not correctly associated with a performance counter.
  551. -or-
  552. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  553. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  554. </member>
  555. <member name="P:System.Diagnostics.PerformanceCounter.InstanceLifetime">
  556. <summary>Gets or sets the lifetime of a process.</summary>
  557. <returns>One of the <see cref="T:System.Diagnostics.PerformanceCounterInstanceLifetime" /> values. The default is <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Global" />.</returns>
  558. <exception cref="T:System.ArgumentOutOfRangeException">The value set is not a member of the <see cref="T:System.Diagnostics.PerformanceCounterInstanceLifetime" /> enumeration.</exception>
  559. <exception cref="T:System.InvalidOperationException">
  560. <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> is set after the <see cref="T:System.Diagnostics.PerformanceCounter" /> has been initialized.</exception>
  561. </member>
  562. <member name="P:System.Diagnostics.PerformanceCounter.InstanceName">
  563. <summary>Gets or sets an instance name for this performance counter.</summary>
  564. <returns>The name of the performance counter category instance, or an empty string (""), if the counter is a single-instance counter.</returns>
  565. </member>
  566. <member name="P:System.Diagnostics.PerformanceCounter.MachineName">
  567. <summary>Gets or sets the computer name for this performance counter.</summary>
  568. <returns>The server on which the performance counter and its associated category reside.</returns>
  569. <exception cref="T:System.ArgumentException">The <see cref="P:System.Diagnostics.PerformanceCounter.MachineName" /> format is invalid.</exception>
  570. </member>
  571. <member name="M:System.Diagnostics.PerformanceCounter.NextSample">
  572. <summary>Obtains a counter sample, and returns the raw, or uncalculated, value for it.</summary>
  573. <returns>A <see cref="T:System.Diagnostics.CounterSample" /> that represents the next raw value that the system obtains for this counter.</returns>
  574. <exception cref="T:System.InvalidOperationException">The instance is not correctly associated with a performance counter.
  575. -or-
  576. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  577. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  578. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  579. </member>
  580. <member name="M:System.Diagnostics.PerformanceCounter.NextValue">
  581. <summary>Obtains a counter sample and returns the calculated value for it.</summary>
  582. <returns>The next calculated value that the system obtains for this counter.</returns>
  583. <exception cref="T:System.InvalidOperationException">The instance is not correctly associated with a performance counter.</exception>
  584. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  585. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  586. </member>
  587. <member name="P:System.Diagnostics.PerformanceCounter.RawValue">
  588. <summary>Gets or sets the raw, or uncalculated, value of this counter.</summary>
  589. <returns>The raw value of the counter.</returns>
  590. <exception cref="T:System.InvalidOperationException">You are trying to set the counter's raw value, but the counter is read-only.
  591. -or-
  592. The instance is not correctly associated with a performance counter.
  593. -or-
  594. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  595. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  596. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  597. </member>
  598. <member name="P:System.Diagnostics.PerformanceCounter.ReadOnly">
  599. <summary>Gets or sets a value indicating whether this <see cref="T:System.Diagnostics.PerformanceCounter" /> instance is in read-only mode.</summary>
  600. <returns>
  601. <see langword="true" />, if the <see cref="T:System.Diagnostics.PerformanceCounter" /> instance is in read-only mode (even if the counter itself is a custom .NET Framework counter); <see langword="false" /> if it is in read/write mode. The default is the value set by the constructor.</returns>
  602. </member>
  603. <member name="M:System.Diagnostics.PerformanceCounter.RemoveInstance">
  604. <summary>Deletes the category instance specified by the <see cref="T:System.Diagnostics.PerformanceCounter" /> object <see cref="P:System.Diagnostics.PerformanceCounter.InstanceName" /> property.</summary>
  605. <exception cref="T:System.InvalidOperationException">This counter is read-only, so any instance that is associated with the category cannot be removed.
  606. -or-
  607. The instance is not correctly associated with a performance counter.
  608. -or-
  609. The <see cref="P:System.Diagnostics.PerformanceCounter.InstanceLifetime" /> property is set to <see cref="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process" /> when using global shared memory.</exception>
  610. <exception cref="T:System.ComponentModel.Win32Exception">An error occurred when accessing a system API.</exception>
  611. </member>
  612. <member name="T:System.Diagnostics.PerformanceCounterCategory">
  613. <summary>Represents a performance object, which defines a category of performance counters.</summary>
  614. </member>
  615. <member name="M:System.Diagnostics.PerformanceCounterCategory.#ctor">
  616. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> class, leaves the <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property empty, and sets the <see cref="P:System.Diagnostics.PerformanceCounterCategory.MachineName" /> property to the local computer.</summary>
  617. </member>
  618. <member name="M:System.Diagnostics.PerformanceCounterCategory.#ctor(System.String)">
  619. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> class, sets the <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property to the specified value, and sets the <see cref="P:System.Diagnostics.PerformanceCounterCategory.MachineName" /> property to the local computer.</summary>
  620. <param name="categoryName">The name of the performance counter category, or performance object, with which to associate this <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> instance.</param>
  621. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> is an empty string ("").</exception>
  622. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> is <see langword="null" />.</exception>
  623. </member>
  624. <member name="M:System.Diagnostics.PerformanceCounterCategory.#ctor(System.String,System.String)">
  625. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> class and sets the <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> and <see cref="P:System.Diagnostics.PerformanceCounterCategory.MachineName" /> properties to the specified values.</summary>
  626. <param name="categoryName">The name of the performance counter category, or performance object, with which to associate this <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> instance.</param>
  627. <param name="machineName">The computer on which the performance counter category and its associated counters exist.</param>
  628. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> is an empty string ("").
  629. -or-
  630. The <paramref name="machineName" /> syntax is invalid.</exception>
  631. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> is <see langword="null" />.</exception>
  632. </member>
  633. <member name="P:System.Diagnostics.PerformanceCounterCategory.CategoryHelp">
  634. <summary>Gets the category's help text.</summary>
  635. <returns>A description of the performance object that this category measures.</returns>
  636. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property is <see langword="null" />. The category name must be set before getting the category help.</exception>
  637. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  638. </member>
  639. <member name="P:System.Diagnostics.PerformanceCounterCategory.CategoryName">
  640. <summary>Gets or sets the name of the performance object that defines this category.</summary>
  641. <returns>The name of the performance counter category, or performance object, with which to associate this <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> instance.</returns>
  642. <exception cref="T:System.ArgumentException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> is an empty string ("").</exception>
  643. <exception cref="T:System.ArgumentNullException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> is <see langword="null" />.</exception>
  644. </member>
  645. <member name="P:System.Diagnostics.PerformanceCounterCategory.CategoryType">
  646. <summary>Gets the performance counter category type.</summary>
  647. <returns>One of the <see cref="T:System.Diagnostics.PerformanceCounterCategoryType" /> values.</returns>
  648. </member>
  649. <member name="M:System.Diagnostics.PerformanceCounterCategory.CounterExists(System.String)">
  650. <summary>Determines whether the specified counter is registered to this category, which is indicated by the <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> and <see cref="P:System.Diagnostics.PerformanceCounterCategory.MachineName" /> properties.</summary>
  651. <param name="counterName">The name of the performance counter to look for.</param>
  652. <returns>
  653. <see langword="true" /> if the counter is registered to the category that is specified by the <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> and <see cref="P:System.Diagnostics.PerformanceCounterCategory.MachineName" /> properties; otherwise, <see langword="false" />.</returns>
  654. <exception cref="T:System.ArgumentNullException">The <paramref name="counterName" /> is <see langword="null" />.</exception>
  655. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property has not been set.</exception>
  656. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  657. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  658. </member>
  659. <member name="M:System.Diagnostics.PerformanceCounterCategory.CounterExists(System.String,System.String)">
  660. <summary>Determines whether the specified counter is registered to the specified category on the local computer.</summary>
  661. <param name="counterName">The name of the performance counter to look for.</param>
  662. <param name="categoryName">The name of the performance counter category, or performance object, with which the specified performance counter is associated.</param>
  663. <returns>
  664. <see langword="true" />, if the counter is registered to the specified category on the local computer; otherwise, <see langword="false" />.</returns>
  665. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> is <see langword="null" />.
  666. -or-
  667. The <paramref name="counterName" /> is <see langword="null" />.</exception>
  668. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> is an empty string ("").</exception>
  669. <exception cref="T:System.InvalidOperationException">The category name does not exist.</exception>
  670. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  671. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  672. </member>
  673. <member name="M:System.Diagnostics.PerformanceCounterCategory.CounterExists(System.String,System.String,System.String)">
  674. <summary>Determines whether the specified counter is registered to the specified category on a remote computer.</summary>
  675. <param name="counterName">The name of the performance counter to look for.</param>
  676. <param name="categoryName">The name of the performance counter category, or performance object, with which the specified performance counter is associated.</param>
  677. <param name="machineName">The name of the computer on which the performance counter category and its associated counters exist.</param>
  678. <returns>
  679. <see langword="true" />, if the counter is registered to the specified category on the specified computer; otherwise, <see langword="false" />.</returns>
  680. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> is <see langword="null" />.
  681. -or-
  682. The <paramref name="counterName" /> is <see langword="null" />.</exception>
  683. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> is an empty string ("").
  684. -or-
  685. The <paramref name="machineName" /> is invalid.</exception>
  686. <exception cref="T:System.InvalidOperationException">The category name does not exist.</exception>
  687. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  688. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  689. </member>
  690. <member name="M:System.Diagnostics.PerformanceCounterCategory.Create(System.String,System.String,System.Diagnostics.CounterCreationDataCollection)">
  691. <summary>Registers the custom performance counter category containing the specified counters on the local computer.</summary>
  692. <param name="categoryName">The name of the custom performance counter category to create and register with the system.</param>
  693. <param name="categoryHelp">A description of the custom category.</param>
  694. <param name="counterData">A <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> that specifies the counters to create as part of the new category.</param>
  695. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> that is associated with the new custom category, or performance object.</returns>
  696. <exception cref="T:System.ArgumentException">A counter name that is specified within the <paramref name="counterData" /> collection is <see langword="null" /> or an empty string ("").
  697. -or-
  698. A counter that is specified within the <paramref name="counterData" /> collection already exists.
  699. -or-
  700. The <paramref name="counterName" /> parameter has invalid syntax. It might contain backslash characters ("\") or have length greater than 80 characters.</exception>
  701. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> parameter is <see langword="null" />.</exception>
  702. <exception cref="T:System.InvalidOperationException">The category already exists on the local computer.
  703. -or-
  704. The layout of the <paramref name="counterData" /> collection is incorrect for base counters. A counter of type <see langword="AverageCount64" />, <see langword="AverageTimer32" />, <see langword="CounterMultiTimer" />, <see langword="CounterMultiTimerInverse" />, <see langword="CounterMultiTimer100Ns" />, <see langword="CounterMultiTimer100NsInverse" />, <see langword="RawFraction" />, <see langword="SampleFraction" /> or <see langword="SampleCounter" /> has to be immediately followed by one of the base counter types (<see langword="AverageBase" />, <see langword="MultiBase" />, <see langword="RawBase" />, or <see langword="SampleBase" />).</exception>
  705. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  706. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  707. </member>
  708. <member name="M:System.Diagnostics.PerformanceCounterCategory.Create(System.String,System.String,System.Diagnostics.PerformanceCounterCategoryType,System.Diagnostics.CounterCreationDataCollection)">
  709. <summary>Registers the custom performance counter category containing the specified counters on the local computer.</summary>
  710. <param name="categoryName">The name of the custom performance counter category to create and register with the system.</param>
  711. <param name="categoryHelp">A description of the custom category.</param>
  712. <param name="categoryType">One of the <see cref="T:System.Diagnostics.PerformanceCounterCategoryType" /> values.</param>
  713. <param name="counterData">A <see cref="T:System.Diagnostics.CounterCreationDataCollection" /> that specifies the counters to create as part of the new category.</param>
  714. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> that is associated with the new custom category, or performance object.</returns>
  715. <exception cref="T:System.ArgumentException">A counter name that is specified within the <paramref name="counterData" /> collection is <see langword="null" /> or an empty string ("").
  716. -or-
  717. A counter that is specified within the <paramref name="counterData" /> collection already exists.
  718. -or-
  719. <paramref name="counterName" /> has invalid syntax. It might contain backslash characters ("\") or have length greater than 80 characters.</exception>
  720. <exception cref="T:System.ArgumentNullException">
  721. <paramref name="categoryName" /> is <see langword="null" />.
  722. -or-
  723. <paramref name="counterData" /> is <see langword="null" />.</exception>
  724. <exception cref="T:System.ArgumentOutOfRangeException">
  725. <paramref name="categoryType" /> value is outside of the range of the following values: <see langword="MultiInstance" />, <see langword="SingleInstance" />, or <see langword="Unknown" />.</exception>
  726. <exception cref="T:System.InvalidOperationException">The category already exists on the local computer.
  727. -or-
  728. The layout of the <paramref name="counterData" /> collection is incorrect for base counters. A counter of type <see langword="AverageCount64" />, <see langword="AverageTimer32" />, <see langword="CounterMultiTimer" />, <see langword="CounterMultiTimerInverse" />, <see langword="CounterMultiTimer100Ns" />, <see langword="CounterMultiTimer100NsInverse" />, <see langword="RawFraction" />, <see langword="SampleFraction" />, or <see langword="SampleCounter" /> must be immediately followed by one of the base counter types (<see langword="AverageBase" />, <see langword="MultiBase" />, <see langword="RawBase" />, or <see langword="SampleBase" />).</exception>
  729. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  730. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  731. </member>
  732. <member name="M:System.Diagnostics.PerformanceCounterCategory.Create(System.String,System.String,System.Diagnostics.PerformanceCounterCategoryType,System.String,System.String)">
  733. <summary>Registers the custom performance counter category containing a single counter of type <see cref="F:System.Diagnostics.PerformanceCounterType.NumberOfItems32" /> on the local computer.</summary>
  734. <param name="categoryName">The name of the custom performance counter category to create and register with the system.</param>
  735. <param name="categoryHelp">A description of the custom category.</param>
  736. <param name="categoryType">One of the <see cref="T:System.Diagnostics.PerformanceCounterCategoryType" /> values specifying whether the category is <see cref="F:System.Diagnostics.PerformanceCounterCategoryType.MultiInstance" />, <see cref="F:System.Diagnostics.PerformanceCounterCategoryType.SingleInstance" />, or <see cref="F:System.Diagnostics.PerformanceCounterCategoryType.Unknown" />.</param>
  737. <param name="counterName">The name of a new counter to create as part of the new category.</param>
  738. <param name="counterHelp">A description of the counter that is associated with the new custom category.</param>
  739. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> that is associated with the new system category, or performance object.</returns>
  740. <exception cref="T:System.ArgumentException">
  741. <paramref name="counterName" /> is <see langword="null" /> or is an empty string ("").
  742. -or-
  743. The counter that is specified by <paramref name="counterName" /> already exists.
  744. -or-
  745. <paramref name="counterName" /> has invalid syntax. It might contain backslash characters ("\") or have length greater than 80 characters.</exception>
  746. <exception cref="T:System.InvalidOperationException">The category already exists on the local computer.</exception>
  747. <exception cref="T:System.ArgumentNullException">
  748. <paramref name="categoryName" /> is <see langword="null" />.
  749. -or-
  750. <paramref name="counterHelp" /> is <see langword="null" />.</exception>
  751. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  752. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  753. </member>
  754. <member name="M:System.Diagnostics.PerformanceCounterCategory.Create(System.String,System.String,System.String,System.String)">
  755. <summary>Registers a custom performance counter category containing a single counter of type <see langword="NumberOfItems32" /> on the local computer.</summary>
  756. <param name="categoryName">The name of the custom performance counter category to create and register with the system.</param>
  757. <param name="categoryHelp">A description of the custom category.</param>
  758. <param name="counterName">The name of a new counter, of type <see langword="NumberOfItems32" />, to create as part of the new category.</param>
  759. <param name="counterHelp">A description of the counter that is associated with the new custom category.</param>
  760. <returns>A <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> that is associated with the new system category, or performance object.</returns>
  761. <exception cref="T:System.ArgumentException">
  762. <paramref name="counterName" /> is <see langword="null" /> or is an empty string ("").
  763. -or-
  764. The counter that is specified by <paramref name="counterName" /> already exists.
  765. -or-
  766. <paramref name="counterName" /> has invalid syntax. It might contain backslash characters ("\") or have length greater than 80 characters.</exception>
  767. <exception cref="T:System.InvalidOperationException">The category already exists on the local computer.</exception>
  768. <exception cref="T:System.ArgumentNullException">
  769. <paramref name="categoryName" /> is <see langword="null" />.
  770. -or-
  771. <paramref name="counterHelp" /> is <see langword="null" />.</exception>
  772. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  773. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  774. </member>
  775. <member name="M:System.Diagnostics.PerformanceCounterCategory.Delete(System.String)">
  776. <summary>Removes the category and its associated counters from the local computer.</summary>
  777. <param name="categoryName">The name of the custom performance counter category to delete.</param>
  778. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> parameter is <see langword="null" />.</exception>
  779. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> parameter has invalid syntax. It might contain backslash characters ("\") or have length greater than 80 characters.</exception>
  780. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  781. <exception cref="T:System.InvalidOperationException">The category cannot be deleted because it is not a custom category.</exception>
  782. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  783. </member>
  784. <member name="M:System.Diagnostics.PerformanceCounterCategory.Exists(System.String)">
  785. <summary>Determines whether the category is registered on the local computer.</summary>
  786. <param name="categoryName">The name of the performance counter category to look for.</param>
  787. <returns>
  788. <see langword="true" /> if the category is registered; otherwise, <see langword="false" />.</returns>
  789. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> parameter is <see langword="null" />.</exception>
  790. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> parameter is an empty string ("").</exception>
  791. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  792. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  793. </member>
  794. <member name="M:System.Diagnostics.PerformanceCounterCategory.Exists(System.String,System.String)">
  795. <summary>Determines whether the category is registered on the specified computer.</summary>
  796. <param name="categoryName">The name of the performance counter category to look for.</param>
  797. <param name="machineName">The name of the computer to examine for the category.</param>
  798. <returns>
  799. <see langword="true" /> if the category is registered; otherwise, <see langword="false" />.</returns>
  800. <exception cref="T:System.ArgumentNullException">The <paramref name="categoryName" /> parameter is <see langword="null" />.</exception>
  801. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> parameter is an empty string ("").
  802. -or-
  803. The <paramref name="machineName" /> parameter is invalid.</exception>
  804. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  805. <exception cref="T:System.IO.IOException">The network path cannot be found.</exception>
  806. <exception cref="T:System.UnauthorizedAccessException">The caller does not have the required permission.
  807. -or-
  808. Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  809. </member>
  810. <member name="M:System.Diagnostics.PerformanceCounterCategory.GetCategories">
  811. <summary>Retrieves a list of the performance counter categories that are registered on the local computer.</summary>
  812. <returns>An array of <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> objects indicating the categories that are registered on the local computer.</returns>
  813. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  814. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  815. </member>
  816. <member name="M:System.Diagnostics.PerformanceCounterCategory.GetCategories(System.String)">
  817. <summary>Retrieves a list of the performance counter categories that are registered on the specified computer.</summary>
  818. <param name="machineName">The computer to look on.</param>
  819. <returns>An array of <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> objects indicating the categories that are registered on the specified computer.</returns>
  820. <exception cref="T:System.ArgumentException">The <paramref name="machineName" /> parameter is invalid.</exception>
  821. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  822. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  823. </member>
  824. <member name="M:System.Diagnostics.PerformanceCounterCategory.GetCounters">
  825. <summary>Retrieves a list of the counters in a performance counter category that contains exactly one instance.</summary>
  826. <returns>An array of <see cref="T:System.Diagnostics.PerformanceCounter" /> objects indicating the counters that are associated with this single-instance performance counter category.</returns>
  827. <exception cref="T:System.ArgumentException">The category is not a single instance.</exception>
  828. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  829. <exception cref="T:System.InvalidOperationException">The category does not have an associated instance.</exception>
  830. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  831. </member>
  832. <member name="M:System.Diagnostics.PerformanceCounterCategory.GetCounters(System.String)">
  833. <summary>Retrieves a list of the counters in a performance counter category that contains one or more instances.</summary>
  834. <param name="instanceName">The performance object instance for which to retrieve the list of associated counters.</param>
  835. <returns>An array of <see cref="T:System.Diagnostics.PerformanceCounter" /> objects indicating the counters that are associated with the specified object instance of this performance counter category.</returns>
  836. <exception cref="T:System.ArgumentNullException">The <paramref name="instanceName" /> parameter is <see langword="null" />.</exception>
  837. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property for this <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> instance has not been set.
  838. -or-
  839. The category does not contain the instance that is specified by the <paramref name="instanceName" /> parameter.</exception>
  840. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  841. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  842. </member>
  843. <member name="M:System.Diagnostics.PerformanceCounterCategory.GetInstanceNames">
  844. <summary>Retrieves the list of performance object instances that are associated with this category.</summary>
  845. <returns>An array of strings representing the performance object instance names that are associated with this category or, if the category contains only one performance object instance, a single-entry array that contains an empty string ("").</returns>
  846. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property is <see langword="null" />. The property might not have been set.
  847. -or-
  848. The category does not have an associated instance.</exception>
  849. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  850. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  851. </member>
  852. <member name="M:System.Diagnostics.PerformanceCounterCategory.InstanceExists(System.String)">
  853. <summary>Determines whether the specified performance object instance exists in the category that is identified by this <see cref="T:System.Diagnostics.PerformanceCounterCategory" /> object's <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property.</summary>
  854. <param name="instanceName">The performance object instance in this performance counter category to search for.</param>
  855. <returns>
  856. <see langword="true" /> if the category contains the specified performance object instance; otherwise, <see langword="false" />.</returns>
  857. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property is <see langword="null" />. The property might not have been set.</exception>
  858. <exception cref="T:System.ArgumentNullException">The <paramref name="instanceName" /> parameter is <see langword="null" />.</exception>
  859. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  860. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  861. </member>
  862. <member name="M:System.Diagnostics.PerformanceCounterCategory.InstanceExists(System.String,System.String)">
  863. <summary>Determines whether a specified category on the local computer contains the specified performance object instance.</summary>
  864. <param name="instanceName">The performance object instance to search for.</param>
  865. <param name="categoryName">The performance counter category to search.</param>
  866. <returns>
  867. <see langword="true" /> if the category contains the specified performance object instance; otherwise, <see langword="false" />.</returns>
  868. <exception cref="T:System.ArgumentNullException">The <paramref name="instanceName" /> parameter is <see langword="null" />.
  869. -or-
  870. The <paramref name="categoryName" /> parameter is <see langword="null" />.</exception>
  871. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> parameter is an empty string ("").</exception>
  872. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  873. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  874. </member>
  875. <member name="M:System.Diagnostics.PerformanceCounterCategory.InstanceExists(System.String,System.String,System.String)">
  876. <summary>Determines whether a specified category on a specified computer contains the specified performance object instance.</summary>
  877. <param name="instanceName">The performance object instance to search for.</param>
  878. <param name="categoryName">The performance counter category to search.</param>
  879. <param name="machineName">The name of the computer on which to look for the category instance pair.</param>
  880. <returns>
  881. <see langword="true" /> if the category contains the specified performance object instance; otherwise, <see langword="false" />.</returns>
  882. <exception cref="T:System.ArgumentNullException">The <paramref name="instanceName" /> parameter is <see langword="null" />.
  883. -or-
  884. The <paramref name="categoryName" /> parameter is <see langword="null" />.</exception>
  885. <exception cref="T:System.ArgumentException">The <paramref name="categoryName" /> parameter is an empty string ("").
  886. -or-
  887. The <paramref name="machineName" /> parameter is invalid.</exception>
  888. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  889. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  890. </member>
  891. <member name="P:System.Diagnostics.PerformanceCounterCategory.MachineName">
  892. <summary>Gets or sets the name of the computer on which this category exists.</summary>
  893. <returns>The name of the computer on which the performance counter category and its associated counters exist.</returns>
  894. <exception cref="T:System.ArgumentException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.MachineName" /> syntax is invalid.</exception>
  895. </member>
  896. <member name="M:System.Diagnostics.PerformanceCounterCategory.ReadCategory">
  897. <summary>Reads all the counter and performance object instance data that is associated with this performance counter category.</summary>
  898. <returns>An <see cref="T:System.Diagnostics.InstanceDataCollectionCollection" /> that contains the counter and performance object instance data for the category.</returns>
  899. <exception cref="T:System.InvalidOperationException">The <see cref="P:System.Diagnostics.PerformanceCounterCategory.CategoryName" /> property is <see langword="null" />. The property might not have been set.</exception>
  900. <exception cref="T:System.ComponentModel.Win32Exception">A call to an underlying system API failed.</exception>
  901. <exception cref="T:System.UnauthorizedAccessException">Code that is executing without administrative privileges attempted to read a performance counter.</exception>
  902. </member>
  903. <member name="T:System.Diagnostics.PerformanceCounterCategoryType">
  904. <summary>Indicates whether the performance counter category can have multiple instances.</summary>
  905. </member>
  906. <member name="F:System.Diagnostics.PerformanceCounterCategoryType.MultiInstance">
  907. <summary>The performance counter category can have multiple instances.</summary>
  908. </member>
  909. <member name="F:System.Diagnostics.PerformanceCounterCategoryType.SingleInstance">
  910. <summary>The performance counter category can have only a single instance.</summary>
  911. </member>
  912. <member name="F:System.Diagnostics.PerformanceCounterCategoryType.Unknown">
  913. <summary>The instance functionality for the performance counter category is unknown.</summary>
  914. </member>
  915. <member name="T:System.Diagnostics.PerformanceCounterInstanceLifetime">
  916. <summary>Specifies the lifetime of a performance counter instance.</summary>
  917. </member>
  918. <member name="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Global">
  919. <summary>Remove the performance counter instance when no counters are using the process category.</summary>
  920. </member>
  921. <member name="F:System.Diagnostics.PerformanceCounterInstanceLifetime.Process">
  922. <summary>Remove the performance counter instance when the process is closed.</summary>
  923. </member>
  924. <member name="T:System.Diagnostics.PerformanceCounterManager">
  925. <summary>Prepares performance data for the performance.dll the system loads when working with performance counters.</summary>
  926. </member>
  927. <member name="M:System.Diagnostics.PerformanceCounterManager.#ctor">
  928. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.PerformanceCounterManager" /> class.</summary>
  929. </member>
  930. <member name="M:System.Diagnostics.PerformanceCounterManager.System#Diagnostics#ICollectData#CloseData">
  931. <summary>Called by the perf dll's close performance data.</summary>
  932. </member>
  933. <member name="M:System.Diagnostics.PerformanceCounterManager.System#Diagnostics#ICollectData#CollectData(System.Int32,System.IntPtr,System.IntPtr,System.Int32,System.IntPtr@)">
  934. <summary>Performance data collection routine. Called by the PerfCount perf dll.</summary>
  935. <param name="callIdx">The call index.</param>
  936. <param name="valueNamePtr">A pointer to a Unicode string list with the requested Object identifiers.</param>
  937. <param name="dataPtr">A pointer to the data buffer.</param>
  938. <param name="totalBytes">A pointer to a number of bytes.</param>
  939. <param name="res">When this method returns, contains a <see cref="T:System.IntPtr" /> with a value of -1.</param>
  940. </member>
  941. <member name="T:System.Diagnostics.PerformanceCounterType">
  942. <summary>Specifies the formula used to calculate the <see cref="M:System.Diagnostics.PerformanceCounter.NextValue" /> method for a <see cref="T:System.Diagnostics.PerformanceCounter" /> instance.</summary>
  943. </member>
  944. <member name="F:System.Diagnostics.PerformanceCounterType.AverageBase">
  945. <summary>A base counter that is used in the calculation of time or count averages, such as <see langword="AverageTimer32" /> and <see langword="AverageCount64" />. Stores the denominator for calculating a counter to present "time per operation" or "count per operation".</summary>
  946. </member>
  947. <member name="F:System.Diagnostics.PerformanceCounterType.AverageCount64">
  948. <summary>An average counter that shows how many items are processed, on average, during an operation. Counters of this type display a ratio of the items processed to the number of operations completed. The ratio is calculated by comparing the number of items processed during the last interval to the number of operations completed during the last interval. Counters of this type include PhysicalDisk\ Avg. Disk Bytes/Transfer.</summary>
  949. </member>
  950. <member name="F:System.Diagnostics.PerformanceCounterType.AverageTimer32">
  951. <summary>An average counter that measures the time it takes, on average, to complete a process or operation. Counters of this type display a ratio of the total elapsed time of the sample interval to the number of processes or operations completed during that time. This counter type measures time in ticks of the system clock. Counters of this type include PhysicalDisk\ Avg. Disk sec/Transfer.</summary>
  952. </member>
  953. <member name="F:System.Diagnostics.PerformanceCounterType.CounterDelta32">
  954. <summary>A difference counter that shows the change in the measured attribute between the two most recent sample intervals.</summary>
  955. </member>
  956. <member name="F:System.Diagnostics.PerformanceCounterType.CounterDelta64">
  957. <summary>A difference counter that shows the change in the measured attribute between the two most recent sample intervals. It is the same as the <see langword="CounterDelta32" /> counter type except that is uses larger fields to accommodate larger values.</summary>
  958. </member>
  959. <member name="F:System.Diagnostics.PerformanceCounterType.CounterMultiBase">
  960. <summary>A base counter that indicates the number of items sampled. It is used as the denominator in the calculations to get an average among the items sampled when taking timings of multiple, but similar items. Used with <see langword="CounterMultiTimer" />, <see langword="CounterMultiTimerInverse" />, <see langword="CounterMultiTimer100Ns" />, and <see langword="CounterMultiTimer100NsInverse" />.</summary>
  961. </member>
  962. <member name="F:System.Diagnostics.PerformanceCounterType.CounterMultiTimer">
  963. <summary>A percentage counter that displays the active time of one or more components as a percentage of the total time of the sample interval. Because the numerator records the active time of components operating simultaneously, the resulting percentage can exceed 100 percent. This counter type differs from <see langword="CounterMultiTimer100Ns" /> in that it measures time in units of ticks of the system performance timer, rather than in 100 nanosecond units. This counter type is a multitimer.</summary>
  964. </member>
  965. <member name="F:System.Diagnostics.PerformanceCounterType.CounterMultiTimer100Ns">
  966. <summary>A percentage counter that shows the active time of one or more components as a percentage of the total time of the sample interval. It measures time in 100 nanosecond (ns) units. This counter type is a multitimer.</summary>
  967. </member>
  968. <member name="F:System.Diagnostics.PerformanceCounterType.CounterMultiTimer100NsInverse">
  969. <summary>A percentage counter that shows the active time of one or more components as a percentage of the total time of the sample interval. Counters of this type measure time in 100 nanosecond (ns) units. They derive the active time by measuring the time that the components were not active and subtracting the result from multiplying 100 percent by the number of objects monitored. This counter type is an inverse multitimer.</summary>
  970. </member>
  971. <member name="F:System.Diagnostics.PerformanceCounterType.CounterMultiTimerInverse">
  972. <summary>A percentage counter that shows the active time of one or more components as a percentage of the total time of the sample interval. It derives the active time by measuring the time that the components were not active and subtracting the result from 100 percent by the number of objects monitored. This counter type is an inverse multitimer. It differs from CounterMultiTimer100NsInverse in that it measures time in units of ticks of the system performance timer, rather than in 100 nanosecond units.</summary>
  973. </member>
  974. <member name="F:System.Diagnostics.PerformanceCounterType.CounterTimer">
  975. <summary>A percentage counter that shows the average time that a component is active as a percentage of the total sample time.</summary>
  976. </member>
  977. <member name="F:System.Diagnostics.PerformanceCounterType.CounterTimerInverse">
  978. <summary>A percentage counter that displays the average percentage of active time observed during sample interval. The value of these counters is calculated by monitoring the percentage of time that the service was inactive and then subtracting that value from 100 percent. This is an inverse counter type. It is the same as CounterTimer100NsInv, except that it measures time in units of ticks of the system performance timer rather than in 100 nanosecond units.</summary>
  979. </member>
  980. <member name="F:System.Diagnostics.PerformanceCounterType.CountPerTimeInterval32">
  981. <summary>An average counter designed to monitor the average length of a queue to a resource over time. It shows the difference between the queue lengths observed during the last two sample intervals divided by the duration of the interval. This type of counter is typically used to track the number of items that are queued or waiting.</summary>
  982. </member>
  983. <member name="F:System.Diagnostics.PerformanceCounterType.CountPerTimeInterval64">
  984. <summary>An average counter that monitors the average length of a queue to a resource over time. Counters of this type display the difference between the queue lengths observed during the last two sample intervals, divided by the duration of the interval. This counter type is the same as <see langword="CountPerTimeInterval32" /> except that it uses larger fields to accommodate larger values. This type of counter is typically used to track a high-volume or very large number of items that are queued or waiting.</summary>
  985. </member>
  986. <member name="F:System.Diagnostics.PerformanceCounterType.ElapsedTime">
  987. <summary>A difference timer that shows the total time between when the component or process started and the time when this value is calculated. Counters of this type include System\ System Up Time.</summary>
  988. </member>
  989. <member name="F:System.Diagnostics.PerformanceCounterType.NumberOfItems32">
  990. <summary>An instantaneous counter that shows the most recently observed value. Used, for example, to maintain a simple count of items or operations. Counters of this type include Memory\Available Bytes.</summary>
  991. </member>
  992. <member name="F:System.Diagnostics.PerformanceCounterType.NumberOfItems64">
  993. <summary>An instantaneous counter that shows the most recently observed value. Used, for example, to maintain a simple count of a very large number of items or operations. It is the same as <see langword="NumberOfItems32" /> except that it uses larger fields to accommodate larger values.</summary>
  994. </member>
  995. <member name="F:System.Diagnostics.PerformanceCounterType.NumberOfItemsHEX32">
  996. <summary>An instantaneous counter that shows the most recently observed value in hexadecimal format. Used, for example, to maintain a simple count of items or operations.</summary>
  997. </member>
  998. <member name="F:System.Diagnostics.PerformanceCounterType.NumberOfItemsHEX64">
  999. <summary>An instantaneous counter that shows the most recently observed value. Used, for example, to maintain a simple count of a very large number of items or operations. It is the same as <see langword="NumberOfItemsHEX32" /> except that it uses larger fields to accommodate larger values.</summary>
  1000. </member>
  1001. <member name="F:System.Diagnostics.PerformanceCounterType.RateOfCountsPerSecond32">
  1002. <summary>A difference counter that shows the average number of operations completed during each second of the sample interval. Counters of this type measure time in ticks of the system clock. Counters of this type include System\ File Read Operations/sec.</summary>
  1003. </member>
  1004. <member name="F:System.Diagnostics.PerformanceCounterType.RateOfCountsPerSecond64">
  1005. <summary>A difference counter that shows the average number of operations completed during each second of the sample interval. Counters of this type measure time in ticks of the system clock. This counter type is the same as the <see langword="RateOfCountsPerSecond32" /> type, but it uses larger fields to accommodate larger values to track a high-volume number of items or operations per second, such as a byte-transmission rate. Counters of this type include System\ File Read Bytes/sec.</summary>
  1006. </member>
  1007. <member name="F:System.Diagnostics.PerformanceCounterType.RawBase">
  1008. <summary>A base counter that stores the denominator of a counter that presents a general arithmetic fraction. Check that this value is greater than zero before using it as the denominator in a <see langword="RawFraction" /> value calculation.</summary>
  1009. </member>
  1010. <member name="F:System.Diagnostics.PerformanceCounterType.RawFraction">
  1011. <summary>An instantaneous percentage counter that shows the ratio of a subset to its set as a percentage. For example, it compares the number of bytes in use on a disk to the total number of bytes on the disk. Counters of this type display the current percentage only, not an average over time. Counters of this type include Paging File\% Usage Peak.</summary>
  1012. </member>
  1013. <member name="F:System.Diagnostics.PerformanceCounterType.SampleBase">
  1014. <summary>A base counter that stores the number of sampling interrupts taken and is used as a denominator in the sampling fraction. The sampling fraction is the number of samples that were 1 (or <see langword="true" />) for a sample interrupt. Check that this value is greater than zero before using it as the denominator in a calculation of <see langword="SampleFraction" />.</summary>
  1015. </member>
  1016. <member name="F:System.Diagnostics.PerformanceCounterType.SampleCounter">
  1017. <summary>An average counter that shows the average number of operations completed in one second. When a counter of this type samples the data, each sampling interrupt returns one or zero. The counter data is the number of ones that were sampled. It measures time in units of ticks of the system performance timer.</summary>
  1018. </member>
  1019. <member name="F:System.Diagnostics.PerformanceCounterType.SampleFraction">
  1020. <summary>A percentage counter that shows the average ratio of hits to all operations during the last two sample intervals. Counters of this type include Cache\Pin Read Hits %.</summary>
  1021. </member>
  1022. <member name="F:System.Diagnostics.PerformanceCounterType.Timer100Ns">
  1023. <summary>A percentage counter that shows the active time of a component as a percentage of the total elapsed time of the sample interval. It measures time in units of 100 nanoseconds (ns). Counters of this type are designed to measure the activity of one component at a time. Counters of this type include Processor\ % User Time.</summary>
  1024. </member>
  1025. <member name="F:System.Diagnostics.PerformanceCounterType.Timer100NsInverse">
  1026. <summary>A percentage counter that shows the average percentage of active time observed during the sample interval. This is an inverse counter. Counters of this type include Processor\ % Processor Time.</summary>
  1027. </member>
  1028. <member name="T:System.Diagnostics.PerformanceData.CounterData">
  1029. <summary>Contains the raw data for a counter.</summary>
  1030. </member>
  1031. <member name="M:System.Diagnostics.PerformanceData.CounterData.Decrement">
  1032. <summary>Decrements the counter value by 1.</summary>
  1033. </member>
  1034. <member name="M:System.Diagnostics.PerformanceData.CounterData.Increment">
  1035. <summary>Increments the counter value by 1.</summary>
  1036. </member>
  1037. <member name="M:System.Diagnostics.PerformanceData.CounterData.IncrementBy(System.Int64)">
  1038. <summary>Increments the counter value by the specified amount.</summary>
  1039. <param name="value">The amount by which to increment the counter value. The increment value can be positive or negative.</param>
  1040. </member>
  1041. <member name="P:System.Diagnostics.PerformanceData.CounterData.RawValue">
  1042. <summary>Sets or gets the raw counter data.</summary>
  1043. <returns>The raw counter data.</returns>
  1044. </member>
  1045. <member name="P:System.Diagnostics.PerformanceData.CounterData.Value">
  1046. <summary>Sets or gets the counter data.</summary>
  1047. <returns>The counter data.</returns>
  1048. </member>
  1049. <member name="T:System.Diagnostics.PerformanceData.CounterSet">
  1050. <summary>Defines a set of logical counters.</summary>
  1051. </member>
  1052. <member name="M:System.Diagnostics.PerformanceData.CounterSet.#ctor(System.Guid,System.Guid,System.Diagnostics.PerformanceData.CounterSetInstanceType)">
  1053. <summary>Initializes a new instance of the <see cref="T:System.Diagnostics.PerformanceData.CounterSet" /> class.</summary>
  1054. <param name="providerGuid">Guid that uniquely identifies the provider of the counter data. Use the Guid specified in the manifest.</param>
  1055. <param name="counterSetGuid">Guid that uniquely identifies the counter set for a provider. Use the Guid specified in the manifest.</param>
  1056. <param name="instanceType">Identifies the type of the counter set, for example, whether the counter set is a single or multiple instance counter set.</param>
  1057. <exception cref="T:System.InsufficientMemoryException">Not enough memory is available to complete the operation.</exception>
  1058. <exception cref="T:System.PlatformNotSupportedException">Not supported prior to Windows Vista.</exception>
  1059. <exception cref="T:System.ArgumentException">One of the parameters is NULL or not valid.</exception>
  1060. <exception cref="T:System.ComponentModel.Win32Exception">An underlying Win32 function call failed.</exception>
  1061. </member>
  1062. <member name="M:System.Diagnostics.PerformanceData.CounterSet.AddCounter(System.Int32,System.Diagnostics.PerformanceData.CounterType)">
  1063. <summary>Adds a counter to the counter set by using the specified counter identifier and type.</summary>
  1064. <param name="counterId">Identifies the counter. Use the same value that you used in the manifest to define the counter.</param>
  1065. <param name="counterType">Identifies the counter type. The counter type determines how the counter data is calculated, averaged, and displayed.</param>
  1066. <exception cref="T:System.ArgumentException">The counter identifier already exists in the set or is negative, or the counter type is NULL or not valid.</exception>
  1067. <exception cref="T:System.InvalidOperationException">You cannot add counters to the counter set after creating an instance of the counter set.</exception>
  1068. </member>
  1069. <member name="M:System.Diagnostics.PerformanceData.CounterSet.AddCounter(System.Int32,System.Diagnostics.PerformanceData.CounterType,System.String)">
  1070. <summary>Adds a counter to the counter set by using the specified counter identifier and type and a display name for the counter.</summary>
  1071. <param name="counterId">Identifies the counter. Use the same value that you used in the manifest to define the counter.</param>
  1072. <param name="counterType">Identifies the counter type. The counter type determines how the counter data is calculated, averaged, and displayed.</param>
  1073. <param name="counterName">Name of the counter. You can use this name to index the counter in the counter set instance. (See <see cref="P:System.Diagnostics.PerformanceData.CounterSetInstanceCounterDataSet.Item(System.String)" />.)</param>
  1074. <exception cref="T:System.ArgumentException">The counter identifier already exists in the set or is negative, or the counter type is NULL or not valid.</exception>
  1075. <exception cref="T:System.InvalidOperationException">You cannot add counters to the counter set after creating an instance of the counter set.</exception>
  1076. </member>
  1077. <member name="M:System.Diagnostics.PerformanceData.CounterSet.CreateCounterSetInstance(System.String)">
  1078. <summary>Creates an instance of the counter set.</summary>
  1079. <param name="instanceName">Name of the instance. The name must be unique.</param>
  1080. <returns>An instance of the counter set which will contain the counter data.</returns>
  1081. <exception cref="T:System.ArgumentException">The instance name is NULL.</exception>
  1082. <exception cref="T:System.InvalidOperationException">You must add counters to the counter set before creating an instance of the counter set.</exception>
  1083. </member>
  1084. <member name="M:System.Diagnostics.PerformanceData.CounterSet.Dispose">
  1085. <summary>Releases all unmanaged resources used by this object.</summary>
  1086. </member>
  1087. <member name="M:System.Diagnostics.PerformanceData.CounterSet.Dispose(System.Boolean)">
  1088. <summary>Releases all unmanaged resources used by this object and optionally release the managed resources.</summary>
  1089. <param name="disposing">
  1090. <see langword="True" /> if this was called from the Dispose method, <see langword="False" /> if called from the finalizer.</param>
  1091. </member>
  1092. <member name="M:System.Diagnostics.PerformanceData.CounterSet.Finalize">
  1093. <summary>Frees resources before the object is reclaimed by garbage collection.</summary>
  1094. </member>
  1095. <member name="T:System.Diagnostics.PerformanceData.CounterSetInstance">
  1096. <summary>Creates an instance of the logical counters defined in the <see cref="T:System.Diagnostics.PerformanceData.CounterSet" /> class.</summary>
  1097. </member>
  1098. <member name="P:System.Diagnostics.PerformanceData.CounterSetInstance.Counters">
  1099. <summary>Retrieves the collection of counter data for the counter set instance.</summary>
  1100. <returns>A collection of the counter data contained in the counter set instance.</returns>
  1101. </member>
  1102. <member name="M:System.Diagnostics.PerformanceData.CounterSetInstance.Dispose">
  1103. <summary>Releases all unmanaged resources used by this object.</summary>
  1104. </member>
  1105. <member name="M:System.Diagnostics.PerformanceData.CounterSetInstance.Finalize">
  1106. <summary>Releases unmanaged resources and performs other cleanup operations.</summary>
  1107. </member>
  1108. <member name="T:System.Diagnostics.PerformanceData.CounterSetInstanceCounterDataSet">
  1109. <summary>Contains the collection of counter values.</summary>
  1110. </member>
  1111. <member name="M:System.Diagnostics.PerformanceData.CounterSetInstanceCounterDataSet.Dispose">
  1112. <summary>Releases all unmanaged resources used by this object.</summary>
  1113. </member>
  1114. <member name="M:System.Diagnostics.PerformanceData.CounterSetInstanceCounterDataSet.Finalize">
  1115. <summary>Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</summary>
  1116. </member>
  1117. <member name="P:System.Diagnostics.PerformanceData.CounterSetInstanceCounterDataSet.Item(System.Int32)">
  1118. <summary>Accesses a counter value in the collection by using the specified counter identifier.</summary>
  1119. <param name="counterId">Identifier of the counter. This is the identifier you used when you added the counter to the counter set.</param>
  1120. <returns>The counter data.</returns>
  1121. </member>
  1122. <member name="P:System.Diagnostics.PerformanceData.CounterSetInstanceCounterDataSet.Item(System.String)">
  1123. <summary>Accesses a counter value in the collection by using the specified counter name.</summary>
  1124. <param name="counterName">Name of the counter. This is the name that you used when you added the counter to the counter set.</param>
  1125. <returns>The counter data.</returns>
  1126. </member>
  1127. <member name="T:System.Diagnostics.PerformanceData.CounterSetInstanceType">
  1128. <summary>Specifies whether the counter set allows multiple instances such as processes and physical disks, or a single instance such as memory.</summary>
  1129. </member>
  1130. <member name="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.GlobalAggregate">
  1131. <summary>The counter set contains single instance counters whose aggregate value is obtained from one or more sources. For example, a counter in this type of counter set might obtain the number of reads from each of the three hard disks on the computer and sum their values.</summary>
  1132. </member>
  1133. <member name="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.GlobalAggregateWithHistory">
  1134. <summary>This type is similar to <see cref="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.GlobalAggregate" /> except that this counter set type stores all counter values for the lifetime of the consumer application (the counter value is cached beyond the lifetime of the counter). For example, if one of the hard disks in the global aggregate example were to become unavailable, the total bytes read by that disk would still be available and used to calculate the aggregate value.</summary>
  1135. </member>
  1136. <member name="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.InstanceAggregate">
  1137. <summary>This type is similar to <see cref="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.MultipleAggregate" />, except that instead of aggregating all instance data to one aggregated (_Total) instance, it will aggregate counter data from instances of the same name. For example, if multiple provider processes contained instances named IExplore, <see cref="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.Multiple" /> and <see cref="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.MultipleAggregate" /> CounterSet will show multiple IExplore instances (IExplore, IExplore#1, IExplore#2, and so on); however, a <see cref="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.InstanceAggregate" /> instance type will publish only one IExplore instance with aggregated counter data from all instances named IExplore.</summary>
  1138. </member>
  1139. <member name="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.Multiple">
  1140. <summary>The counter set contains multiple instance counters, for example, a counter that measures the average disk I/O for a process.</summary>
  1141. </member>
  1142. <member name="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.MultipleAggregate">
  1143. <summary>The counter set contains multiple instance counters whose aggregate value is obtained from all instances of the counter. For example, a counter in this type of counter set might obtain the total thread execution time for all threads in a multithreaded application and sum their values.</summary>
  1144. </member>
  1145. <member name="F:System.Diagnostics.PerformanceData.CounterSetInstanceType.Single">
  1146. <summary>The counter set contains single instance counters, for example, a counter that measures physical memory.</summary>
  1147. </member>
  1148. <member name="T:System.Diagnostics.PerformanceData.CounterType">
  1149. <summary>Defines the possible types of counters. Each counter is assigned a counter type. The counter type determines how the counter data is calculated, averaged, and displayed.</summary>
  1150. </member>
  1151. <member name="F:System.Diagnostics.PerformanceData.CounterType.AverageBase">
  1152. <summary>This counter is used as the base data (denominator) in the computation of time or count averages for the <see cref="F:System.Diagnostics.PerformanceData.CounterType.AverageCount64" /> and <see cref="F:System.Diagnostics.PerformanceData.CounterType.AverageTimer32" /> counter types. This counter type collects the last observed value only. (See the PERF_AVERAGE_BASE counter type in the deployment kit.)</summary>
  1153. </member>
  1154. <member name="F:System.Diagnostics.PerformanceData.CounterType.AverageCount64">
  1155. <summary>This counter type shows how many items are processed, on average, during an operation. Counters of this type display a ratio of the items processed (such as bytes sent) to the number of operations completed. The ratio is calculated by comparing the number of items processed during the last interval to the number of operations completed during the last interval. (See the PERF_AVERAGE_BULK counter type in the deployment kit.)</summary>
  1156. </member>
  1157. <member name="F:System.Diagnostics.PerformanceData.CounterType.AverageTimer32">
  1158. <summary>This counter type measures the average time it takes to complete a process or operation. Counters of this type display a ratio of the total elapsed time of the sample interval to the number of processes or operations completed during that time. This counter type measures time in ticks of the system clock. (See the PERF_AVERAGE_TIMER counter type in the deployment kit.)</summary>
  1159. </member>
  1160. <member name="F:System.Diagnostics.PerformanceData.CounterType.Delta32">
  1161. <summary>This counter type shows the change in the measured attribute between the two most recent sample intervals. (See the PERF_COUNTER_DELTA counter type in the deployment kit.)</summary>
  1162. </member>
  1163. <member name="F:System.Diagnostics.PerformanceData.CounterType.Delta64">
  1164. <summary>This counter type shows the change in the measured attribute between the two most recent sample intervals. It is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.Delta32" /> counter type, except that it uses larger fields to accommodate larger values. (See the PERF_COUNTER_LARGE_DELTA counter type in the deployment kit.)</summary>
  1165. </member>
  1166. <member name="F:System.Diagnostics.PerformanceData.CounterType.ElapsedTime">
  1167. <summary>This counter type shows the total time between when the component or process started and the time when this value is calculated. (See the PERF_ELAPSED_TIME counter type in the deployment kit.)</summary>
  1168. </member>
  1169. <member name="F:System.Diagnostics.PerformanceData.CounterType.LargeQueueLength">
  1170. <summary>This counter type monitors the average length of a queue to a resource over time. Counters of this type display the difference between the queue lengths observed during the last two sample intervals, divided by the duration of the interval. This counter type is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.QueueLength" /> counter type, except that it uses larger fields to accommodate larger values. (See the PERF_COUNTER_LARGE_QUEUELEN_TYPE counter type in the deployment kit.)</summary>
  1171. </member>
  1172. <member name="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerBase">
  1173. <summary>Indicates the number of items sampled. It is used as the denominator in the calculations to get an average among the items sampled when taking timings of multiple, but similar, items. This type supports the following counter types: <see cref="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageActive" />, <see cref="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageNotActive" />, <see cref="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageActive100Ns" />, and <see cref="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageNotActive100Ns" />.</summary>
  1174. </member>
  1175. <member name="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageActive">
  1176. <summary>This counter type is a multitimer. Multitimers collect data from more than one instance of a component, such as a processor or disk. Counters of this type display the active time of one or more components as a percentage of the total time of the sample interval. Because the numerator records the active time of components operating simultaneously, the resulting percentage can exceed 100 percent. This counter type differs from <see cref="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageActive100Ns" /> in that it measures time in units of ticks of the system performance timer, rather than in 100 nanosecond units. (See the PERF_COUNTER_MULTI_TIMER counter type in the deployment kit.)</summary>
  1177. </member>
  1178. <member name="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageActive100Ns">
  1179. <summary>This counter type shows the active time of one or more components as a percentage of the total time of the sample interval. It measures time in 100 nanosecond units. This counter type is a multitimer. Multitimers are designed to monitor more than one instance of a component, such as a processor or disk. (See the PERF_100NSEC_MULTI_TIMER counter type in the deployment kit.)</summary>
  1180. </member>
  1181. <member name="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageNotActive">
  1182. <summary>This counter type shows the active time of one or more components as a percentage of the total time of the sample interval. This counter type is an inverse multitimer. Multitimers monitor more than one instance of a component, such as a processor or disk. Inverse counters measure the time that a component is not active and derive the active time from that measurement. This counter differs from <see cref="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageNotActive100Ns" /> in that it measures time in units of ticks of the system performance timer, rather than in 100 nanosecond units. (See the PERF_COUNTER_MULTI_TIMER_INV counter type in the deployment kit.)</summary>
  1183. </member>
  1184. <member name="F:System.Diagnostics.PerformanceData.CounterType.MultiTimerPercentageNotActive100Ns">
  1185. <summary>This counter type shows the active time of one or more components as a percentage of the total time of the sample interval. Counters of this type measure time in 100 nanosecond units. This counter type is an inverse multitimer. Multitimers are designed to monitor more than one instance of a component, such as a processor or disk. Inverse counters measure the time that a component is not active and derive its active time from the measurement of inactive time. (See the PERF_100NSEC_MULTI_TIMER_INV counter type in the deployment kit.)</summary>
  1186. </member>
  1187. <member name="F:System.Diagnostics.PerformanceData.CounterType.ObjectSpecificTimer">
  1188. <summary>This 64-bit counter type is a timer that displays in object-specific units. (See the PERF_OBJ_TIME_TIMER counter type in the deployment kit.)</summary>
  1189. </member>
  1190. <member name="F:System.Diagnostics.PerformanceData.CounterType.PercentageActive">
  1191. <summary>This counter type shows the average time that a component was active as a percentage of the total sample time. (See the PERF_COUNTER_TIMER counter type in the deployment kit.)</summary>
  1192. </member>
  1193. <member name="F:System.Diagnostics.PerformanceData.CounterType.PercentageActive100Ns">
  1194. <summary>This counter type shows the active time of a component as a percentage of the total elapsed time of the sample interval. It measures time in units of 100 nanoseconds. Counters of this type are designed to measure the activity of one component at a time. (See the PERF_100NSEC_TIMER counter type in the deployment kit.)</summary>
  1195. </member>
  1196. <member name="F:System.Diagnostics.PerformanceData.CounterType.PercentageNotActive">
  1197. <summary>This is an inverse counter type. Inverse counters measure the time that a component is not active and derive the active time from that measurement. Counters of this type display the average percentage of active time observed during sample interval. The value of these counters is calculated by monitoring the percentage of time that the service was inactive and then subtracting that value from 100 percent. This counter type is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.PercentageNotActive100Ns" /> counter type, except that it measures time in units of ticks of the system performance timer, rather than in 100 nanosecond units. (See the PERF_COUNTER_TIMER_INV counter type in the deployment kit.)</summary>
  1198. </member>
  1199. <member name="F:System.Diagnostics.PerformanceData.CounterType.PercentageNotActive100Ns">
  1200. <summary>This counter type shows the average percentage of active time observed during the sample interval. This is an inverse counter. Inverse counters are calculated by monitoring the percentage of time that the service was inactive and then subtracting that value from 100 percent. (See the PERF_100NSEC_TIMER_INV counter type in the deployment kit.)</summary>
  1201. </member>
  1202. <member name="F:System.Diagnostics.PerformanceData.CounterType.PrecisionObjectSpecificTimer">
  1203. <summary>This counter type shows a value that consists of two counter values: the count of the elapsed time of the event being monitored, and the frequency specified in the PerfFreq field of the object header. This counter type differs from other counter timers in that the clock tick value accompanies the counter value so as to eliminate any possible difference due to latency from the function call. Precision counter types are used when standard system timers are not precise enough for accurate readings. (See the PERF_PRECISION_OBJECT_TIMER counter type in the deployment kit.)</summary>
  1204. </member>
  1205. <member name="F:System.Diagnostics.PerformanceData.CounterType.PrecisionSystemTimer">
  1206. <summary>This counter type shows a value that consists of two counter values: the count of the elapsed time of the event being monitored, and the frequency from the system performance timer. This counter type differs from other counter timers in that the clock tick value accompanies the counter value, eliminating any possible difference due to latency from the function call. Precision counter types are used when standard system timers are not precise enough for accurate readings. (See the PERF_PRECISION_TIMER counter type in the deployment kit.)</summary>
  1207. </member>
  1208. <member name="F:System.Diagnostics.PerformanceData.CounterType.PrecisionTimer100Ns">
  1209. <summary>This counter type shows a value that consists of two counter values: the count of the elapsed time of the event being monitored, and the "clock" time from a private timer in the same units. It measures time in 100 nanosecond units. This counter type differs from other counter timers in that the clock tick value accompanies the counter value eliminating any possible difference due to latency from the function call. Precision counter types are used when standard system timers are not precise enough for accurate readings. (See the PERF_PRECISION_100NS_TIMER counter type in the deployment kit.)</summary>
  1210. </member>
  1211. <member name="F:System.Diagnostics.PerformanceData.CounterType.QueueLength">
  1212. <summary>This counter type is designed to monitor the average length of a queue to a resource over time. It shows the difference between the queue lengths observed during the last two sample intervals divided by the duration of the interval. (See the PERF_COUNTER_QUEUELEN_TYPE counter type in the deployment kit.)</summary>
  1213. </member>
  1214. <member name="F:System.Diagnostics.PerformanceData.CounterType.QueueLength100Ns">
  1215. <summary>This counter type measures the queue-length space-time product using a 100-nanosecond time base. (See the PERF_COUNTER_100NS_QUEUELEN_TYPE counter type in the deployment kit.)</summary>
  1216. </member>
  1217. <member name="F:System.Diagnostics.PerformanceData.CounterType.QueueLengthObjectTime">
  1218. <summary>This counter type measures the queue-length space-time product using an object-specific time base. (See the PERF_COUNTER_OBJ_QUEUELEN_TYPE counter type in the deployment kit.)</summary>
  1219. </member>
  1220. <member name="F:System.Diagnostics.PerformanceData.CounterType.RateOfCountPerSecond32">
  1221. <summary>This counter type shows the average number of operations completed during each second of the sample interval. Counters of this type measure time in ticks of the system clock. (See the PERF_COUNTER_COUNTER counter type in the deployment kit.)</summary>
  1222. </member>
  1223. <member name="F:System.Diagnostics.PerformanceData.CounterType.RateOfCountPerSecond64">
  1224. <summary>This counter type shows the average number of operations completed during each second of the sample interval. Counters of this type measure time in ticks of the system clock. This counter type is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RateOfCountPerSecond32" /> type, but it uses larger fields to accommodate larger values. (See the PERF_COUNTER_BULK_COUNT counter type in the deployment kit.)</summary>
  1225. </member>
  1226. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawBase32">
  1227. <summary>This counter type collects the last observed value only. The value is used as the denominator of a counter that presents a general arithmetic fraction. This type supports the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RawFraction32" /> counter type. (See the PERF_RAW_BASE counter type in the deployment kit.)</summary>
  1228. </member>
  1229. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawBase64">
  1230. <summary>This counter type collects the last observed value. It is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RawBase32" /> counter type except that it uses larger fields to accommodate larger values. This type supports the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RawFraction64" /> counter type. (See the PERF_LARGE_RAW_BASE counter type in the deployment kit.)</summary>
  1231. </member>
  1232. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawData32">
  1233. <summary>This counter type shows the last observed value only. It does not display an average. (See the PERF_COUNTER_RAWCOUNT counter type in the deployment kit.)</summary>
  1234. </member>
  1235. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawData64">
  1236. <summary>This counter type shows the last observed value only, not an average. It is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RawData32" /> counter type, except that it uses larger fields to accommodate larger values. (See the PERF_COUNTER_LARGE_RAWCOUNT counter type in the deployment kit.)</summary>
  1237. </member>
  1238. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawDataHex32">
  1239. <summary>This counter type shows the most recently observed value, in hexadecimal format. It does not display an average. (See the PERF_COUNTER_RAWCOUNT_HEX counter type in the deployment kit.)</summary>
  1240. </member>
  1241. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawDataHex64">
  1242. <summary>This counter type shows the last observed value, in hexadecimal format. It is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RawDataHex32" /> counter type, except that it uses larger fields to accommodate larger values. (See the PERF_COUNTER_LARGE_RAWCOUNT_HEX counter type in the deployment kit.)</summary>
  1243. </member>
  1244. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawFraction32">
  1245. <summary>This counter type shows the ratio of a subset to its set as a percentage. For example, it compares the number of bytes in use on a disk to the total number of bytes on the disk. Counters of this type display the current percentage only, not an average over time. (See the PERF_RAW_FRACTION counter type in the deployment kit.)</summary>
  1246. </member>
  1247. <member name="F:System.Diagnostics.PerformanceData.CounterType.RawFraction64">
  1248. <summary>This counter type shows the ratio of a subset to its set as a percentage. For example, it compares the number of bytes in use on a disk to the total number of bytes on the disk. Counters of this type display the current percentage only, not an average over time. It is the same as the <see cref="F:System.Diagnostics.PerformanceData.CounterType.RawFraction32" /> counter type, except that it uses larger fields to accommodate larger values.</summary>
  1249. </member>
  1250. <member name="F:System.Diagnostics.PerformanceData.CounterType.SampleBase">
  1251. <summary>This counter stores the number of sampling interrupts taken and is used as a denominator in the sampling fraction. This type supports the <see cref="F:System.Diagnostics.PerformanceData.CounterType.SampleFraction" /> counter type.</summary>
  1252. </member>
  1253. <member name="F:System.Diagnostics.PerformanceData.CounterType.SampleCounter">
  1254. <summary>This counter type shows the average number of operations completed in one second. It measures time in units of ticks of the system performance timer. The variable F represents the number of ticks that occur in one second. The value of F is factored into the equation so that the result is displayed in seconds. (See the PERF_SAMPLE_COUNTER counter type in the deployment kit.)</summary>
  1255. </member>
  1256. <member name="F:System.Diagnostics.PerformanceData.CounterType.SampleFraction">
  1257. <summary>This counter type shows the average ratio of hits to all operations during the last two sample intervals. (See the PERF_SAMPLE_FRACTION counter type in the deployment kit.)</summary>
  1258. </member>
  1259. </members>
  1260. </doc>