Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Support Forum
Download Visual Studio Add-In

Terms of Use
Privacy Policy
waveoutgeterrortext (winmm)
 
.
Summary
The waveOutGetErrorText function retrieves a textual description of the error identified by the given error number.

C# Signature:

      private const int MAXERRORLENGTH = 256;

      /// <summary>
      /// This function gets a string describing the error returned from one of the wave functions.
      /// </summary>
      /// <param name="mmrError">The error code</param>
      /// <param name="pszText">String returning the text description</param>
      /// <param name="cchText">The size of the string</param>
      /// <returns>NOERROR success, otherwise fail.</returns>
      [DllImport ("winmm.dll", EntryPoint="waveOutGetErrorText", SetLastError=true, CharSet=CharSet.Auto)]
      private static extern uint waveOutGetErrorText(uint mmrError, StringBuilder pszText, uint cchText);

      /// <summary>
      /// This function gets a string describing the error returned from one of the wave functions.
      /// </summary>
      /// <param name="mmrError">The error code</param>
      /// <returns>The description</returns>
      public static string waveOutGetErrorText(int mmrError)
      {
        StringBuilder message = new StringBuilder(MAXERRORLENGTH);
        uint errorResult = waveOutGetErrorText(mmrError, message, (uint)message.Capacity);
        if (errorResult == 0)
        {    
          return message.ToString();
        }
        else
        {
          return "waveOutGetErrorText failed.";
        }
      }

VB Signature:

Declare Function waveOutGetErrorText Lib "winmm.dll" (TODO) As TODO

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

Please add some!

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions