SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE ResolveObject |
---|
extern SE_Return_Code | |||
SE_ResolveObject | |||
( | |||
SE_Object | object_in | 1 | |
); |
Given an unresolved SE_Object, attempt to resolve the reference and change the handle to a resolved state.
The name of the transmittal containing the object must first be resolved to a specific transmittal that can be accessed by the API. The object must then be resolved within the transmittal using object_in's published label.
Note that a transmittal that has been opened in this way cannot be written to or updated. The transmittal must be explicitly opened for writing or modification to do this.
SE_RETCOD_SUCCESS | and object_in is resolved. |
SE_RETCOD_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:
SE_STATCODE_SUCCESS | set if a valid parameter was passed in and all operations succeeded. |
SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:
SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT | set if object_in could not be resolved (i.e., the transmittal name was successfully resolved, but the transmittal did not contain the object label as a published object). |
SE_STATCODE_UNRESOLVED_TRANSMITTAL | set if object_in could not be resolved (i.e., the transmittal name portion of the reference could not be resolved). |
SE_STATCODE_INACTIONABLE_FAILURE | set if the call fails for any other reason. |
1 the SE_Object of the object reference to be resolved.
Prev: SE_RemoveFromTransmittal.
Next: SE_ResolveTransmittalName.
Up:Index.
|