SE PutFields

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

extern SE_Return_Code
SE_PutFields
(
SE_Object	existing_object,	¹
SE_FIELDS_PTR	new_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.

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

Returns

SE_RETCOD_SUCCESS	and the data is stored in the tranmittal.
SE_RETCOD_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS

set if valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT	set if existing_object is an unresolved object.
SE_STATCODE_INVALID_ACCESS_MODE	set if the transmittal containing existing_object was opened in read-only mode.
SE_STATCODE_INACTIONABLE_FAILURE	set if new_fields' class doesn't match that of existing_object, new_fields does not pass SE_ValidFields(), or this call fails for any other reason.

Parameters Notes

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

² a variable in the user's memory from which the SE_DRM_Class_Fields will be copied to create the fields of the existing_object.