SEDRIS Reference Manual
APPENDIX B - LEVEL 1 READ and WRITE API
Functions
SE AddObjectToAggregate
extern SE_Status_Code
SE_AddObjectToAggregate
(
SE_Object aggregate_object, (notes)
SE_DRM_Class new_object_tag, (notes)
SE_FIELDS_PTR new_fields (notes)
);

Definition

Creates an object of the given class, sets its fields, adds it to a transmittal, creates its relationship to the given aggregate, then frees the new component object.

Note that this function does not return the object that has just been created. To access that object, you must retrieve it with another function, e.g. SE_GetNextObject() after creating an iterator.

The transmittal whose object is to be edited must be explicitly opened in UPDATE mode for this operation to succeed.


Returns

SE_STAT_CODE_SUCCESS and the requested object is created as specified, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER and no changes are made, if new_object_tag is SE_DRM_CLS_NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT and no changes are made, if aggregate_object is NULL, does not belong to a valid DRM class, or does not belong to a valid transmittal.
SE_STAT_CODE_UNRESOLVED_START_OBJECT and no changes are made, if aggregate_object is unresolved.
SE_STAT_CODE_INVALID_ACCESS_MODE and no changes are made, if aggregate_object belongs to a transmittal opened in SE_AC_MODE_READ_ONLY mode.
SE_STAT_CODE_OUT_OF_MEMORY and no changes are made, if no memory can be allocated for the new object.
SE_STAT_CODE_FAILURE and no changes are made, if
  1. new_fields is provided, but not consistent with new_object_tag
  2. dynamic binding is used, and the specified API implementation does not provide the necessary level 0 functions (e.g. SE_CreateObject()).


Parameters Notes


aggregate_object

 existing object, for which we are creating and adding a component

new_object_tag

 the DRM class of the new object being created

new_fields

 if present, used instead of the default fields for the new object


Next: SE_AllocDataTableData. Up:Index.

Last updated: May 15, 2003 Copyright © 2003 SEDRIS™