cbLogSetPreferences()

Sets preferences for returned time stamped data, analog temperature data, and CJC temperature data.

Function Prototype

C/C++

int cbLogSetPreferences(int TimeFormat, int TimeZone, int Units)

Visual Basic

Function cbLogSetPreferences(ByVal TimeFormat&, ByVal TimeZone&, ByVal Units&) As Long

Arguments

TimeFormat

Specifies the time format to apply when returning time stamped data (when using cbLogReadTimeTags() for example). Set to one of the TimeFormat constants. Choices are:

0 = TIMEFORMAT_12HOUR. For example 2:32:51PM (default).

1 = TIMEFORMAT_24HOUR. For example 14:32:51.

TimeZone

Specifies whether to convert time stamped data that is returned (when using cbLogReadTimeTags() for example) to the local time zone or to return the time stamps as they are stored in the file (in the GMT time zone). Set to one of the TimeZone constants. Choices are:

0 = TIMEZONE_LOCAL. Converts timestamp data to the local time zone on your computer (default).

1 = TIMEZONE_GMT. Leaves time stamped data in Greenwich Mean Time.

Units

Specifies whether to convert temperature data returned (when using cbLogReadAIChannels() for example) to Fahrenheit or Kelvin, or return temperature data as they are stored in the file (in Celsius units).

Set to one of the Units constants. Choices are:

0 = FAHRENHEIT (default)

1 = CELSIUS

2 = KELVIN

This value is ignored if raw data is logged.

Returns

• Error code or 0 if no errors

Notes

• The TimeFormat and TimeZone preferences are applied to all time data returned using API functions that return time data.
• The units preference specifies the temperature scale that the API applies when reading and converting analog temperature and CJC data.