DosBeep (OS/2 1.x): Difference between revisions
m Martini moved page OS2 API:CPI:LEGACY:DosBeep to DosBeep (Legacy) |
No edit summary |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[ | {{Legacy | ||
|RepFunc=[[DosBeep]] | |||
|Remarks=The function described here was part of the OS2 1.x API. It had been updated for modern OS/2 development, it is available at [[DosBeep]]. | |||
}} | |||
This call generates sound from the speaker. | This call generates sound from the speaker. | ||
==Syntax== | ==Syntax== | ||
DosBeep (Frequency, Duration) | |||
DosBeep | |||
==Parameters== | ==Parameters== | ||
; Frequency (USHORT) - input : Tone in Hertz (cycles per second) in the range 37 through 32767. | ;Frequency ([[USHORT]]) - input: Tone in Hertz (cycles per second) in the range 37 through 32767. | ||
;Duration (USHORT) - input: Length of the sound in milliseconds. | |||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
*0 NO_ERROR | |||
Return code descriptions are: | *395 ERROR_INVALID_FREQUENCY | ||
* 0 | |||
* 395 | |||
==Remarks== | ==Remarks== | ||
DosBeep executes synchronously. An application program that invokes DosBeep waits until the specified number of milliseconds expire before it resumes execution. | DosBeep executes synchronously. An application program that invokes DosBeep waits until the specified number of milliseconds expire before it resumes execution. | ||
== | ==Bindings== | ||
===C | ===C=== | ||
<PRE> | <PRE> | ||
#define INCL_DOSPROCESS | #define INCL_DOSPROCESS | ||
| Line 33: | Line 27: | ||
USHORT rc = DosBeep(Frequency, Duration); | USHORT rc = DosBeep(Frequency, Duration); | ||
USHORT | USHORT Frequency; /* Hertz (Hz) */ | ||
USHORT | USHORT Duration; /* Length of sound */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
===MASM=== | |||
===MASM | |||
<PRE> | <PRE> | ||
EXTRN DosBeep:FAR | EXTRN DosBeep:FAR | ||
INCL_DOSPROCESS EQU 1 | INCL_DOSPROCESS EQU 1 | ||
PUSH WORD Frequency | PUSH WORD Frequency ;Frequency (in Hertz) | ||
PUSH WORD Duration | PUSH WORD Duration ;Length of sound (in milliseconds) | ||
CALL DosBeep | CALL DosBeep | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
==Example Code== | |||
This example generates a beep for 1 second (1,000 milliseconds) at a frequency of 1,380. | |||
<PRE> | |||
#define INCL_DOSPROCESS | |||
#define BEEP_FREQUENCY 1380 | |||
#define BEEP_DURATION 1000 | |||
USHORT rc; | |||
rc = DosBeep(BEEP_FREQUENCY, | |||
BEEP_DURATION); | |||
</PRE> | |||
[[Category: | [[Category:Dos16]] | ||
Latest revision as of 17:45, 1 May 2023
 Legacy Function Warning
| |
|---|---|
| It is recommended to use a newer replacement for this function. | |
| Replacement: | DosBeep |
| Remarks: | The function described here was part of the OS2 1.x API. It had been updated for modern OS/2 development, it is available at DosBeep. |
This call generates sound from the speaker.
Syntax
DosBeep (Frequency, Duration)
Parameters
- Frequency (USHORT) - input
- Tone in Hertz (cycles per second) in the range 37 through 32767.
- Duration (USHORT) - input
- Length of the sound in milliseconds.
Return Code
- rc (USHORT) - return
- Return code descriptions are:
- 0 NO_ERROR
- 395 ERROR_INVALID_FREQUENCY
Remarks
DosBeep executes synchronously. An application program that invokes DosBeep waits until the specified number of milliseconds expire before it resumes execution.
Bindings
C
#define INCL_DOSPROCESS USHORT rc = DosBeep(Frequency, Duration); USHORT Frequency; /* Hertz (Hz) */ USHORT Duration; /* Length of sound */ USHORT rc; /* return code */
MASM
EXTRN DosBeep:FAR INCL_DOSPROCESS EQU 1 PUSH WORD Frequency ;Frequency (in Hertz) PUSH WORD Duration ;Length of sound (in milliseconds) CALL DosBeep Returns WORD
Example Code
This example generates a beep for 1 second (1,000 milliseconds) at a frequency of 1,380.
#define INCL_DOSPROCESS
#define BEEP_FREQUENCY 1380
#define BEEP_DURATION 1000
USHORT rc;
rc = DosBeep(BEEP_FREQUENCY,
BEEP_DURATION);