Function Name: Put Fields

Definition

Used to modify the fields of a given object. The object passed in must be one returned from the level 0 read API or one returned from SE_CreateObject() in the level 0 write API. Updating fields may have implications on the efficiency of the underlying implementation if overall size of the field data (and the separately allocated sub-structures) is larger than the previous values. For example, if the fields include an SE_STRING type, and the length of the string changes, there may be implications on the efficiency of the underlying API implementation.

Returns

SE_INVALID_OR_NULL_OBJECT - and existing object is left unaltered, if existing_object is not a handle to a valid, active (i.e., unfreed) SEDRIS object. In this case, no changes are made.

SE_UNRESOLVED_OBJECT - and existing object is left unaltered, if existing_object is an unresolved object.

SE_INVALID_ACCESS_MODE - and existing object is left unaltered, if the transmittal containing existing_object was opened in read-only mode.

SE_OUT_OF_MEMORY - and existing object is left unaltered, if the new fields of existing_object cannot be allocated.

SE_FAILURE - and existing object is left unaltered, if

1. new_fields' class doesn't match that of existing_object, or
2. the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype

Parameters Notes

existing_object

 handle to the object whose fields
    are being modified by this function.

new_fields

 a variable in the user's memory from
    which the SE_FIELDS will be copied to create the fields of the
    existing object.