Header Files » Incs » 68k » libraries » transparencylibrary
TransparencyLib.h

00001 /******************************************************************************
00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
00003  * All rights reserved.
00004  *****************************************************************************/
00005 /**
00006  * @ingroup Transparency
00007  */
00008 
00009 /**
00010  * @file  TransparencyLib.h
00011  * @brief Transparency Library that couples a Ccp channel and a serial port
00012  *
00013  * This library can be used to couple data between a Ccp channel and a serial
00014  * port. It is meant to be used for diagnostics and tethered mode. Since it is a
00015  * library, it can work without being in a certain application.
00016  */
00017 
00018 #ifndef __TRANSPARENCY_LIB_INT__H__
00019 #define __TRANSPARENCY_LIB_INT__H__
00020 
00021 #ifdef __cplusplus
00022 extern "C" {
00023 #endif
00024 
00025 /// Open the Transparency Library and connect the radio modem directly with a
00026 /// known port.
00027 ///
00028 /// @param refNum:          IN: Library Reference Number.
00029 /// @param portAChannel:    IN: CcpChannelType of radio port.
00030 /// @param portB:           IN: Port ID of the second port. This is the serial or USB port.
00031 /// @retval Err             Error code.
00032 ///
00033 /// @code
00034 /// err = SysLibFind (transLibName, &refNum);
00035 /// if (!err)
00036 ///     err=TransLibOpenConnection(refNum,kCcpChannelTypeModem, 0x8000);
00037 /// @endcode
00038 Err TransLibOpenConnection (UInt16 refNum, CcpChannelType portAChannel, UInt32 portB)
00039                                                SYS_TRAP (transLibTrapOpenConnection);
00040 
00041 /// Close the Transparency Library previously open and set the radio module in the
00042 /// correct state.
00043 ///
00044 /// @param refNum: IN: Library Reference Number.
00045 /// @retval Err Error code.
00046 Err TransLibCloseConnection (UInt16 refNum)
00047                            SYS_TRAP (transLibTrapCloseConnection);
00048 #ifdef __cplusplus
00049 }
00050 #endif
00051 
00052 #endif // __TRANSPARENCY_LIB_INT__H__
Top	Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:06:55 2008 for Palm API Guide