SE CreateObject

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

extern SE_Status_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_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_STAT_CODE_NULL_REQUIRED_PARAMETER and *new_object_out_ptr is unaffected, if new_object_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and *new_object_out_ptr is set to NULL, if transmittal is not a handle to a valid, active (i.e., open) transmittal.

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_OUT_OF_MEMORY and *new_object_out_ptr is set to NULL, if memory can't be allocated for the new object.

SE_STAT_CODE_FAILURE and *new_object_out_ptr is set to NULL, 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_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_STAT_CODE_NULL_REQUIRED_PARAMETER	and *new_object_out_ptr is unaffected, if new_object_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and *new_object_out_ptr is set to NULL, if transmittal is not a handle to a valid, active (i.e., open) transmittal.
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_OUT_OF_MEMORY	and *new_object_out_ptr is set to NULL, if memory can't be allocated for the new object.
SE_STAT_CODE_FAILURE	and *new_object_out_ptr is set to NULL, 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.