KTime.h File Reference

Time structure. More...

#include "ktypes.h"

Typedefs
typedef _KTime	KTime
	Time.
Functions
KTL_API KTime *	KTime_new ()
	Allocates and initializes a KTime structure.
KTL_API void	KTime_delete (KTime **ktime)
	Deletes a KTime structure.
KTL_API KTime *	KTime_getKTime ()
	Gets the time in a KTime structure.
KTL_API KBool	KTime_getTime (KTime *ktime)
	Gets the time in an allocated KTime structure.
KTL_API KInt64	KTime_getSec (KTime *ktime)
	Gets the time in seconds.
KTL_API KInt64	KTime_getMSec (KTime *ktime)
	Gets the time in milliseconds.
KTL_API KInt64	KTime_getUSec (KTime *ktime)
	Gest the time in microseconds.
KTL_API KBool	KTime_go (KTime *ktime)
	Triggers a timer.
KTL_API KTime *	KTime_kgo ()
	Returns a timer initialized with the current date.
KTL_API KBool	KTime_stop (KTime *pTime)
	Stops a timer and updates a KTime structure with the time elapsed since the call to the KTime_go() functions.
KTL_API KString	KTime_toStr (KTime *pTime)
	Gets a string that corresponds to time of a KTime structure (Format 4h 21min 41sec 456msec 321microsec). The string must be deleted after be used.

---

Detailed Description

Time structure.

Version:

KToolLib-1.0

Author:

Fabien Gallot

Date:

03/12/2008

Note:

Copyright © 2008-2010 iKlax Media SAS (www.iklaxmedia.com). All rights reserved.

---

Function Documentation

KTL_API void KTime_delete (  KTime **  ktime  )

Deletes a KTime structure. Parameters: ktime  the pointers to the KTime structure to be deleted

KTL_API KTime* KTime_getKTime (   )

Gets the time in a KTime structure. Returns: the pointer to the KTime structure if successful otherwise knull

KTL_API KInt64 KTime_getMSec (  KTime *  ktime  )

Gets the time in milliseconds. Parameters: ktime  the pointer to the KTime structure Returns: the time in milliseconds if successful otherwise -1

KTL_API KInt64 KTime_getSec (  KTime *  ktime  )

Gets the time in seconds. Parameters: ktime  the pointer to the KTime structure Returns: the time in seconds if successful otherwise -1

KTL_API KBool KTime_getTime (  KTime *  ktime  )

Gets the time in an allocated KTime structure. Parameters: ktime  the pointer to the allocated KTime structure Returns: ktrue if successful otherwise kfalse

KTL_API KInt64 KTime_getUSec (  KTime *  ktime  )

Gest the time in microseconds. Parameters: ktime  the pointer to the KTime structure Returns: the time in microseconds if successfull otherwise -1

KTL_API KBool KTime_go (  KTime *  ktime  )

Triggers a timer. Parameters: ktime  the pointer to the KTime structure Returns: ktrue if successful otherwise kfalse

KTL_API KTime* KTime_kgo (   )

Returns a timer initialized with the current date. Returns: a timer initialized with the current date

KTL_API KTime* KTime_new (   )

Allocates and initializes a KTime structure. Returns: the pointer to the KTime structure created if successful otherwise knull

KTL_API KBool KTime_stop (  KTime *  pTime  )

Stops a timer and updates a KTime structure with the time elapsed since the call to the KTime_go() functions. Parameters: pTime  the pointer to the KTime structure Returns: ktrue if successful otherwise kfalse

KTL_API KString KTime_toStr (  KTime *  pTime  )

Gets a string that corresponds to time of a KTime structure (Format 4h 21min 41sec 456msec 321microsec). The string must be deleted after be used. Parameters: pTime  the pointer to the KTime structure Returns: the string if successful otherwise knull

---