SE CloneObject

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE CloneObject

extern SE_Status_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_STAT_CODE_SUCCESS and a clone of object_in is copied into *new_object_out_ptr, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *new_object_out_ptr is left unaltered, if new_object_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *new_object_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_STAT_CODE_OUT_OF_MEMORY and *new_object_out_ptr is set to NULL, if a new SE_Object cannot be allocated.

SE_STAT_CODE_FAILURE and *new_object_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 object that is being cloned.

new_object_out_ptr

 the clone.

SE_STAT_CODE_SUCCESS	and a clone of object_in is copied into *new_object_out_ptr, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *new_object_out_ptr is left unaltered, if new_object_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *new_object_out_ptr is set to NULL, if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.
SE_STAT_CODE_OUT_OF_MEMORY	and *new_object_out_ptr is set to NULL, if a new SE_Object cannot be allocated.
SE_STAT_CODE_FAILURE	and *new_object_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.