SE UnpublishObject

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

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

Definition

Given a resolved SE_Object, remove the object from being published under the given label. The object must have already been published under the label, for this function to work. Attempts to unpublish using an invalid object / label pair will fail.

IMPORTANT
Unpublishing objects MAY result in a need to change the transmittal name portion of the URN assigned to a transmittal. Using the same transmittal name guarantees that all labels ever published will remain available in future "versions" of the transmittal. Removing a label using this function will require a transmittal name change if another object is not published under the same label before the transmittal is made publicly available or "released".

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 unpublished, 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 (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_UNPUBLISHED_OBJECT and object_in is left unaltered, if object_in was not published under the given label.

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

 handle to the object to be unpublished; must be
    resolved.

label_in

 a character string containing the label under which the object
     was previously published.

SE_STAT_CODE_SUCCESS	and object_in is unpublished, 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 (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_UNPUBLISHED_OBJECT	and object_in is left unaltered, if object_in was not published under the given label.
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.