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.

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 fields of the given object are replaced with the given fields, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_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.
SE_STAT_CODE_UNRESOLVED_OBJECT	and existing_object is left unaltered, if existing_object is an unresolved object.
SE_STAT_CODE_INVALID_ACCESS_MODE	and existing_object is left unaltered, if the transmittal containing existing_object was opened in read-only mode.
SE_STAT_CODE_OUT_OF_MEMORY	and existing_object is left unaltered, if the new fields of existing_object cannot be allocated.
SE_STAT_CODE_FAILURE	and existing_object is left unaltered, if new_fields' class doesn't match that of existing_object, the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

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.

Prev: SE_PutElementOfDataTableSubExtent. Next: SE_PutImageData. Up:Index.

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