Function Name: Get Implementation Identifier

Definition

Given a handle to an object, return the implementation identifier associated with the API implementation in which that object resides.

Returns

SE_SUCCESS - if valid parameters were passed in. In this case, the implementation identifier associated with the object's API implementation is copied into *implementation_identifier_out_ptr.

SE_NULL_REQUIRED_PARAMETER - if implementation_identifier_out_ptr is NULL. In this case, *implementation_identifier_out_ptr is left unaltered.

SE_INVALID_OR_NULL_OBJECT - if object_in is not a handle to a valid, active (i.e., not freed) SEDRIS object. In this case, *implementation_identifier_out_ptr is left unaltered.

SE_FAILURE - and *implementation_identifier_out_ptr is left unaltered, 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_GetImplementationIdentifier
(
SE_OBJECT object_in, (notes)
char *implementation_identifier_out_ptr (notes)
);

Parameters Notes

object_in

 the object for which the implementation identifier
    should be returned.

implementation_identifier_out_ptr

 a char* buffer from the user. The
    implementation identifier will be copied into this buffer.  The
    user is responsible for allocating storage for this buffer before
    calling this function.

    See SE_MAX_IMPLEMENTATION_IDENTIFIER_SIZE for the limit on how
    long an implementation identifier string can be.
Prev: Get Image Data. Next: Get Iteration Length Remaining. Up:Index.