|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE PublishObject |
|---|
| extern SE_Return_Code | ||||
| SE_PublishObject | ||||
| ( | ||||
| SE_Object | object_in, | (notes) | ||
| const | char | * | label_in | (notes) |
| ); | ||||
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.
| SE_RET_CODE_SUCCESS | and the object is published. |
| SE_RET_CODE_FAILURE 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 SE_STAT_CODE_UNRESOLVED_OUTPUT_OBJECT | set if object_in was not a resolved object. |
| SE_STAT_CODE_INVALID_OBJECT_LABEL SE_STAT_CODE_INVALID_OBJECT_LABEL | set 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 SE_STAT_CODE_INVALID_ACCESS_MODE | set if object_in belongs to a transmittal opened in read-only mode. |
| SE_STAT_CODE_INACTIONABLE_FAILURESE_STAT_CODE_INACTIONABLE_FAILURE | set if call fails for any other reason. |
the handle of the object to be published.
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.
Prev: SE_OpenTransmittalByName.
Next: SE_PutDataTableData.
Up:Index.
|