Set and retrieve a MKNote's parameters. Functions that are equivalent to MKNote methods, for speed.

Functions
id	MKSetNoteParToDouble (MKNote *aNote, int par, double value)
	Set a MKNote's parameter to a double value.
id	MKSetNoteParToInt (MKNote *aNote, int par, int value)
	Set a MKNote's parameter to an integer value.
id	MKSetNoteParToString (MKNote *aNote, int par, NSString *value)
	Set a MKNote's parameter to a NSString value.
id	MKSetNoteParToEnvelope (MKNote *aNote, int par, id envObj)
	Set a MKNote's parameter to a MKEnvelope value.
id	MKSetNoteParToWaveTable (MKNote *aNote, int par, id waveObj)
	Set a MKNote's parameter to a MKWaveTable value.
id	MKSetNoteParToObject (MKNote *aNote, int par, id anObj)
	Set a MKNote's parameter to an Object value.
double	MKGetNoteParAsDouble (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as a double value.
int	MKGetNoteParAsInt (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as an integer value.
NSString *	MKGetNoteParAsString (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as a NSString value.
NSString *	MKGetNoteParAsStringNoCopy (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as a NSString value.
id	MKGetNoteParAsEnvelope (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as an MKEnvelope value.
id	MKGetNoteParAsWaveTable (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as an MKWaveTable value.
id	MKGetNoteParAsObject (MKNote *aNote, int par)
	Retrieve an MKNote's parameter as an object value.

---

Function Documentation

double MKGetNoteParAsDouble	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as a double value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote instance.
	par	is an int.

Returns:

The MKGetParAs...() functions return the requested value, or nil if either aNote is nil of par isn't a valid parameter identifier. If the parameter value hasn't been set, an indicative value is returned:

Function	No-set return value
MKGetNoteParAsInt()	MAXINT
MKGetNoteParAsDouble()	MK_NODVAL (check with MKIsNoDVal())
MKGetNoteParAsString()	""
MKGetNoteParAsStringNoCopy()	""
MKGetNoteParAsEnvelope()	nil
MKGetNoteParAsWaveTable()	nil
MKGetNoteParAsObject()	nil

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal().

id MKGetNoteParAsEnvelope	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as an MKEnvelope value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar: MK_freq toDouble: 440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a Note.
	par	is an int.

Returns:

Returns an MKEnvelope instance.

See also:

MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

int MKGetNoteParAsInt	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as an integer value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote instance.
	par	is an int.

Returns:

Returns an integer.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKGetNoteParAsObject	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as an object value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a Note.
	par	is an int.

Returns:

Returns an id.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

NSString* MKGetNoteParAsString	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as a NSString value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a Note.
	par	is an int.

Returns:

Returns an NSString instance.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

NSString* MKGetNoteParAsStringNoCopy	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as a NSString value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote instance.
	par	is an int.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKGetNoteParAsWaveTable	(	MKNote *	aNote,
		int	par
	)

Retrieve an MKNote's parameter as an MKWaveTable value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote instance.
	par	is an int.

Returns:

Returns an MKWaveTable instance.

See also:

MKSetNoteParToDouble, MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKSetNoteParToDouble	(	MKNote *	aNote,
		int	par,
		double	value
	)

Set a MKNote's parameter to a double value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is an MKNote instance.
	par	is an int.
	value	is a double.

Returns:

The MKSetParTo...() functions return aNote, or nil if either aNote is nil or par isn't a valid parameter identifier.

The MKGetParAs...() functions return the requested value, or nil if either aNote is nil of par isn't a valid parameter identifier. If the parameter value hasn't been set, an indicative value is returned:

Function	No-set return value
MKGetNoteParAsInt()	MAXINT
MKGetNoteParAsDouble()	MK_NODVAL (check with MKIsNoDVal())
MKGetNoteParAsString()	""
MKGetNoteParAsStringNoCopy()	""
MKGetNoteParAsEnvelope()	nil
MKGetNoteParAsWaveTable()	nil
MKGetNoteParAsObject()	nil

See also:

MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal().

id MKSetNoteParToEnvelope	(	MKNote *	aNote,
		int	par,
		id	envObj
	)

Set a MKNote's parameter to a MKEnvelope value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is an MKNote instance.
	par	is an int.
	envObj	is an MKEnvelope instance.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKSetNoteParToInt	(	MKNote *	aNote,
		int	par,
		int	value
	)

Set a MKNote's parameter to an integer value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote isntance.
	par	is an int.
	value	is an int.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKSetNoteParToObject	(	MKNote *	aNote,
		int	par,
		id	anObj
	)

Set a MKNote's parameter to an Object value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar:MK_freq toDouble:440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote instance.
	par	is an int.
	anObj	is an id.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKSetNoteParToString	(	MKNote *	aNote,
		int	par,
		NSString *	value
	)

Set a MKNote's parameter to a NSString value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar: MK_freq toDouble: 440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is a MKNote instance.
	par	is an int.
	value	is a NSString.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()

id MKSetNoteParToWaveTable	(	MKNote *	aNote,
		int	par,
		id	waveObj
	)

Set a MKNote's parameter to a MKWaveTable value.

These functions set and retrieve the values of a MKNote's parameters, one parameter at a time. They're equivalent to the similarly named MKNote methods; for example, the function call

MKSetNoteParToDouble(aNote, MK_freq, 440.0)

is the same as the message:

[aNote setPar: MK_freq toDouble: 440.0]

As ever, calling a function is somewhat faster than sending a message, thus you may want to use these functions, rather than the corresponding methods, if you're examining and manipulating barrels of parameters, or in situations where speed is crucial. See the method descriptions in the MKNote class for more information (by implication) regarding the operations of these functions.

Parameters:

	aNote	is an MKNote instance.
	par	is an int.
	waveObj	is a MKWaveTable instance.

See also:

MKSetNoteParToDouble(), MKIsNoteParPresent(), MKInitParameterIteration(), MKNextParameter(), MKIsNoDVal()