SE SoundNameFromSoundInstance

SEDRIS Reference Manual APPENDIX B - LEVEL 1 READ and WRITE API Functions SE SoundNameFromSoundInstance

extern SE_Status_Code
SE_SoundNameFromSoundInstance
(
	SE_Object			object_in,	(notes)
	SE_Store			store_in,	(notes)
const	SE_String	*	*	result_out_ptr	(notes)
);

Definition

Given a <Sound Instance>, retrieves the name of the associated <Sound>.

Returns

SE_STAT_CODE_SUCCESS and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and no changes were made, if result_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and result_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) <Sound Instance>.

SE_STAT_CODE_INVALID_OR_NULL_STORE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid, active (i.e., unfreed) store.

SE_STAT_CODE_UNRESOLVED_START_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is unresolved.

SE_STAT_CODE_NO_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in isn't associated to a <Sound> instance.

SE_STAT_CODE_UNRESOLVED_OBJECT and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in's associated <Sound> instance is unresolved and could not be resolved.

SE_STAT_CODE_OUT_OF_MEMORY and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory cannot be allocated for an intermediate operation.

SE_STAT_CODE_FAILURE and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if

the <Sound> is invalid, or

the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 <Sound Instance> whose <Sound> we're identifying

store_in

 store to manage the memory being retrieved

result_out_ptr

 pointer to a handle to the name being retrieved

SE_STAT_CODE_SUCCESS	and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and no changes were made, if result_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and result_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) <Sound Instance>.
SE_STAT_CODE_INVALID_OR_NULL_STORE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid, active (i.e., unfreed) store.
SE_STAT_CODE_UNRESOLVED_START_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in is unresolved.
SE_STAT_CODE_NO_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in isn't associated to a <Sound> instance.
SE_STAT_CODE_UNRESOLVED_OBJECT	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if object_in's associated <Sound> instance is unresolved and could not be resolved.
SE_STAT_CODE_OUT_OF_MEMORY	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if memory cannot be allocated for an intermediate operation.
SE_STAT_CODE_FAILURE	and the output parameters are set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the <Sound> is invalid, or the API implementation specified does not provide the necessary underlying functions in its shared library, and dynamic binding is specified at compile time.