SEDRIS Reference Manual
APPENDIX B - Transmittal Access Level 1 API
Functions
SE SoundNameFromSoundInstance
extern SE_Status_Code
SE_SoundNameFromSoundInstance
(
SE_Object object_in,1
SE_Store store_in,2
constSE_String **result_out_ptr3
);

Definition

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


Returns

SE_STATCODE_SUCCESS and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.
SE_STATCODE_UNRESOLVED_INPUT_OBJECT and no changes are made if object_in is unresolved.
SE_STATCODE_NO_OBJECT and no changes are made if object_in isn't associated to a <Sound> instance.
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT and no changes are made if object_in's associated <Sound> instance is unresolved and could not be resolved.
SE_STATCODE_C_STORE_INVALID set if store_in is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE and no changes are made if
  1. the <Sound> is invalid, or
  2. the call fails for any reason.

Parameters Notes

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

2 store to manage the memory being retrieved

3 pointer to a handle to the name being retrieved


Prev: SE_SimpleCreateComponentIterator. Next: SE_ValidDesiredImageParameters. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS