SE SetRootObject

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

extern SE_Return_Code
SE_SetRootObject
(
SE_Transmittal		transmittal_in,	¹
SE_Object		new_root_object_in,	²
SE_Object	*	old_root_object_out_ptr	³
);

Definition

Given a handle to a transmittal that has explicitly been opened in SE_AM_CREATECREATE or SE_AM_UPDATEUPDATE mode, set the passed DRM object as the root of the transmittal's object hierarchy. The previous root object, if any, is returned in the old_root_object_out_ptr parameter, if requested. If no root object has been set for the given transmittal, NULL is returned in old_root_object_out_ptr.

CAUTION Calling this function will permanently change the root object of the transmittal. In order to avoid orphaning objects within the transmittal, the old_root_object_out_ptr parameter is provided to allow the user to deal with any previously set root object. It is the user's responsibility to provide this argument as needed.

Returns

SE_RETCOD_SUCCESS	and the root object is set.
SE_RETCOD_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS	set if valid parameters were passed in and all operations succeeded.
SE_STATCODE_DIFFERENT_TRANSMITTAL	set if new_root_object_in does not belong to the given transmittal.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	set if new_root_object_in is not a resolved object.
SE_STATCODE_INVALID_ACCESS_MODE	set if transmittal_in was opened in read-only mode.
SE_STATCODE_INACTIONABLE_FAILURE	set if the call fails for any other reason.

Parameters Notes

¹ a handle to the transmittal for which the root object is being set.

² a pointer to the SE_Object handle of the new root object of the transmittal.

³ a pointer to the SE_Object handle to the previous root object of the transmittal.