The System Manager APIs cover a wide range of topics, including features (the system feature constants are defined here), processor types, power management, ROM version and serial numbers, display brightness and contrast and system time intervals (the System Manager defines a number of macros useful for manipulating system time "ticks"). The reference material in this chapter is organized as follows:
System Manager Constants
System Manager Functions and Macros
The header file SystemMgr.h
declares the API that this chapter describes.
Additional information on the material covered in this chapter can be found in the conceptual chapters in the first part of this book. In particular, see Chapter 2, "Features," Chapter 9, "Power Management,"and Chapter 10, "The ROM Serial Number."
System Manager Constants
Power Manager Error Codes
Purpose
These error codes can be returned by various functions to indicate a lack of power.
Declared In
SystemMgr.h
Constants
-
#define pwrErrBacklight (pwrErrorClass | 1)
-
#define pwrErrBeam (pwrErrorClass | 3)
-
#define pwrErrGeneric (pwrErrorClass | 4)
-
#define pwrErrNone (pwrErrorClass | 0)
-
#define pwrErrRadio (pwrErrorClass | 2)
System Features
Purpose
Feature constants are defined by various parts of Palm OS to identify how the system works.
Declared In
SystemMgr.h
Constants
-
#define sysFtrDefaultBoldFont 13
- The
FontID
of the default font used for bold text as specified in the ROM's locale module. -
#define sysFtrDefaultFont 12
- The
FontID
of the default font for standard text, as defined in the ROM's locale module. -
#define sysFtrNumAccessorTrapPresent 25
-
#define sysFtrNumBacklight 3
- A nonzero value indicates that the device has a backlight.
-
#define sysFtrNumCharEncodingFlags68K 16
- One or more of the character encoding feature attributes (declared in
TextMgr.h
), which specify the attributes of the character encoding used on the device. For example, these constants specify if the device uses only single-byte characters or has double-byte characters as well. -
#define sysFtrNumCountry68K 5
- One of the country constants (defined in
PalmLocale.h
), identifying the default country as specified in the ROM's locale module. -
#define sysFtrNumDefaultCompression 23
- The default compression algorithm used for wireless networking. The Palm Web Clipping Application checks this feature. Note that the Palm Web Clipping Application is obsolete.
-
#define sysFtrNumDisableSortDuringSyncThreshold 33
- If this feature is not set, database sorting is always disabled during a HotSync operation on Palm OS Cobalt version 6.1 (or later). If this feature is set, and the value is zero, database sorting is enabled during a HotSync operation. If this feature is set and the value is greater than zero, sorting during HotSync is enabled up until a database with a number of rows greater than or equal to the value of this feature is encountered, at which point sorting is disabled. Sorting is then disabled from that point onwards.
- This feature can be set by licensees to optimize HotSync performance on their Palm Powered devices.
-
#define sysFtrNumDisplayDepth 7
- The device's default display depth. Supported depths are 1, 2, 4, 8, and 16 bits per pixel.
-
#define sysFtrNumDisplayUpdateMode 30
- Indicates how the display is updated. If this feature has a value of 0, or it is not defined, drawing occurs directly to the screen (which allows the screen to flicker). If it is set to 1, the display uses double buffering (page flipping) to eliminate flicker when drawing.
NOTE: Additional values may be defined in the future for other methods of eliminating flicker. Regardless, a value of 0 always means that drawing in update-based windows causes flickering.
-
#define sysFtrNumDmAutoBackup 31
- Indicates that the device has the Automatic Database Backup and Restore feature, which preserves device data even without a backup battery.
-
#define sysFtrNumEnableSortAfterSyncThreshold 34
- If this feature is not set, databases are not sorted when closed during a HotSync operation on Palm OS Cobalt version 6.1 (or later). If this feature is set, and the value of the feature is zero, during a HotSync operation any database that has not already been sorted is sorted when the database is closed. If this feature is set, and the value of the feature is greater than zero, during a HotSync operation any database that has not been sorted and that has a number of rows that equals or exceeds the value of this feature is sorted when the database is closed
- This feature can be set by licensees to optimize HotSync performance on their Palm Powered devices.
-
#define sysFtrNumEncoding68K 11
- One of the character encoding constants identifying the character encoding used on the device.
-
#define sysFtrNumEncryption 4
- One or more flags indicating which encryption schemes are present. The only currently supported encryption is DES, which can be tested for by ANDing the returned value with
sysFtrNumEncryptionMaskDES
. -
#define sysFtrNumFastBoot 29
- Enable fast minimal boot. When non-zero, various parts of the boot process are be shortened or completely skipped. This mode is only for development, to reduce the amount of waiting required each time a new build is tested.
-
#define sysFtrNumFiveWayNavVersion 32
-
#define sysFtrNumHwrMiscFlags 8
- One or more flags indicating hardware capabilities.
- This feature is not applicable on devices with ARM processors.
-
#define sysFtrNumHwrMiscFlagsExt 9
- One or more flags indicating additional hardware capabilities.
- This feature is not applicable on devices with ARM processors.
-
#define sysFtrNumInputAreaFlags 26
- Indicates the device-specific capabilities of the input area. See "Input Area Flags Constants" for the flags that make up this feature.
-
#define sysFtrNumLanguage68K 6
- One of the language constants (defined in
PalmLocale.h
) specifying the default language in the ROM's locale module. -
#define sysFtrNumNotifyMgrVersion 17
- The version number of the Notification Manager API.
-
#define sysFtrNumOEMCompanyID 20
- The 4-character company ID of the HAL manufacturer. The company ID is unique for each Palm OS licensee.
-
#define sysFtrNumOEMDeviceID 21
- The 4-character ID of the device on which Palm OS is running. There is roughly one device ID per model of device.
-
#define sysFtrNumOEMHALID 22
- The 4-character ID of the HAL on which Palm OS is running. Each HAL is specific to a device model and Palm OS version.
-
#define sysFtrNumOEMROMVersion 18
- A ROM system version provided by the Palm OS licensee. Used to identify patches provided by licensees.
-
#define sysFtrNumProcessorID 2
- The processor type and the processor revision.
-
#define sysFtrNumProductID sysFtrNumProcessorID
- The processor type and the processor revision.
-
#define sysFtrNumResetType 28
-
#define sysFtrNumROMBuildType 19
-
#define sysFtrNumROMVersion 1
- The ROM version. You can use the
sysMakeROMVersion()
macro to create a value to test against. -
#define sysFtrNumSkipCalibration 35
-
#define sysFtrNumTextMgrFlags 10
-
#define sysFtrNumUIHardwareFlags 27
-
#define sysFtrNumVendor 15
- Not used.
-
#define sysFtrNumWinVersion 24
- The version of the Window Manager.
Comments
You can obtain the values of these features with the FtrGet()
function:
err = FtrGet(sysFileCSystem, constant
, &value)
where constant
is one of the values listed above. If the feature is defined, value
is set by the FtrGet()
function. If the feature is not defined, value
is not set, and FtrGet()
returns sysErrNoSuchFeature
. Unless otherwise specified, you should consider these features to be read-only.
Processor Types
Purpose
Palm OS device processor types. Obtain a device's processor type by getting the value of the sysFtrNumProcessorID
feature. Use the the bit mask sysFtrNumProcessorMask
to extract the processor type from the values returned for these features.
Declared In
SystemMgr.h
Constants
-
#define sysFtrNumProcessor328 0x00010000
- Motorola 68328 (Dragonball).
-
#define sysFtrNumProcessorARM710A 0x00170000
- ARM710A.
-
#define sysFtrNumProcessorARM720T 0x00100000
- ARM 720T.
-
#define sysFtrNumProcessorARM7TDMI 0x00110000
- ARM7TDMI.
-
#define sysFtrNumProcessorARM920T 0x00120000
- ARM920T.
-
#define sysFtrNumProcessorARM922T 0x00130000
- ARM922T.
-
#define sysFtrNumProcessorARM925 0x00140000
- ARM925.
-
#define sysFtrNumProcessorEZ 0x00020000
- Motorola 68EZ328 (Dragonball EZ).
-
#define sysFtrNumProcessorStrongARM 0x00150000
- Strong ARM.
-
#define sysFtrNumProcessorSuperVZ 0x00040000
- Motorola 68SZ328 (Dragonball SuperVZ).
-
#define sysFtrNumProcessorVZ 0x00030000
- Motorola 68VZ328 (Dragonball VZ)
-
#define sysFtrNumProcessorx86 0x01000000
- The Palm OS ARM Simulator, which runs on Windows.
-
#define sysFtrNumProcessorXscale 0x00160000
- X-scale.
Processor Masks
Purpose
These mask values allow you to extract the processor type from a sysFtrNumProcessorID
feature value, and to easily determine if that processor is an ARM processor or a 68K-family processor.
Declared In
SystemMgr.h
Constants
-
#define sysFtrNumProcessor68KIfZero 0xFFF00000
- The processor is a 68K-family processor if, after ANDing this mask with the
sysFtrNumProcessorID
feature value, the result is zero. -
#define sysFtrNumProcessorARMIfNotZero 0x00F00000
- The processor is an ARM processor if, after ANDing this mask with the
sysFtrNumProcessorID
feature value, the result is not zero. -
#define sysFtrNumProcessorMask 0xFFFF0000
- AND this mask with the
sysFtrNumProcessorID
feature value to obtain a processor type that can be compared with the values listed under "Processor Types."
Build Stages
Purpose
Build stage values used when constructing a ROM version number or when checking the build stage of a device's ROM.
Declared In
SystemMgr.h
Constants
-
#define sysROMStageAlpha (1)
- An alpha ROM.
-
#define sysROMStageBeta (2)
- A beta ROM.
-
#define sysROMStageDevelopment (0)
- A ROM that is still in development (pre-release).
-
#define sysROMStageRelease (3)
- A release ROM.
Comments
Use sysMakeROMVersion()
to construct a ROM version number. Use sysGetROMVerBuild()
to extract the build stage from a device's ROM version number.
ROM Tokens
Purpose
ROM token identifiers that, when supplied to SysGetROMToken()
, cause the corresponding ROM token value to be retrieved.
Declared In
SystemMgr.h
Constants
-
#define sysROMTokenSnum 'snum'
- Used to retrieve the ROM serial number, expressed as a text string with no null terminator.
Comments
The serial number is shown to the user in the Application Launcher, along with a checksum digit you can use to validate input when your users read the ID from their device and type it in or tell it to someone else. Chapter 10, "The ROM Serial Number," shows how to retrieve the ROM serial number and calculate its associated checksum.
Device Manufacturers
Purpose
Identifies the manufacturer, HAL ID, and device ID of a Palm Powered™ device.
Declared In
SystemMgr.h
Constants
-
#define sysOEMCompanyIDHandspring 'hspr'
- Handspring.
-
#define sysOEMCompanyIDPalmDevices 'palm'
- Palm, Inc.
-
#define sysOEMCompanyIDPalmPlatform 'psys'
- PalmSource, Inc.
-
#define sysOEMCompanyIDQualcomm 'qcom'
- Qualcomm.
-
#define sysOEMCompanyIDSymbol 'smbl'
- Symbol.
-
#define sysOEMCompanyIDTRG 'trgp'
- TRG.
-
#define sysOEMCompanyIDUnspecified 0x00000000
- The company is unspecified.
-
#define sysOEMDeviceIDUnspecified 0x00000000
- The device is unspecified.
-
#define sysOEMHALIDUnspecified 0x00000000
- The HAL (hardware layer) is unspecified.
Comments
These values are assigned by PalmSource's Platform Engineering group. Note that these values differ from those found in some devices which use ROM tokens and run versions of Palm OS prior to 3.5.
Miscellaneous System Manager Constants
Purpose
The System Manager also defines these constants.
Declared In
SystemMgr.h
Constants
-
#define sysFtrNumEncryptionMaskDES 0x00000001
- AND this value with the value of the
sysFtrNumEncryption
feature; if the result is nonzero, the encryption scheme is DES. -
#define sysEntryNumMain ((uint32_t)0xffffffff)
- The main entry point in an executable.
-
#define sysFileDescStdIn 0
- The "
stdin
" file descriptor. -
#define sysFtrCreator sysFileCSystem
- Creator ID for those features defined by the System Manager. Supply
sysFtrCreator
orsysFileCSystem
toFtrGet()
when obtaining the value of those features listed under "System Features."
System Manager Functions and Macros
SysBatteryInfo Function
Purpose
Retrieve settings for the batteries. Set the set
parameter to false
to retrieve battery settings. (Applications should not change any of the settings).
Declared In
SystemMgr.h
Prototype
uint16_t SysBatteryInfo ( Booleanset
, uint16_t*warnThresholdPercentP
, uint16_t*criticalThresholdPercentP
, uint16_t*shutdownThresholdPercentP
, uint32_t*maxMilliSecsP
, SysBatteryKind*kindP
, Boolean*pluggedInP
, uint8_t*percentP
)
Parameters
-
→ set
- If
false
, parameters with non-NULL
pointers are retrieved. Never set this parameter totrue
. -
↔ warnThresholdPercentP
- Pointer to battery voltage warning threshold in volts*100, or
NULL
. -
↔ criticalThresholdPercentP
- Pointer to the battery voltage critical threshold in volts*100, or
NULL
. -
↔ shutdownThresholdPercentP
- Pointer to the battery voltage threshold at which the device will shut down, in volts*100, or
NULL
. -
↔ maxMilliSecsP
- Pointer to the battery timeout, or
NULL
. -
↔ kindP
- Pointer to the battery type, or
NULL
. For a complete set of battery types, see "SysBatteryKindTag." -
↔ pluggedInP
- Pointer to
pluggedIn
return value, orNULL
. -
↔ percentP
- Percentage of power remaining in the battery.
Returns
Returns the current battery voltage in volts*100.
Comments
Call this function to make sure an upcoming activity won't be interrupted by a low battery warning.
warnThresholdP
and maxTicksP
are the battery-warning voltage threshold and time out. If the battery voltage falls below the threshold, or the timeout expires, a lowBatteryChr
key event is put on the queue. Normally, applications call SysHandleEvent()
which calls SysBatteryDialog
in response to this event.
criticalThresholdP
is the battery voltage threshold. If battery voltage falls below this level, the system turns itself off without warning and doesn't turn on until battery voltage is above it again.
sysFtrNumProcessorIs68K Macro
Purpose
Determines whether or not the underlying processor is part of the 68K family.
Declared In
SystemMgr.h
Prototype
#define sysFtrNumProcessorIs68K (
x
)
Parameters
-
→ x
- Processor type obtained from a call to
FtrGet()
.
Returns
Returns true
if the underlying processor is a 68K, false
otherwise.
Example
UInt32 processorType; FtrGet(sysFileCSystem, sysFtrNumProcessorID, &processorType); if (sysFtrNumProcessorIs68K(processorType)){ // processor is 68K } else { // processor is not 68K }
sysFtrNumProcessorIsARM Macro
Purpose
Determines whether or not the underlying processor is part of the ARM family.
Declared In
SystemMgr.h
Prototype
#define sysFtrNumProcessorIsARM (
x
)
Parameters
-
→ x
- Processor type obtained from a call to
FtrGet()
.
Returns
Returns true
if the underlying processor is an ARM core, false
otherwise.
Example
UInt32 processorType; FtrGet(sysFileCSystem, sysFtrNumProcessorID, &processorType); if (sysFtrNumProcessorIsARM(processorType)){ // processor is ARM } else { // processor is not ARM }
SysGetROMToken Function
Purpose
Return from the ROM a value specified by token.
Declared In
SystemMgr.h
Prototype
status_t SysGetROMToken ( uint32_ttoken
, uint8_t**dataP
, uint16_t*sizeP
)
Parameters
-
→ token
- The value to retrieve, as specified by one of the tokens listed under "ROM Tokens."
-
← dataP
- Pointer to a buffer that holds the requested value when the function returns.
-
← sizeP
- The number of bytes in the
dataP
buffer.
Returns
Returns errNone
if the requested token was successfully retrieved, or an error code if an error occurred. If this function returns an error, or if the returned pointer to the buffer is NULL
or if the first byte of the text buffer is 0xFF
, then no serial number is available.
sysGetROMVerBuild Macro
Purpose
Extract the build stage from a ROM version number.
Declared In
SystemMgr.h
Prototype
#define sysGetROMVerBuild (
dwROMVer
)
Parameters
Returns
Returns the build stage. See "Build Stages" for the predefined set of build stage values.
Comments
Obtain the ROM version number by calling FtrGet()
with a creator ID of sysFtrCreator
and a feature number of sysFtrNumROMVersion
.
See Also
sysGetROMVerFix()
, sysGetROMVerMajor()
, sysGetROMVerMinor()
, sysGetROMVerStage()
, sysMakeROMVersion()
sysGetROMVerFix Macro
Purpose
Extract the fix number from a ROM version number.
Declared In
SystemMgr.h
Prototype
#define sysGetROMVerFix (
dwROMVer
)
Parameters
Returns
Comments
Obtain the ROM version number by calling FtrGet()
with a creator ID of sysFtrCreator
and a feature number of sysFtrNumROMVersion
.
See Also
sysGetROMVerBuild()
, sysGetROMVerMajor()
, sysGetROMVerMinor()
, sysGetROMVerStage()
, sysMakeROMVersion()
sysGetROMVerMajor Macro
Purpose
Extract the major version number from a ROM version number.
Declared In
SystemMgr.h
Prototype
#define sysGetROMVerMajor (
dwROMVer
)
Parameters
Returns
Returns the major version number.
Comments
Obtain the ROM version number by calling FtrGet()
with a creator ID of sysFtrCreator
and a feature number of sysFtrNumROMVersion
.
See Also
sysGetROMVerBuild()
, sysGetROMVerFix()
, sysGetROMVerMinor()
, sysGetROMVerStage()
, sysMakeROMVersion()
sysGetROMVerMinor Macro
Purpose
Extract the minor version number from a ROM version number.
Declared In
SystemMgr.h
Prototype
#define sysGetROMVerMinor (
dwROMVer
)
Parameters
Returns
Returns the minor version number.
Comments
Obtain the ROM version number by calling FtrGet()
with a creator ID of sysFtrCreator
and a feature number of sysFtrNumROMVersion
.
See Also
sysGetROMVerBuild()
, sysGetROMVerFix()
, sysGetROMVerMajor()
, sysGetROMVerStage()
, sysMakeROMVersion()
sysGetROMVerStage Macro
Purpose
Extract the build stage from a ROM version number.
Declared In
SystemMgr.h
Prototype
#define sysGetROMVerStage (
dwROMVer
)
Parameters
Returns
Comments
Obtain the ROM version number by calling FtrGet()
with a creator ID of sysFtrCreator
and a feature number of sysFtrNumROMVersion
.
See Also
sysGetROMVerBuild()
, sysGetROMVerFix()
, sysGetROMVerMajor()
, sysGetROMVerMinor()
, sysMakeROMVersion()
SysHandleEvent Function
Purpose
Handle defaults for system events such as hard and soft key presses.
Declared In
SystemMgr.h
Prototype
Boolean SysHandleEvent (
EventPtr eventP
)
Parameters
Returns
Returns true
if the system handled the event.
Comments
Applications should call this routine immediately after calling EvtGetEvent()
unless they want to override the default system behavior. However, overriding the default system behavior is almost never appropriate for an application.
See Also
SysLCDBrightness Function
Purpose
Get or set the LCD's brightness level.
Declared In
SystemMgr.h
Prototype
uint8_t SysLCDBrightness ( Booleanset
, uint8_tnewBrightnessLevel
)
Parameters
-
→ set
- Pass
true
to set the brightness level,false
to retrieve it. -
→ newBrightnessLevel
- The desired new brightness level. This parameter is ignored if
set
isfalse
.
Returns
If set
is true
, the previous brightness level. If set
is false
, the current brightness level.
See Also
SysLCDContrast Function
Purpose
Get or set the LCD's contrast level.
Declared In
SystemMgr.h
Prototype
uint8_t SysLCDContrast ( Booleanset
, uint8_tnewContrastLevel
)
Parameters
-
→ set
- Pass
true
to set the contrast level,false
to retrieve it. -
→ newContrastLevel
- The desired new contrast level. This parameter is ignored if
set
isfalse
.
Returns
If set
is true
, the previous contrast level. If set
is false
, the current contrast level.
See Also
sysMakeROMVersion Macro
Purpose
Build a ROM version value from the major, minor, fix, stage, and build numbers.
Declared In
SystemMgr.h
Prototype
#define sysMakeROMVersion (major
,minor
,fix
,stage
,buildNum
)
Parameters
-
→ major
- The major version number.
-
→ minor
- The minor version number.
-
→ fix
- The fix number.
-
→ stage
- The build stage. See "Build Stages" for the set of predefined build stage values.
-
→ buildNum
- The build number.
Returns
This macro produces a uint32_t
that contains the ROM version value.
See Also
sysGetROMVerBuild()
, sysGetROMVerFix()
, sysGetROMVerMajor()
, sysGetROMVerMinor()
, sysGetROMVerStage()
SysRequestSleep Function
Purpose
Request that the system be put to sleep.
Declared In
SystemMgr.h
Prototype
void SysRequestSleep ( void )
Parameters
Returns
Comments
Unlike SysSleep()
, this function sends out a sleep request notification that allows any executable registered for the notification to prevent the system from going to sleep.
See Also
SysSetAutoOffTime Function
Purpose
Set the time out value in seconds for auto-power-off.
Declared In
SystemMgr.h
Prototype
uint16_t SysSetAutoOffTime (
uint16_t seconds
)
Parameters
Returns
Returns the previous time out value, in seconds.
SysSleep Function
Purpose
Put the system into lowest power mode by shutting down all peripherals, the CPU, and the system clock.
Declared In
SystemMgr.h
Prototype
void SysSleep ( void )
Parameters
Returns
See Also
SysTaskDelay Function
Purpose
Put the processor into doze mode for the specified number of milliseconds.
Declared In
SystemMgr.h
Prototype
status_t SysTaskDelay (
int32_t delayInMilliSecs
)
Parameters
Returns
Returns errNone
if no error occurred.
See Also
SysTicksPerSecond Macro
Purpose
Return the number of ticks per second. This routine allows applications to be tolerant of changes to the ticks per second rate in the system.
Declared In
SystemMgr.h
Prototype
#define SysTicksPerSecond ()
Parameters
Returns
Evaluates to the number of ticks per second.
Comments
Applications should not be written to measure time in system ticks. Instead, use the various SysTimeIn...
and SysTimeTo...
macros to work with time values in system-independent units.
SysTimeInCentiSecs Macro
Purpose
Create a system time value from a value in centiseconds (1/100 second).
Declared In
SystemMgr.h
Prototype
#define SysTimeInCentiSecs (
centiSecs
)
Parameters
Returns
Evaluates to the corresponding system time value.
See Also
SysTimeInMicroSecs()
, SysTimeInMilliSecs()
, SysTimeInMins()
, SysTimeInSecs()
SysTimeInMicroSecs Macro
Purpose
Create a system time value from a value in microseconds.
Declared In
SystemMgr.h
Prototype
#define SysTimeInMicroSecs (
microSecs
)
Parameters
Returns
Evaluates to the corresponding system time value.
See Also
SysTimeInCentiSecs()
, SysTimeInMilliSecs()
, SysTimeInMins()
, SysTimeInSecs()
, SysTimeToMicroSecs()
SysTimeInMilliSecs Macro
Purpose
Create a system time value from a value in milliseconds.
Declared In
SystemMgr.h
Prototype
#define SysTimeInMilliSecs (
milliSecs
)
Parameters
Returns
Evaluates to the corresponding system time value.
See Also
SysTimeInCentiSecs()
, SysTimeInMicroSecs()
, SysTimeInMins()
, SysTimeInSecs()
, SysTimeToMilliSecs()
SysTimeInMins Macro
Purpose
Create a system time value from a value in minutes.
Declared In
SystemMgr.h
Prototype
#define SysTimeInMins (
mins
)
Parameters
Returns
Evaluates to the corresponding system time value.
See Also
SysTimeInCentiSecs()
, SysTimeInMicroSecs()
, SysTimeInMilliSecs()
, SysTimeInSecs()
SysTimeInSecs Macro
Purpose
Create a system time value from a value in seconds.
Declared In
SystemMgr.h
Prototype
#define SysTimeInSecs (
secs
)
Parameters
Returns
Evaluates to the corresponding system time value.
See Also
SysTimeInCentiSecs()
, SysTimeInMicroSecs()
, SysTimeInMilliSecs()
, SysTimeInMins()
, SysTimeToSecs()
SysTimeToMicroSecs Macro
Purpose
Convert a system time value to microseconds.
Declared In
SystemMgr.h
Prototype
#define SysTimeToMicroSecs (
sysTime
)
Parameters
Returns
Evaluates to the corresponding time value in microseconds.
See Also
SysTimeInMicroSecs()
, SysTimeToMilliSecs()
, SysTimeToSecs()
SysTimeToMilliSecs Macro
Purpose
Convert a system time value to milliseconds.
Declared In
SystemMgr.h
Prototype
#define SysTimeToMilliSecs (
sysTime
)
Parameters
Returns
Evaluates to the corresponding time value in milliseconds.
See Also
SysTimeInMilliSecs()
, SysTimeToMicroSecs()
, SysTimeToSecs()
SysTimeToSecs Macro
Purpose
Convert a system time value to seconds.
Declared In
SystemMgr.h
Prototype
#define SysTimeToSecs (
sysTime
)
Parameters
Returns
Evaluates to the corresponding time value in seconds.
See Also
SysTimeInSecs()
, SysTimeToMicroSecs()
, SysTimeToMilliSecs()
SysTurnDeviceOn Function
Purpose
Declared In
SystemMgr.h
Prototype
void SysTurnDeviceOn ( void )
Parameters
Returns
SysUIBusy Function
Purpose
This function originally let you get or set the system UI busy count. In Palm OS Cobalt, however, this function is provided only for compatibility: it effectively does nothing.
Declared In
SystemMgr.h
Prototype
uint16_t SysUIBusy ( Booleanset
, Booleanvalue
)
Parameters
-
→ set
-
true
to alter the UI busy count,false
to retrieve the system UI busy count. In Palm OS Cobalt this parameter is ignored. -
→ value
-
true
to increment the UI busy count,false
to decrement it. This parameter is ignored ifset
isfalse
. In Palm OS Cobalt this parameter is ignored.
Returns
Returns the current UI busy count. The user interface is not busy if the value returned here is 0. In Palm OS Cobalt this function always returns zero.