Function Name: Object ID To String

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_SUCCESS - if valid parameters were passed in and all operations succeeded. In this case, 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.

SE_NULL_REQUIRED_PARAMETER - and *result_out_ptr is left unaltered, if result_out_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - if id is not a handle to a valid, active (i.e., not freed) SE_OBJECT_ID. In this case, *result_out_ptr is set to an SE_STRING with string_length zero (0) and string_value NULL.

SE_INVALID_OR_NULL_STORE - and *result_out_ptr is set as for SE_INVALID_OR_NULL_OBJECT, if store_in is not a handle to a valid SE_STORE created by SE_CreateStore().

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

SE_FAILURE - and *result_out_ptr is set as for SE_INVALID_OR_NULL_OBJECT, if the API implementation specified

  1. does not support SE_OBJECT_IDs, or
  2. does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_ObjectIDToString
(
SE_OBJECT_ID id, (notes)
SE_STORE store_in, (notes)
SE_STRING *result_out_ptr (notes)
);

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.
Prev: Initialize Inherited Component Iterator. Next: Object IDs Supported. Up:Index.