SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetObjectFromIDString
extern SE_Return_Code
SE_GetObjectFromIDString
(
SE_Transmittal transmittal,1
constSE_String *id,2
SE_Object *object3
);

Definition

Given an id string and a transmittal handle, will return the object in the transmittal corresponding to the id string.


Returns

SE_RETCOD_SUCCESS and the requested object is returned.
SE_RETCOD_FAILURE and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS set if an id string was passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_DELETED_OBJECT set if the object corresponding to id has been removed from the transmittal.
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any other reason.

Parameters Notes

1 the transmittal to which the object belongs.

2 the string corresponding to the object being retrieved

3 pointer to the SE_Object corresponding to id_string


Prev: SE_GetNumberOfPathsToTransmittalRoot. Next: SE_GetObjectIDString. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS