SE PublishObject

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

extern SE_Status_Code
SE_PublishObject
(
	SE_Object		object_in,	(notes)
const	char	*	label_in	(notes)
);

Definition

Given a resolved SE_Object, make the object available for ITR referencing by listing it as "published" within the transmittal. If the object has already been published, then the new label is added to the list of labels for the object.

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 object_in is successfully published, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and object_in is left unaltered, if label_in is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and object_in is left unaltered, if object_in is not a handle to a valid, active (i.e., not freed), object.

SE_STAT_CODE_UNRESOLVED_OBJECT and object_in is left unaltered, if object_in was not a resolved object.

SE_STAT_CODE_INVALID_OBJECT_LABEL and object_in is left unaltered, if label_in does not adhere to the same lexical conventions as variables in ANSI C or is already in use.

SE_STAT_CODE_INVALID_ACCESS_MODE and object_in is left unaltered, if object_in belongs to a transmittal opened in read-only mode.

SE_STAT_CODE_FAILURE and object_in is left unaltered, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

object_in

 the handle of the object to be published.

label_in

 a character string containing the label under which the object
    should be published.  The label must adhere to same lexical conventions
    as variables in ANSI C.

SE_STAT_CODE_SUCCESS	and object_in is successfully published, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and object_in is left unaltered, if label_in is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and object_in is left unaltered, if object_in is not a handle to a valid, active (i.e., not freed), object.
SE_STAT_CODE_UNRESOLVED_OBJECT	and object_in is left unaltered, if object_in was not a resolved object.
SE_STAT_CODE_INVALID_OBJECT_LABEL	and object_in is left unaltered, if label_in does not adhere to the same lexical conventions as variables in ANSI C or is already in use.
SE_STAT_CODE_INVALID_ACCESS_MODE	and object_in is left unaltered, if object_in belongs to a transmittal opened in read-only mode.
SE_STAT_CODE_FAILURE	and object_in is left unaltered, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.