SE CloneHierarchyOrderParameters

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

extern SE_Status_Code
SE_CloneHierarchyOrderParameters
(
const	SE_Hierarchy_Order_Parameters	*	src_ptr,	¹
	SE_Hierarchy_Order_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_Hierarchy_Order_Parameters structure. In order to reliably duplicate this data, developers should use the SE_CloneHierarchyOrderParameters() function.
The caller is responsible for calling SE_FreeHierarchyOrderParameters() 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 no changes are made, if src_ptr or dest_ptr was NULL.
SE_STATCODE_OUT_OF_MEMORY	and *dest_ptr is initialized to empty, if memory allocation could not be performed.
SE_STATCODE_INACTIONABLE_FAILURE	and dest_ptr is initialized to empty, if src_ptr is invalid.

Parameters Notes

¹ the SE_Hierarchy_Order_Parameters that is to be duplicated

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