SE CloneAnimationSelectParameters

SEDRIS Reference Manual APPENDIX C - Transmittal Access Level 0 API Auxiliary Functions Functions SE CloneAnimationSelectParameters

extern SE_Status_Code
SE_CloneAnimationSelectParameters
(
const	SE_Animation_Select_Parameters	*	src_ptr,	¹
	SE_Animation_Select_Parameters	*	dest_ptr	²
);

Definition

Clones the data from *src_ptr into *dest_ptr, by allocating memory for any necessary internal pointers within *dest_ptr, then populating *dest_ptr with data from *src_ptr.

IMPORTANT NOTES:

Because some of the fields contained in the data structure are pointers to dynamically allocated memory, it is HIGHLY INADVISABLE to use a member-wise structure copy in order to duplicate an SE_Animation_Select_Parameters structure. In order to reliably duplicate this data, developers should use the SE_CloneAnimationSelectParameters() function.
The caller is responsible for calling SE_FreeAnimationSelectParameters() to free the internal pointers allocated within *dest_ptr.

Returns

SE_STATCODE_SUCCESS	and memory is allocated for any dynamically allocated data within the structure, which is then populated with data copied from *src_ptr, if valid parameters were passed in and all operations succeeded.
SE_STATCODE_INACTIONABLE_FAILURE	and *dest_ptr is initialized to empty, if this call failed for any reason.

Parameters Notes

¹ the SE_Animation_Select_Parameters that is to be duplicated

² a pointer to an SE_Animation_Select_Parameters structure within memory managed by the caller. Non-dynamically allocated fields in this structure will be directly populated with data from the input fields. Dynamically allocated data will be allocated by this function, then copied from the input structure.