Next Topic

Previous Topic

Book Contents

StoreStatisticalData

bool StoreStatisticalData(int iRecordSet,float fData,float fThreshold,int iVirtualType,int iVirtualUnit,string Unit)

Return values

True if data was successfully stored to statistical database, false if there was an parameter error.

Parameters

  • iRecordSetIndex - A zero based index of the statistical channel to store data into. See remarks for valid constants.
  • fData - Floating point data sampled by the script.
  • fThreshold - Optional threshold value for the sample data, this value should be constant in all calls.
  • iVirtualType - Type of data stored.
  • iVirtualUnit - Selected unit of stored type. See remarks for valid combinations of types and units.
  • Unit - Optional string describing the unit of the data, this value should be constant in all calls. The string can be max 16 chars in length or the call will fail.

Remarks

This function is only available for advanced scripts. The difference between this function and the old function with the same name is the ability to store type information with the data.

iVirtualType and iVirtualUnit can be used in the following combinations:

VT_SWAP_UTILIZATION
VT_MEMORY_UTILIZATION
VT_DISK_UTILIZATION
VT_CPU_UTILIZATION
	UNIT_TYPE_PERCENT


VT_FREE_DISKSPACE 
	UNIT_TYPE_MEGABYTE 
	UNIT_TYPE_GIGABYTE 
	UNIT_TYPE_TERABYTE




VT_SQL_QUERY 
	UNIT_TYPE_NONE




VT_TEMPERATURE: 
	UNIT_TYPE_FAHRENHEIT 
	UNIT_TYPE_CELSIUS 
	UNIT_TYPE_KELVIN




VT_HUMIDITY 
	UNIT_TYPE_PERCENT




VT_WETNESS 
	UNIT_TYPE_NONE




VT_VOLTAGE 
	UNIT_TYPE_VOLT




VT_BANDWIDTH_UTILIZATION 
	UNIT_TYPE_PERCENT




VT_BANDWIDTH_USAGE 
	UNIT_TYPE_KBPS 
	UNIT_TYPE_MBPS 
	UNIT_TYPE_GBPS




VT_DIRECTORY_SIZE: 
	UNIT_TYPE_MEGABYTE 
	UNIT_TYPE_GIGABYTE 
	UNIT_TYPE_TERABYTE




VT_DIRECTORY_COUNT 
	UNIT_TYPE_NONE




VT_PING_ROUNDTRIP 
	UNIT_TYPE_MILLISECONDS 
	UNIT_TYPE_SECONDS




VT_PING_PACKETLOSS 
	UNIT_TYPE_PERCENT




VT_MAIL_ROUNDTRIP: 
	UNIT_TYPE_MILLISECONDS 
	UNIT_TYPE_SECONDS




VT_MEMORY_USAGE 
	UNIT_TYPE_MEGABYTE 
	UNIT_TYPE_GIGABYTE




VT_TRANSFER_SPEED 
	UNIT_TYPE_NONE




VT_HTTP_FETCHTIME 
	UNIT_TYPE_MILLISECONDS 
	UNIT_TYPE_SECONDS




VT_WMI_GENERIC_VALUE




VT_LUA_GENERIC_VALUE




VT_WINPERF_GENERIC_VALUE




VT_SSH2SCRIPT_GENERIC_VALUE




VT_SNMP_GENERIC_VALUE 
	UNIT_TYPE_NONE




VT_CURRENT 
	UNIT_TYPE_AMPERE




VT_FANSPEED 
	UNIT_TYPE_RPM




VT_LUMINOSITY 
	UNIT_TYPE_LUX


The record set index parameter can be one of the following constants.


LUA_RECORDSET_1


LUA_RECORDSET_2


LUA_RECORDSET_3


LUA_RECORDSET_4


LUA_RECORDSET_5


LUA_RECORDSET_6


LUA_RECORDSET_7


LUA_RECORDSET_8