Important: |
---|
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function plays a sound specified by a file name, resource, or system event.
Syntax
BOOL WINAPI PlaySound( LPCSTR pszSound, HMODULE hmod, DWORD fdwSound ); |
Parameters
- pszSound
-
Pointer to a null-terminated string that specifies the sound to play. If this parameter is NULL, any currently playing waveform sound is stopped. To stop a non-waveform sound, specify SND_PURGE in the fdwSoundparameter.
Three flags in fdwSound(SND_ALIAS, SND_FILENAME, and SND_RESOURCE) determine whether the name is interpreted as an alias for a system event, a file name, or a resource identifier. If none of these flags are specified, PlaySoundsearches the registry or the WIN.INI file for an association with the specified sound name. If an association is found, the sound event is played. If no association is found in the registry, the name is interpreted as a file name.
- hmod
-
Handle to the executable file that contains the resource to be loaded. This parameter must be NULL unless SND_RESOURCE is specified in fdwSound.
- fdwSound
-
Flags for playing the sound. The following table shows the possible values.
Value Description SND_ALIAS
The pszSoundparameter is a system-event alias in the registry or the WIN.INI file. Do not use with either SND_FILENAME or SND_RESOURCE.
SND_ASYNC
The sound is played asynchronously and PlaySoundreturns immediately after beginning the sound. To terminate an asynchronously played waveform sound, call PlaySoundwith pszSoundset to NULL.
SND_FILENAME
The pszSoundparameter is a file name.
SND_LOOP
The sound plays repeatedly until PlaySoundis called again with the pszSoundparameter set to NULL. You must also specify the SND_ASYNC flag to indicate an asynchronous sound event.
SND_MEMORY
A sound event's file is loaded in RAM. The parameter specified by pszSoundmust point to an image of a sound in memory.
SND_NODEFAULT
No default sound event is used. If the sound cannot be found, PlaySoundreturns silently without playing the default sound.
SND_NOSTOP
The specified sound event will yield to another sound event that is already playing. If a sound cannot be played because the resource needed to generate that sound is busy playing another sound, the function immediately returns FALSE without playing the requested sound.
If this flag is not specified, PlaySoundattempts to stop the currently playing sound so that the device can be used to play the new sound.
SND_NOWAIT
If the driver is busy, return immediately without playing the sound.
SND_RESOURCE
The pszSoundparameter is a resource identifier; hmodmust identify the instance that contains the resource. When creating the resource, you must identify it as being of the WAVE type, see Using PlaySound with a Resource Identifier.
SND_SYNC
Synchronous playback of a sound event. PlaySoundreturns after the sound event completes.
Return Value
TRUE indicates success. FALSE indicates failure.
Remarks
Windows Embedded CE does not support the SND_ALIAS_ID and SND_PURGE flags for the fdwSoundparameter. The sound specified by pszSoundmust fit into available physical memory and be playable by an installed waveform-audio device driver. PlaySoundsearches the file system directories for the sound according to the search order that was specified by the OEM of the target device. If it cannot find the specified sound, PlaySounduses the default system event sound entry instead. If the function can find neither the system default entry nor the default sound, it makes no sound and returns FALSE.
For examples of how to use the PlaySoundfunction, see Using the PlaySound Function.
Requirements
Header | mmsystem.h |
Library | coredll.lib |
Windows Embedded CE | Windows CE 2.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |