API Guide Home (Online version only) |

# palmOneHiResTimer.h

Go to the documentation of this file.

    00001 /******************************************************************************
    00002  * Copyright (c) 2004 palmOne, Inc. or its subsidiaries.
    00003  * All rights reserved.
    00004  *****************************************************************************/
    00005 /**
    00006  * @ingroup HiRes
    00007  */
    00008
    00009 /**
    00010  *
    00011  * @file    palmOneHiResTimer.h
    00012  * @version 1.0
    00013  *
    00014  * @brief   Public 68k include file for Hi-Resolution timer for Palm OS.
    00015  **/
    00016
    00017 #ifndef _PALMONEHIRESTIMER_H_
    00018 #define _PALMONEHIRESTIMER_H_
    00019
    00020 #include <PalmTypes.h>
    00021 #include <ErrorBase.h>
    00022 #include <SystemMgr.h>
    00023 #include <LibTraps.h>
    00024 #include <palmOneHiResTimerCommon.h>
    00025
    00026
    00027 /***********************************************************************
    00028  * API Prototypes
    00029  ***********************************************************************/
    00030
    00031 #ifdef __cplusplus
    00032 extern "C" {
    00033 #endif
    00034
    00035
    00036 /**
    00037  * Opens the Hi-Res Timer library.
    00038  *
    00039  * @param refNum:   IN: Library reference number.
    00040  * @retval Err Error code.
    00041  */
    00042 extern Err HRTimeLibOpen(UInt16 refNum)
    00043     SYS_TRAP(sysLibTrapOpen);
    00044
    00045 /**
    00046  * Closes the Hi-Res Timer library.
    00047  *
    00048  * @param refNum:   IN: Library reference number.
    00049  * @retval Err Error code.
    00050  */
    00051 extern Err HRTimeLibClose(UInt16 refNum)
    00052     SYS_TRAP(sysLibTrapClose);
    00053
    00054 /**
    00055  * Get the frequency of the Hi-Resolution Timer.
    00056  *
    00057  * @param refNum:   IN:  Library reference number.
    00058  * @param ticksP:   OUT: Frequency of the timer.
    00059  * @retval Err Error code.
    00060  */
    00061 extern Err HRTimeLibTicksPerSecond(UInt16 refNum, UInt32 *ticksP)
    00062     SYS_TRAP(kHRLibTrapTimerTicksPerSecond);
    00063
    00064 /**
    00065  * Get the current ticks for Hi-Resolution Timer.
    00066  *
    00067  * @param refNum:       IN:  Library reference number.
    00068  * @param ticksP:       OUT: Current ticks.
    00069  * @param rolloverP:    OUT: Number of rollover since the timer started.
    00070  * @retval Err Error code.
    00071  */
    00072 extern Err HRTimeLibGetTime(UInt16 refNum, UInt32 *ticksP, UInt32 *rolloverP)
    00073     SYS_TRAP(kHRLibTrapTimerGetTime);
    00074
    00075
    00076
    00077
    00078 #ifdef __cplusplus
    00079 }
    00080 #endif
    00081
    00082 #endif  // _PALMONEHIRESTIMER_H_

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