GetPreferences()

Returns API preference settings for time stamp data, analog temperature data, and CJC temperature data. Returns the default values unless changed using SetPreferences().

Member of the DataLogger class.

Function Prototype

VB .NET

Public Shared Function GetPreferences(ByRef timeFormat As MccDaq.TimeFormat, ByRef timeZone As MccDaq.TimeZone, ByRef units As MccDaq.TempScale) As MccDaq.ErrorInfo

C# .NET

public MccDaq.ErrorInfo GetPreferences(ref MccDaq.TimeFormat timeFormat, ref MccDaq.TimeZone timeZone, ref MccDaq.TempScale units)

Parameter

timeFormat

Returns the format used to display time stamp data.

All of the timeFormat settings are MccDaq.TimeFormat enumerated constants. Choices are MccDaq.TimeFormat.TwelveHour (for example 2:32:51PM) and MccDaq.TimeFormat.TwentyFourHour (for example 14:32:51).

timeZone

Returns the time zone to store time stamp data.

All of the timeZone settings are MccDaq.TimeZone enumerated constants. Choices are MccDaq.TimeZone.Local and MccDaq.TimeZone.GMT.

units

Returns the unit to use for analog temperature data. This value is ignored if raw data values are logged.

All of the units settings are MccDaq.TempScale enumerated constants. Choices are MccDaq.TempScale.Celsius, MccDaq.TempScale.Fahrenheit, and MccDaq.TempScale.Kelvin.

Returns

• An ErrorInfo object that indicates the status of the operation.
• timeFormat – Returns the format to apply to time stamp data from API functions that return time data.
• timeZone – Returns the time zone to apply to time stamp data from API functions that return time data.
• units – Returns the unit to use when converting temperature data from API functions that return temperature data.