SE ObjectIDToString

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

extern SE_Status_Code
SE_ObjectIDToString
(
SE_Object_ID		id,	(notes)
SE_Store		store_in,	(notes)
SE_String	*	result_out_ptr	(notes)
);

Definition

Given an SE_Object_ID, this function will return the corresponding string. The string is allocated within this function, and must be freed using by the user. This function does not modify the SE_Object_ID.

Returns

SE_STAT_CODE_SUCCESS and memory for the string_value member of *result_out_ptr will be allocated within the store associated with store_in, and appropriate values will be copied into the members of *result_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *result_out_ptr is left unaltered, if result_out_ptr is NULL.

SE_STAT_CODE_INVALID_OR_NULL_OBJECT and *result_out_ptr is set to SE_STRING_DEFAULT, if id is not a handle to a valid, active (i.e., not freed) SE_Object_ID.

SE_STAT_CODE_INVALID_OR_NULL_STORE and *result_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().

SE_STAT_CODE_OUT_OF_MEMORY and *result_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the API could not allocate memory for the string that is to be returned.

SE_STAT_CODE_FAILURE and *result_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the API implementation specified

does not support SE_Object_IDs, or

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

Parameters Notes

id

 the SE_Object_ID.

store_in

 the store to be used when allocating string data in the result.

result_out_ptr

 pointer to an SE_String variable in the user's memory
    space where the result will be stored.  The memory for the string_value
    member of the structure will be allocated within the store associated
    with store_in.

SE_STAT_CODE_SUCCESS	and memory for the string_value member of result_out_ptr will be allocated within the store associated with store_in, and appropriate values will be copied into the members of result_out_ptr, if valid parameters were passed in and all operations succeeded.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *result_out_ptr is left unaltered, if result_out_ptr is NULL.
SE_STAT_CODE_INVALID_OR_NULL_OBJECT	and *result_out_ptr is set to SE_STRING_DEFAULT, if id is not a handle to a valid, active (i.e., not freed) SE_Object_ID.
SE_STAT_CODE_INVALID_OR_NULL_STORE	and *result_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid SE_Store created by SE_CreateStore().
SE_STAT_CODE_OUT_OF_MEMORY	and *result_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the API could not allocate memory for the string that is to be returned.
SE_STAT_CODE_FAILURE	and *result_out_ptr is set as for SE_STAT_CODE_INVALID_OR_NULL_OBJECT, if the API implementation specified does not support SE_Object_IDs, or does not provide this function in its shared library, and dynamic binding is specified at compile time.