SE CloneObject

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE CloneObject

extern SE_Return_Code
SE_CloneObject
(
SE_Object		object_in,	(notes)
SE_Object	*	new_object_out_ptr	(notes)
);

Definition

Clones an object by allocating a new SE_Object and copying the given object into the new SE_Object. Unlike SE_GetNextObject(), this function always allocates a brand-new object for the *new_object_out_ptr being returned.

Returns

SE_RET_CODE_SUCCESS and the requested object is cloned, if valid parameters were passed in and all operations succeeded.

SE_RET_CODE_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:

SE_STAT_CODE_SUCCESS set if operation successfully completed.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INACTIONABLE_FAILURE set if the call failed for any reason.

Parameters Notes

object_in

 object that is being cloned.

new_object_out_ptr

 the clone.

SE_RET_CODE_SUCCESS	and the requested object is cloned, if valid parameters were passed in and all operations succeeded.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.