| Platform SDK: Performance Monitoring |
The SystemMonitor interface provides the methods and functionality that correspond to most of the functionality provided by the System Monitor user interface.
SystemMonitorCtl.SystemMonitor
The Counters object is the default property of the SystemMonitor object.
The following are the methods provided by SystemMonitor.
| Method name | Description |
|---|---|
| BrowseCounters | Displays the Add Counter dialog box. |
| CollectSample | Samples a value from each counter in the Counters collection object. |
| Copy | Copies all of the current property settings to the Clipboard as an HTML object. |
| DisplayProperties | Displays the Graph Properties dialog box. |
| Paste | Pastes all of the counters currently in the Clipboard to the graph pane of the System Monitor. |
| Reset | Removes all CounterItem objects from the Counters collection object. |
| UpdateGraph | Refreshes the contents of the System Monitor windows. |
The following are the properties provided by SystemMonitor.
| Property name | Description |
|---|---|
| Appearance | Retrieves or sets the appearance of the control to include or omit three-dimensional display effects. |
| BackColor | Retrieves or sets the color of the graph, histogram, or report where the counter data values are displayed. |
| BackColorCtl | Retrieves or sets the background color of the area that surrounds the graph, histogram, or report. |
| BorderStyle | Retrieves or sets the border style of the control. |
| Counters | Retrieves the collection of CounterItem objects included in the Counters collection object for the specified control. |
| DisplayType | Retrieves or sets the view type (that is, line graph, histogram, or report) of the control. |
| Font | Retrieves or sets the font of the control. |
| ForeColor | Retrieves or sets the color of the text that appears in the System Monitor's interface—that is, legend column names, labels, and statistics. |
| GraphTitle | Retrieves or sets the title of the System Monitor's graph window, line graph, or histogram view. |
| GridColor | Retrieves or sets the color of the grid lines in the System Monitor's graph window, in the line graph or histogram view. |
| Highlight | Retrieves or sets a value indicating whether the values of a counter are highlighted in the System Monitor's graph window, in the line graph or histogram view. |
| LogFileName | Retrieves or sets the name of an existing log file to be used as the source of counter values to be displayed in the System Monitor. |
| LogViewStart | Retrieves or sets the starting date and time for logged counter value data displayed in the System Monitor. |
| LogViewEnd | Retrieves or sets the ending date and time for logged counter value data displayed in the System Monitor. |
| ManualUpdate | Retrieves or sets a value indicating whether the contents of the System Monitor will be updated manually, or automatically at specified intervals. |
| MaximumScale | Retrieves or sets the maximum value of the vertical (Y) axis of the System Monitor's line graph or histogram view. |
| MinimumScale | Retrieves or sets the minimum value of the vertical (Y) axis of the System Monitor's line graph or histogram view. |
| MonitorDuplicateInstances | Retrieves or sets a value that determines whether multiple instances of counters can be monitored. |
| ReadOnly | Retrieves or sets a value that determines whether a user can modify properties of a control. |
| ReportValueType | Retrieves or sets a value that determines the statistics to be displayed when Report View or Histogram View is active . |
| ShowHorizontalGrid | Retrieves or sets a value that determines whether horizontal lines are displayed. |
| ShowLegend | Retrieves or sets a value that determines whether the legend is displayed. |
| ShowScaleLabels | Retrieves or sets a value that determines whether the scale labels of the vertical axis of the System Monitor's graph window (in line graph or histogram view) is displayed. |
| ShowToolBar | Retrieves or sets a value that determines whether the toolbar is displayed. |
| ShowValueBar | Retrieves or sets a value that determines whether the value bar (the set of statistical values below the System Monitor's graph window) is displayed. |
| ShowVerticalGrid | Retrieves or sets a value that determines whether vertical lines are displayed in the System Monitor's line graph or histogram view. |
| TimeBarColor | Retrieves or sets the color of the time bar—that is, the vertical bar that moves across the System Monitor's graph window to indicate the passage of each sampling interval in the line graph view. |
| UpdateInterval | Retrieves or sets the length of the time interval for automatic collection of data displayed in the System Monitor. |
| YAxisLabel | Retrieves or sets the label of the vertical (Y) axis of the System Monitor's graph window, in line graph or histogram view. |
Windows NT/2000: Requires Windows 2000.
Header: Smonctrl.odl.
System Monitor Automation Interface Overview, System Monitor Automation Interface Classes