SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE GetObjectIDString
extern SE_Return_Code
SE_GetObjectIDString
(
SE_Object object,1
SE_Store store,2
SE_String *id3
);

Definition

Given an object, provides an id string managed by the store passed in which is 1) unique within the transmittal the object resides in and 2) the same over separate SE_Open and SE_Close sessions.


Returns

SE_RETCOD_SUCCESS and the requested id string 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 valid parameters were passed in and all operations succeeded.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_UNRESOLVED_OUTPUT_OBJECT set if object is unresolved.
SE_STATCODE_C_STORE_INVALID set if store is not a handle to a valid SE_Store.
SE_STATCODE_INACTIONABLE_FAILURE set if the call fails for any other reason.

Parameters Notes

1 the object for which an id string is requested.

2 the store that will manage the string memory

3 pointer to the id string


Prev: SE_GetObjectFromIDString. Next: SE_GetObjectReferenceCount. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS