String To Object ID

Function Name: String To Object ID

Definition

Creates an SE_OBJECT_ID from a string.

Returns

SE_SUCCESS - if valid parameters were passed in and all operations succeeded. In this case, an SE_OBJECT_ID corresponding to the specified object ID will be copied into *id_out_ptr.

SE_NULL_REQUIRED_PARAMETER - and id_out_ptr is unaffected, if src_ptr or id_out_ptr is NULL.

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

SE_FAILURE - and *id_out_ptr is set to NULL, if

the given transmittal 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.

Prototype

extern SE_STATUS_CODE_ENUM
SE_StringToObjectID
(
	SE_TRANSMITTAL		transmittal,	(notes)
const	SE_STRING	*	src_ptr,	(notes)
	SE_OBJECT_ID	*	id_out_ptr	(notes)
);

Parameters Notes

transmittal

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

src_ptr

 pointer to SE_STRING from which the SE_OBJECT_ID will be
    created.

id_out_ptr

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

Prev: Set User Data. Next: Transmittals Are Same. Up:Index.