Function Name: Get Sort Key

Definition

Returns a value that can be used as a sort key for the object.

Returns

SE_SUCCESS - if valid parameters were passed in.

SE_NULL_REQUIRED_PARAMETER - and *sort_key_out_ptr is left unaltered, if sort_key_out_ptr was NULL.

SE_INVALID_OR_NULL_OBJECT - and *sort_key_out_ptr is set to zero (0), if object_in is not a handle to a valid, active (i.e., unfreed) SEDRIS object.

SE_UNRESOLVED_OBJECT - and *sort_key_out_ptr is set to zero (0), if object_in is unresolved.

SE_FAILURE - and *sort_key_out_ptr is set to zero (0), if 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_GetSortKey
(
SE_OBJECT object_in, (notes)
SE_UINT32 *sort_key_out_ptr (notes)
);

Parameters Notes

object_in

 the SEDRIS object whose sort key is being requested.

sort_key_out_ptr

 a pointer to a variable in the user's memory space
    where the answer will be stored.

Prev: Get SRF Parameters. Next: Get Transmittal File. Up:Index.