SE SoundNameFromSoundInstance

SEDRIS Reference Manual APPENDIX B - Transmittal Access Level 1 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)
);

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

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

SE_STAT_CODE_UNRESOLVED_INPUT_OBJECT and no changes are made if object_in is unresolved.

SE_STAT_CODE_NO_OBJECT and no changes are made if object_in isn't associated to a <Sound> instance.

SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT and no changes are made if object_in's associated <Sound> instance is unresolved and could not be resolved.

SE_STAT_CODE_INACTIONABLE_FAILURE and no changes are made if

the <Sound> is invalid, or

the call fails for any reason.

Parameters Notes

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

 store to manage the memory being retrieved

 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_UNRESOLVED_INPUT_OBJECT	and no changes are made if object_in is unresolved.
SE_STAT_CODE_NO_OBJECT	and no changes are made if object_in isn't associated to a <Sound> instance.
SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT	and no changes are made if object_in's associated <Sound> instance is unresolved and could not be resolved.
SE_STAT_CODE_INACTIONABLE_FAILURE	and no changes are made if the <Sound> is invalid, or the call fails for any reason.