Identify and return objects by name.

Functions
BOOL	MKNameObject (NSString *name, id object)
	Adds the object object into the table, with name name.
NSString *	MKGetObjectName (id object)
	Returns object name if any.
id	MKRemoveObjectName (id object)
	Removes its argument's name (if any) and returns nil.
id	MKGetNamedObject (NSString *name)
	Returns the first object in the name table that has the name name.
BOOL	MKAddGlobalScorefileObject (id object, NSString *name)
	Allows giving an object a name that can be seen by a scorefile.
id	MKGetGlobalScorefileObject (NSString *name)
	Returns the global scorefile object with the given name.

---

Function Documentation

BOOL MKAddGlobalScorefileObject	(	id	object,
		NSString *	name
	)

Allows giving an object a name that can be seen by a scorefile.

Adds the object as a global scorefile object, referenced in the scorefile with the name specified. The name is copied. The object does not become visible to a scorefile unless it explicitly 'imports' it by a getGlobal statement. If there is already a global scorefile object with the specified name, does nothing and returns NO. Otherwise returns YES. The type of the object in the scorefile is determined as follows: If object -isKindOfClass: MKWaveTable, then the type is MK_waveTable. If object -isKindOfClass: MKEnvelope, then the type is MK_envelope. Otherwise, the type is MK_object. Note that the global scorefile table is independent of the MusicKit name table. Thus, an object can be named in one and unnamed in the other, or it can be named differently in each.

Parameters:

	object	The object to be named.
	name	The NSString instance containing the name.

id MKGetGlobalScorefileObject

(

NSString *

name

)

Returns the global scorefile object with the given name.

Allows you to give an object a name that can be seen by a scorefile. The object may be either one that was added with MKAddGlobalScorefileObject or it may be one that was added from within a scorefile using "putGlobal". Objects accessible to the application are those of type MK_envelope, MK_waveTable and MK_object.

id MKGetNamedObject

(

NSString *

name

)

Returns the first object in the name table that has the name name.

The MusicKit provides a global naming mechanism that lets you identify and locate objects by name. While names are primarily used in reading and writing scorefiles, any object - even a non-MusicKit object - can be named. Names needn't be unique; more than one object can be given the same name. However, a single object can have but one name at a time.

Parameters:

name

is an NSString instance.

Returns:

Returns an id.

See also:

MKNameObject().

NSString* MKGetObjectName

(

id

object

)

Returns object name if any.

The MusicKit provides a global naming mechanism that lets you identify and locate objects by name. While names are primarily used in reading and writing scorefiles, any object - even a non-MusicKit object - can be named. Names needn't be unique; more than one object can be given the same name. However, a single object can have but one name at a time.

MKGetObjectName() returns its argument's name, or NULL if it isn't named. The returned value is read-only and shouldn't be freed by the caller.

Parameters:

object

is an id.

Returns:

Returns an NSString instance. If object is not found, returns NULL.

See also:

MKNameObject().

BOOL MKNameObject	(	NSString *	name,
		id	object
	)

Adds the object object into the table, with name name.

The MusicKit provides a global naming mechanism that lets you identify and locate objects by name. While names are primarily used in reading and writing scorefiles, any object - even a non-MusicKit object - can be named. Names needn't be unique; more than one object can be given the same name. However, a single object can have but one name at a time.

MKNameObject() sets object's name to a copy of name and returns YES. If the object already has a name, then this function does nothing and returns NO.

Parameters:

	name	is an NSString instance.
	object	is an id.

Returns:

Returns a BOOL.

id MKRemoveObjectName

(

id

object

)

Removes its argument's name (if any) and returns nil.

The MusicKit provides a global naming mechanism that lets you identify and locate objects by name. While names are primarily used in reading and writing scorefiles, any object - even a non-MusicKit object - can be named. Names needn't be unique; more than one object can be given the same name. However, a single object can have but one name at a time.

Parameters:

object

is an id.

Returns:

Returns an id.

See also:

MKNameObject().