Function Name: Image Name From Image Mapping Function

Definition

Given an Image Mapping Function object, find the name of the associated Image object.

Returns

SE_NULL_REQUIRED_PARAMETER - and no changes were made, if buffer or max_size_ptr is NULL.

SE_INVALID_OR_NULL_OBJECT - and buffer is set to the empty string and *max_size_ptr is set to zero (0), if object_in is not a handle to a valid, active (i.e., unfreed) <Image Mapping Function>.

SE_UNRESOLVED_START_OBJECT - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if object_in is unresolved.

SE_NO_OBJECT - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if object_in isn't associated to an <Image> object.

SE_UNRESOLVED_OBJECT - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if object_in's associated <Image> object is unresolved and could not be resolved.

SE_OUT_OF_MEMORY - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if memory cannot be allocated for an intermediate operation.

SE_FAILURE - and the output parameters are set as for SE_INVALID_OR_NULL_OBJECT, if the fields of the <Image> cannot be retrieved.

Prototype

Parameters Notes

object_in

 <Image Mapping Function> whose <Image> we're identifying

buffer

 to which <Image>'s name is printed; must be allocated by the user.

max_size_ptr

 initially, pointer to the maximum size of buffer; reset to the length
 of the string. If the string length is greater than the maximum size,
 we will not overflow the buffer, but *max_size_ptr would still be set
 to the name's original length