Test for no <b>double</b> value.


Functions

double MKGetNoDVal (void)
 Returns the special NaN that the MusicKit uses to signal "no value".
int MKIsNoDVal (double value)
 Compares value to see if it is the special NaN that the MusicKit uses to signal "no value".

Function Documentation

double MKGetNoDVal ( void   )  [inline]

Returns the special NaN that the MusicKit uses to signal "no value".

A number of MusicKit functions and methods query for and return double-valued quantities, such as the values of parameters and time tags. By convention, the value MK_NODVAL is returned if the queried-for value hasn't been set; however, you can't test for this value directly. You must use the function MKIsNoDVal() instead, passing as the argument the value that you wish to test. The function returns nonzero if value is equal to MK_NODVAL and 0 if it isn't.

MKGetNoDVal() returns the no-double-value indicator. You use this function as the return value for functions and methods of your own design in which you wish to indicate that a double-valued quantity hasn't been set. For convenience, MK_NODVAL is defined as this function.

Returns:
Returns an int.
See also:
MKIsNoDVal().

int MKIsNoDVal ( double  value  )  [inline]

Compares value to see if it is the special NaN that the MusicKit uses to signal "no value".

A number of MusicKit functions and methods query for and return double-valued quantities, such as the values of parameters and time tags. By convention, the value MK_NODVAL is returned if the queried-for value hasn't been set; however, you can't test for this value directly. You must use the function MKIsNoDVal() instead, passing as the argument the value that you wish to test. The function returns nonzero if value is equal to MK_NODVAL and 0 if it isn't.

Parameters:
value is a double.
Returns:
Returns an int.


Generated on Sat Dec 5 17:01:14 2009 for MusicKit by  doxygen 1.5.6