Documentation  |   Table of Contents   |  < Previous   |  Next >  

99    SerialMgr.h

Porting Applications to Palm OS® Cobalt

Exploring Palm OS®

Beyond the removal of a few APIs that were previously identified as "System Use Only," the Serial Manager APIs are largely unchanged in Palm OS Cobalt.

Note that virtual drivers aren't supported on Palm OS Garnet and later. This includes Palm OS Cobalt.

Deleted APIs ^TOP^

Table 99.1  Deleted functions

Deleted API

Use instead

SerialMgrInstall()

Nothing. This function was documented as "System Use Only" and should not have been used by applications.

SrmSelectorErrPrv()

Nothing. This function was documented as "System Use Only" and should not have been used by applications.

Table 99.2  Deleted macros

Deleted API

Use instead

SERIAL_TRAP()

Nothing. This macro wasn't to be used by applications.

Table 99.3  Deleted structures

Deleted API

Use instead

SrmCallbackEntryType

Nothing. This structure was used in conjunction with the SerControl() function SerCtlEmuSetBlockingHook, which is no longer supported.

Table 99.4  Deleted types

Deleted API

Use instead

SrmCallbackEntryPtr

Nothing. This type was used in conjunction with the SerControl() function SerCtlEmuSetBlockingHook, which is no longer supported.

Table 99.5  Deleted #defines

Deleted API

Use instead

maxSerialSelector

Nothing: this was related to the trap selectors.

serDevCncMgrVisible

serDevModemPort

srmSettingsFlagRTSInactive

sysSerial...

Nothing: these were trap selectors.

Table 99.6  Deleted enumerated types

Deleted API

Use instead

SrmTransferModeType

Table 99.7  Deleted application-defined functions 

Deleted API

Use instead

BlockingHookProcPtr()

Nothing. This application-defined function was used in conjunction with the SerControl() function SerCtlEmuSetBlockingHook, which is no longer supported.

Modified APIs ^TOP^

Table 99.8  Modified structures

Modified API

Description of change

SrmOpenConfigType

Padding bytes have been added.

Table 99.9  Modified #defines 

Modified API

Description of change

#define serMgrVersion 3

The version number has been incremented to 3.

#define srmDefaultCTSTimeout (srmDefaultCTSTimeoutV4*10)

Previously the timeout value was in ticks. It is now in milliseconds.

#define srmDefaultSettings (srmSettingsFlagBitsPerChar8 | srmSettingsFlagStopBits1 | srmSettingsFlagRTSAutoM | srmSettingsFlagFlowControlIn | srmSettingsFlagCTSAutoM)

The final flag—for CTS transmit flow control—has been added.

Table 99.10  Modified enumerated types

Modified API

Description of change

SrmCtlEnum

srmCtlEmuSetBlockingHook is no longer one of the enumerated values.

Unchanged APIs ^TOP^

Table 99.11  Unchanged functions 

SrmClearErr()

SrmClose()

SrmControl()

SrmCustomControl()

SrmExtOpen()

SrmExtOpenBackground()

SrmGetDeviceCount()

SrmGetDeviceInfo()

SrmGetStatus()

SrmOpen()

SrmOpenBackground()

SrmPrimeWakeupHandler()

SrmReceive()

SrmReceiveCheck()

SrmReceiveFlush()

SrmReceiveWait()

SrmReceiveWindowClose()

SrmReceiveWindowOpen()

SrmSend()

SrmSendCheck()

SrmSendFlush()

SrmSendWait()

SrmSetReceiveBuffer()

SrmSetWakeupHandler()

SrmSleep()

SrmWake()

Table 99.12  Unchanged structures

DeviceInfoType

Table 99.13  Unchanged types

DeviceInfoPtr

SrmOpenConfigPtr

Table 99.14  Unchanged #defines 

serDevConsolePort

serDevCradlePort

serDevIRDACapable

serDevRS232Serial

serDevUSBCapable

serErrAlreadyOpen

serErrBadConnID

serErrBadParam

serErrBadPort

serErrConfigurationFailed

serErrLineErr

serErrNoDevicesAvail

serErrNoMem

serErrNotOpen

serErrNotSupported

serErrStillOpen

serErrTimeOut

serFncConsole

serFncDebugger

serFncHotSync

serFncPPPSession

serFncSLIPSession

serFncTelephony

serFncUndefined

serLineErrorBreak

serLineErrorCarrierLost

serLineErrorFraming

serLineErrorHShake

serLineErrorHWOverrun

serLineErrorParity

serLineErrorSWOverrun

serPortConsolePort

serPortCradlePort

serPortCradleRS232Port

serPortCradleUSBPort

serPortIDMask

serPortIrPort

serPortLocalHotSync

srmCtlCustomStart

srmCtlSystemStart

srmSettingsFlagBitsPerChar5

srmSettingsFlagBitsPerChar6

srmSettingsFlagBitsPerChar7

srmSettingsFlagBitsPerChar8

srmSettingsFlagBitsPerCharM

srmSettingsFlagCTSAutoM

srmSettingsFlagFlowControlIn

srmSettingsFlagParityEvenM

srmSettingsFlagParityOnM

srmSettingsFlagRTSAutoM

srmSettingsFlagStopBits1

srmSettingsFlagStopBits2

srmSettingsFlagStopBitsM

srmSettingsFlagXonXoffM

srmStatusBreakSigOn

srmStatusCtsOn

srmStatusDsrOn

srmStatusRtsOn

sysFtrNewSerialPresent

sysFtrNewSerialVersion

Table 99.15  Unchanged application-defined functions

WakeupHandlerProcPtr()