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".
SE_NULL_REQUIRED_PARAMETER - and object_in is left unaltered, if label_in is NULL.
SE_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_UNRESOLVED_OBJECT - and object_in is left unaltered, if object_in was not a resolved object.
SE_UNPUBLISHED_OBJECT - and object_in is left unaltered, if object_in was not published under the given label.
SE_INVALID_ACCESS_MODE - and object_in is left unaltered, if object_in belongs to a transmittal opened in read-only mode.
SE_FAILURE - and no changes are made, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.
| extern SE_STATUS_CODE_ENUM | ||||
| SE_UnpublishObject | ||||
| ( | ||||
| SE_OBJECT | object_in, | (notes) | ||
| const | char | * | label_in | (notes) |
| ); | ||||
handle to the object to be unpublished; must be
resolved.
a character string containing the label under which the object
was previously published.