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:

1. 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_Alt_Hierarchy_Parameters structure. In order to reliably duplicate this data, developers should use the SE_CloneAltHierarchyParameters() function.
2. The caller is responsible for calling SE_FreeAltHierarchyParameters() to free the internal pointers allocated within *dest_ptr.

Returns

SE_STAT_CODE_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_STAT_CODE_NULL_REQUIRED_PARAMETER	and no changes are made, if src_ptr or dest_ptr was NULL.
SE_STAT_CODE_OUT_OF_MEMORY	and *dest_ptr is initialized to empty, if memory allocation could not be performed.
SE_STAT_CODE_FAILURE	and *dest_ptr is initialized to empty, if *src_ptr is invalid.

Parameters Notes

src_ptr

 the SE_Alt_Hierarchy_Parameters that is to be duplicated

dest_ptr

 a pointer to an SE_Alt_Hierarchy_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.

Prev: SE_CellCountForSubExtent. Next: SE_CloneAnimationSelectParameters. Up:Index.

Last updated: May 15, 2003 Copyright © 2003 SEDRIS™