Tone Helper Methods

Use these helper methods to test the return values for Tone class methods. Helper methods do not alter the stored result code.

IsResultSuccess

Tests the result code from the most recent Tone method called and returns true if no fault occurred.

public bool IsResultSuccess()

IsResultError

Tests the result code from the most recent Tone method called and returns true if a fault occurred.

public bool IsResultError()

IsResultMethodNotSupported

Tests the result code from the most recent Tone method called and returns true if the Tone class is not supported by the computer.

public bool IsResultMethodNotSupported()

ResultMessage

Returns a string describing the result code from the most recent Tone method called.

public string ResultMessage()

Static Methods

IsResultSuccess(int Result)

Tests the specified result code and returns true if no fault occurred.

public static bool IsResultSuccess( int Result )

where Result is a 32-bit value representing the status or outcome from the execution of a Tone method.

IsResultError(int Result)

Tests the specified return code and returns true if a fault occurred.

public static bool IsResultError( int Result )

where Result is a 32-bit value representing the status or outcome from the execution of a Tone method.

IsResultMethodNotSupported(int Result)

Tests the specified return code and returns true if Tone is not supported by the computer.

public static bool IsResultMethodNotSupported( int Result )

where Result is a 32-bit value representing the status or outcome from the execution of a Tone method.

ResultMessage(int Result)

Returns a string describing the specified result code (returned from a previous Tone method).

public static string ResultMessage( int Result )

where Result is a 32-bit value representing the status or outcome from the execution of a Tone method.

More Information

Tone Class