Function Name: Clone Object

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

SE_NULL_REQUIRED_PARAMETER - and *new_object_out_ptr is left unaltered, if new_object_out_ptr is NULL.

SE_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_OUT_OF_MEMORY - and *new_object_out_ptr is set to NULL, if a new SE_OBJECT cannot be allocated.

SE_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.

Prototype


extern SE_STATUS_CODE_ENUM
SE_CloneObject
(
SE_OBJECT object_in, (notes)
SE_OBJECT *new_object_out_ptr (notes)
);

Parameters Notes

object_in

 object that is being cloned.

new_object_out_ptr

 the clone.
Prev: Assign Reference Symbol To Object. Next: Close Transmittal. Up:Index.