|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE UnpublishObject |
|---|
| extern SE_Return_Code | ||||
| SE_UnpublishObject | ||||
| ( | ||||
| SE_Object | object_in, | (notes) | ||
| const | char | * | label_in | (notes) |
| ); | ||||
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.
| SE_RET_CODE_SUCCESS | and the object is unpublished. |
| SE_RET_CODE_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:
| SE_STAT_CODE_SUCCESS | set if valid parameters were passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:
| SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT | set if object_in was not a resolved object. |
| SE_STAT_CODE_UNPUBLISHED_OBJECT | set if object_in was not published under the given label. |
| SE_STAT_CODE_INVALID_ACCESS_MODE | set if object_in belongs to a transmittal opened in read-only mode. |
| SE_STAT_CODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
handle to the object to be unpublished; must be
resolved.
a character string containing the label under which the object
was previously published.
Prev: SE_TransmittalsAreSame.
Next: SE_UseDefaultColourModel.
Up:Index.
|