SE CreateObject

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

extern SE_Return_Code
SE_CreateObject
(
SE_Transmittal		transmittal,	(notes)
SE_DRM_Class		new_object_tag,	(notes)
SE_Object	*	new_object_out_ptr	(notes)
);

Definition

Used to create a new object. The DRM class of the object must be specified. The object's fields are initialized to the default values for that class.

The object is immediately committed to the transmittal upon this call.

Returns

SE_RET_CODE_SUCCESS and the object is created.

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 and the new object is created, added to the specified transmittal, and a handle to it is placed in *new_object_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:

SE_STAT_CODE_INVALID_ACCESS_MODE and *new_object_out_ptr is set to NULL, if transmittal was opened in read-only mode.

SE_STAT_CODE_INACTIONABLE_FAILURE set if

new_object_tag does not correspond to a valid, concrete (i.e., not abstract) DRM class, or

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

transmittal

 the transmittal in which the object is being created.

new_object_tag

 the DRM class of the object being created.

new_object_out_ptr

 pointer to a variable, passed in by the user,
    in which a handle to the object being created will be placed.

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

SE_STAT_CODE_INVALID_ACCESS_MODE	and *new_object_out_ptr is set to NULL, if transmittal was opened in read-only mode.
SE_STAT_CODE_INACTIONABLE_FAILURE	set if new_object_tag does not correspond to a valid, concrete (i.e., not abstract) DRM class, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.