rvtm.h

基于h323协议的软phone

	{proto: RvInt32 RvTmSetNsec(RvTm *_t, RvInt32 _n);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _n} {d: number of nanoseconds.}}
	}
	{returns: The nanoseconds value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetSec}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the seconds component of a calender time.}
	}
	{proto: RvInt RvTmGetSec(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The seconds component of the calendar time.}
}
$*/
/*$
{function:
	{name: RvTmSetSec}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the seconds component of a calender time.}
	}
	{proto: RvInt RvTmSetSec(RvTm *_t, RvInt _s);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _s} {d: number of seconds.}}
	}
	{returns: The seconds value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetMin}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the minutes component of a calender time.}
	}
	{proto: RvInt RvTmGetMin(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The minutes component of the calendar time.}
}
$*/
/*$
{function:
	{name: RvTmSetMin}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the minutes component of a calender time.}
	}
	{proto: RvInt RvTmSetMin(RvTm *_t, RvInt _m);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _m} {d: number of minutes.}}
	}
	{returns: The minutes value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetHour}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the hour component of a calender time.}
	}
	{proto: RvInt RvTmGetHour(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The hour component of the calendar time.}
}
$*/
/*$
{function:
	{name: RvTmSetHour}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the hour component of a calender time.}
	}
	{proto: RvInt RvTmSetHour(RvTm *_t, RvInt _h);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _h} {d: number of hours.}}
	}
	{returns: The hour value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetMday}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the day of the month component of a calender time.}
	}
	{proto: RvInt RvTmGetMday(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The day of the month component of the calendar time.}
}
$*/
/*$
{function:
	{name: RvTmSetMday}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the day of the month component of a calender time.}
	}
	{proto: RvInt RvTmSetMday(RvTm *_t, RvInt _m);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _m} {d: day of the month.}}
	}
	{returns: The day of the month value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetMon}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the month of the year component of a calender time (1 = January, 12 = December).}
	}
	{proto: RvInt RvTmGetMon(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The month of the year component of the calendar time (1 = January, 12 = December).}
	{notes:
		{note:  This value is different then the standard ANSI tm format in that
				a month value of 1 is January whereas using the standard ANSI tm
				structure January would be a 0.}
	}
}
$*/
/*$
{function:
	{name: RvTmSetMon}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the month of the year component of a calender time (1 = January, 12 = December).}
	}
	{proto: RvInt RvTmSetMon(RvTm *_t, RvInt _m);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _m} {d: month of the year (1 = January, 12 = December).}}
	}
	{returns: The month of the year value that was set.}
	{notes:
		{note:  This value is different then the standard ANSI tm format in that
				a month value of 1 is January whereas using the standard ANSI tm
				structure January would be a 0.}
	}
}
$*/
/*$
{function:
	{name: RvTmGetYear}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the year component of a calender time.}
	}
	{proto: RvInt RvTmGetYear(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The year component of the calendar time.}
	{notes:
		{note:  This value is different then the standard ANSI tm format in that
				a year value of 2002 is year 2002 whereas using the standard
				ANSI tm structure year 2002 would be 202.}
		}
}
$*/
/*$
{function:
	{name: RvTmSetYear}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the year component of a calender time.}
	}
	{proto: RvInt RvTmSetYear(RvTm *_t, RvInt _y);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _y} {d: year.}}
	}
	{returns: The year value that was set.}
	{notes:
		{note:  This value is different then the standard ANSI tm format in that
				a year value of 2002 is year 2002 whereas using the standard
				ANSI tm structure year 2002 would be 202.}
		}
}
$*/
/*$
{function:
	{name: RvTmGetWday}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the day of the week component of a calender time (0 = Sunday, 6 = Saturday).}
	}
	{proto: RvInt RvTmGetWday(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The day of the week component of the calendar time (0 = Sunday, 6 = Saturday).}
}
$*/
/*$
{function:
	{name: RvTmSetWday}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the day of the week component of a calender time (0 = Sunday, 6 = Saturday).}
	}
	{proto: RvInt RvTmSetWday(RvTm *_t, RvInt _w);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _w} {d: day of the week (0 = Sunday, 6 = Saturday).}}
	}
	{returns: The day of the week value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetYday}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the day of the year component of a calender time (0 = January 1st)}
	}
	{proto: RvInt RvTmGetYday(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns: The day of the year component of the calendar time (0 = January 1st).}
}
$*/
/*$
{function:
	{name: RvTmSetYday}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the day of the year component of a calender time (0 = January 1st).}
	}
	{proto: RvInt RvTmSetYday(RvTm *_t, RvInt _y);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _y} {d: day of the year (0 = January 1st).}}
	}
	{returns: The day of the year value that was set.}
}
$*/
/*$
{function:
	{name: RvTmGetIsdst}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Gets the daylight savings time component of a calender time}
	}
	{proto: RvInt RvTmGetIsdst(RvTm *_t);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
	}
	{returns:	The daylight savings time component of the calendar time. Possible values
				RV_TM_STANDARD, RV_TM_DST, RV_TM_UNKNOWN.}
	{notes:
		{note:	All OS's do not handle daylight savings time properly so this value
				may not be accurate.}
	}
}
$*/
/*$
{function:
	{name: RvTmSetIsdst}
	{superpackage: Tm}
	{include: rvtm.h}
	{description:
		{p: Sets the daylight savings time component of a calender time.}
	}
	{proto: RvInt RvTmSetIsdst(RvTm *_t, RvInt _i);}
	{params:
		{param: {n: _t} {d: pointer to a calendar time object.}}
		{param: {n: _i} {d: daylight savings time. Possible values RV_TM_STANDARD, RV_TM_DST, RV_TM_UNKNOWN.}}
	}
	{returns: The daylight savings time value that was set.}
	{notes:
		{note:	All OS's do not handle daylight savings time properly so this value
				may be ignored.}
	}
}
$*/

#endif