Jump to content

DosBeep: Difference between revisions

From EDM2
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
==DosBeep==
==DosBeep==
 
To produce a beep from the speaker DosBeep is called with the frequency and the length of the beep as arguments.


===Syntax===
===Syntax===
rc = DosBeep( ''ulFrequency'', ''ulDuration'' );
rc = DosBeep( ''ulFrequency'', ''ulDuration'' );


===Parameters===
===Parameters===
; ULONG ''ulFrequency'' (input)
; ULONG ''ulFrequency'' (input)
: The frequency in Hertz (Hz) of the beep to be generated. In the range of 0x25 to 0x7FFF (37 to 32767).
: The frequency in Hertz (Hz) of the beep to be generated. In the range of 0x25 to 0x7FFF (37 to 32767).
Line 14: Line 12:


===Returns===
===Returns===
  APIRET  rc
  APIRET  rc
  0      NO_ERROR
  0      NO_ERROR
Line 21: Line 17:


===Include Info===
===Include Info===
  #define INCL_DOSPROCESS
  #define INCL_DOSPROCESS
  #include <os2.h>
  #include <os2.h>
===Usage Explanation===
To produce a beep from the speaker DosBeep is called with the frequency and the length of the beep as arguments.
===Relevant Structures===
===Gotchas===


===Sample Code===
===Sample Code===
  #define INCL_DOSPROCESS
  #define INCL_DOSPROCESS
  #include <os2.h>
  #include <os2.h>
Line 46: Line 32:


===See Also===
===See Also===
* [[DosDevConfig]]
* [[DosDevIOCtl]]
* [[DosPhysicalDisk]]


* [[OS2 API:CPI:DosDevConfig|DosDevConfig]]
[[Category:Dos]]
* [[OS2 API:CPI:DosDevIOCtl|DosDevIOCtl]]
* [[OS2 API:CPI:DosPhysicalDisk|DosPhysicalDisk]]
 
[[Category:The OS/2 API Project]]

Revision as of 22:34, 10 November 2016

DosBeep

To produce a beep from the speaker DosBeep is called with the frequency and the length of the beep as arguments.

Syntax

rc = DosBeep( ulFrequency, ulDuration );

Parameters

ULONG ulFrequency (input)
The frequency in Hertz (Hz) of the beep to be generated. In the range of 0x25 to 0x7FFF (37 to 32767).
ULONG ulDuration (input)
The duration of the beep to be generated. In milliseconds.

Returns

APIRET  rc
0       NO_ERROR
395     ERROR_INVALID_FREQUENCY

Include Info

#define INCL_DOSPROCESS
#include <os2.h>

Sample Code

#define INCL_DOSPROCESS
#include <os2.h>
#include <stdio.h>    /* For printf */

if(DosBeep(400, 300)) /* Beep a 400 Hz tone for 0.3 seconds */
{
    printf("Invalid frequency to DosBeep()\n"); /* In case of error, should not */
}                                               /* be called now when the       */
                                                /* frequency is 400 Hz          */

See Also