DosTmrQueryFreq: Difference between revisions

Latest revision as of 22:46, 7 January 2024

Provides the frequency of the IRQ0 high resolution timer (Intel 8254) / Queries the performance timer for its frequency.

Syntax

DosTmrQueryFreq (pulTmrFreq)

Parameters

pulTmrFreq (PULONG) - output: Timer Frequency.; Provides the frequency of the IRQ0 high resolution timer in hertz (timer units/sec).

Return Code

rc (APIRET) - returns: DosTmrQueryFrequency returns the following values:

0 NO_ERROR
87 ERROR_INVALID_PARAMETER
535 ERROR_TMR_NO_DEVICE
99 ERROR_DEVICE_IN_USE

Remarks

Currently, the timer frequency = 1.19318 Mhz, for a timer resolution of about .838 microseconds. (See also DosTmrQueryTime.)

Example Code

#define INCL_DOSPROFILE
#include <os2.h>

PULONG    pulTmrFreq;  /*  Timer Frequency. */
APIRET    rc;          /*  Return Code. */

rc = DosTmrQueryFreq(pulTmrFreq);

Related Functions

@@ Line 1: / Line 1: @@
-==Description==
+Provides the frequency of the IRQ0 high resolution timer (Intel 8254) / Queries the performance timer for its frequency.
-Provides the frequency of the IRQ0 high resolution timer (Intel 8254).
 ==Syntax==
-<PRE>
+ DosTmrQueryFreq (pulTmrFreq)
-#define INCL_DOSPROFILE
-#include <os2.h>
-PULONG    pulTmrFreq;  /*  Timer Frequency. */
-APIRET    rc;          /*  Return Code. */
-rc = DosTmrQueryFreq(pulTmrFreq);
-</PRE>
 ==Parameters==
-;  pulTmrFreq (PULONG) - output : Timer Frequency.
+;pulTmrFreq (PULONG) - output : Timer Frequency.
-Provides the frequency of the IRQ0 high resolution timer in hertz (timer units/sec).
+:Provides the frequency of the IRQ0 high resolution timer in hertz (timer units/sec).
 ==Return Code==
+;rc (APIRET) - returns:DosTmrQueryFrequency returns the following values:
- rc (APIRET) - returns
+* 0 NO_ERROR
+* 87 ERROR_INVALID_PARAMETER
-DosTmrQueryFrequency returns the following values:
+* 535 ERROR_TMR_NO_DEVICE
+* 99 ERROR_DEVICE_IN_USE
-* 0         NO_ERROR
-* 87        ERROR_INVALID_PARAMETER
-* 535       ERROR_TMR_NO_DEVICE
-* 99        ERROR_DEVICE_IN_USE
 ==Remarks==
+Currently, the timer frequency = 1.19318 Mhz, for a timer resolution of about .838 microseconds. (See also [[DosTmrQueryTime]].)
 ==Example Code==
 <PRE>
+#define INCL_DOSPROFILE
+#include <os2.h>
+PULONG    pulTmrFreq;  /*  Timer Frequency. */
+APIRET    rc;          /*  Return Code. */
+rc = DosTmrQueryFreq(pulTmrFreq);
 </PRE>
 ==Related Functions==
-* [[OS2 API:CPI:DosDevConfig|DosDevConfig]]
+* [[DosDevConfig]]
-* [[OS2 API:CPI:DosDevIOCtl|DosDevIOCtl]]
+* [[DosDevIOCtl]]
-* [[OS2 API:CPI:DosPhysicalDisk|DosPhysicalDisk]]
+* [[DosPhysicalDisk]]
-[[Category:The OS/2 API Project]]
+[[Category:Dos]]