Function Name: Sound Name From Sound Instance

Definition

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

Returns

SE_SUCCESS - and the <Sound>'s name field is copied into buffer, if valid parameters were passed in and all operations succeeded.

SE_NULL_REQUIRED_PARAMETER - and no changes are made, if buffer or max_size_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - and buffer is set to the empty string, and *max_size_ptr is set to zero (0), if object_in is not a handle to a valid, active (i.e., unfreed) <Sound Instance>.

SE_UNRESOLVED_START_OBJECT - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if object_in is unresolved.

SE_NO_OBJECT - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if object_in's associated object cannot be found.

SE_UNRESOLVED_OBJECT - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if object_in's associated object is unresolved and could not be resolved.

SE_OUT_OF_MEMORY - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if memory could not be allocated during an intermediate operation.

SE_FAILURE - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if the 's fields could not be retrieved.

Prototype


extern SE_STATUS_CODE_ENUM
SE_SoundNameFromSoundInstance
(
SE_OBJECT object_in, (notes)
char *buffer, (notes)
SE_UINT16 *max_size_ptr (notes)
);

Parameters Notes

object_in

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

buffer

 to which <Sound>'s name is printed; must be allocated by the user

max_size_ptr

 initially, pointer to the maximum size of buffer; reset to the
 length of the string. If the string length is greater than the
 maximum size, we will not overflow the buffer, but *max_size_ptr
 would still be set to the name's original length
Prev: Simple Create Component Iterator. Up:Index.