SE StringToObjectID

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE StringToObjectID

Creates an SE_Object_ID from a string.

SE_STAT_CODE_SUCCESS and an SE_Object_ID corresponding to the specified object ID will be copied into *id_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and id_out_ptr is unaffected, if src_ptr or id_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and *id_out_ptr is set to NULL, if transmittal_in isn't a handle to a valid, open transmittal.

SE_STAT_CODE_FAILURE and *id_out_ptr is set to NULL, if

the given API implementation does not support object IDs, or

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

 the transmittal in which the object corresponding to the
    specified object ID resides.

 pointer to SE_String from which the SE_Object_ID will be
    created.

 pointer to a variable in the user's memory space, where the
    SE_Object_ID being created will be placed.

SE_STAT_CODE_SUCCESS	and an SE_Object_ID corresponding to the specified object ID will be copied into *id_out_ptr, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and id_out_ptr is unaffected, if src_ptr or id_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and *id_out_ptr is set to NULL, if transmittal_in isn't a handle to a valid, open transmittal.
SE_STAT_CODE_FAILURE	and *id_out_ptr is set to NULL, if the given API implementation does not support object IDs, or the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.