API Guide Home (Online version only) |

# TransparencyLibTypes.h

Go to the documentation of this file.

    00001 /*******************************************************************************
    00002  * Copyright (c) 2004-2005 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  ******************************************************************************/
    00005 /**
    00006  * @defgroup    Transparency Transparency Library
    00007  * @brief       This library can be used to couple data between a Ccp channel and a serial
    00008  *              port.
    00009  *
    00010  * It is meant to be used for diagnostics and tethered mode. Since it is a
    00011  * library, it can work without being in a certain application.
    00012  *
    00013  * @{
    00014  * @}
    00015  */
    00016 /**
    00017  * @ingroup Transparency
    00018  */
    00019
    00020 /**
    00021  * @file TransparencyLibTypes.h
    00022  * @brief   Public common header file for the Transparency Library on Treo devices.
    00023  *
    00024  * This file contains the common types of the Transparency Library.
    00025  * <hr>
    00026  */
    00027
    00028 #ifndef __TRANSPARENCY_LIB_TYPES_INT__H__
    00029
    00030 #define __TRANSPARENCY_LIB_TYPES_INT__H__
    00031
    00032 /**
    00033  * Transparency library names
    00034  **/
    00035 #define  transLibName                   "Transparency Library"
    00036
    00037 /**
    00038  * Creator ID of Transparency Library - 'HsTL'
    00039  **/
    00040 #define  transLibCreator                hsFileCTransparencyLib
    00041
    00042 /**
    00043  * Type ID of transparency library
    00044  **/
    00045 #define  transLibType                   sysFileTLibrary
    00046
    00047 /**
    00048  * @name Function Traps
    00049  */
    00050 /*@{*/
    00051 #define transLibTrapOpenConnection      sysLibTrapCustom
    00052 #define transLibTrapCloseConnection     sysLibTrapCustom+1
    00053 /*@}*/
    00054
    00055 /**
    00056  * @name Error Codes
    00057  */
    00058 /*@{*/
    00059
    00060 /**
    00061  * Error class for the transparency library
    00062  **/
    00063 #define   transLibErrorClass  0x5000
    00064
    00065 /**
    00066  *  Unkown command requested. For example, an unknown channel type was passed as
    00067  *  a port.
    00068  **/
    00069 #define   transLibErrUnknown  (transLibErrorClass | 1)
    00070
    00071 /**
    00072  *  No connection is open.
    00073  **/
    00074 #define   transLibErrNotOpen  (transLibErrorClass | 2)
    00075
    00076 /**
    00077  *  Transparency library already open
    00078  **/
    00079 #define   transLibErrAlreadyOpen  (transLibErrorClass | 3)
    00080
    00081 /**
    00082  *  Transparency library error when there is cradle not attached to the bottom port
    00083  **/
    00084 #define   transLibErrDockNotAttached (transLibErrorClass | 4)
    00085
    00086 /*@}*/
    00087
    00088 #endif

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:06:55 2008 for Palm API Guide