SetValue(EventMetricValueDefinition,Object) Method

In This Topic

Records a value to the values array of this sample given its value definition.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub SetValue( _
   ByVal valueDefinition As EventMetricValueDefinition, _
   ByVal value As Object _
)

public void SetValue( 
   EventMetricValueDefinition valueDefinition,
   object value
)

Parameters

valueDefinition: The metric value definition object of the value to be recorded.
value: Optional. The value to be recorded.

Exceptions

Exception	Description
System.ArgumentNullException	Throw if the valueDefinition is null.

Remarks

The value must be defined as part of the event metric definition associated with this sample or an exception will be thrown. The data type must also be compatible with the data type configured on the event metric definition or no data will be recorded. If called more than once for the same value, the prior value will be replaced.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

EventMetricSample Class
EventMetricSample Members
Overload List

Send Feedback