Function Name: Get Color Model

Definition

Gives the user the color model currently being used when returning Color Data objects from the specified transmittal.

The answer depends on the last call made to SE_SetColorModel() and/or SE_UseDefaultColorModel() and the manner in which the transmittal was produced.

case 1 - SE_SetColorModel() was called more recently than SE_UseDefaultColorModel()

The color model selected by SE_SetColorModel() is still the current color model, and that color model data will be copied to the location specified by * color_model_out_ptr. It doesn't matter what color model was originally used to produce the given transmittal, since the SE_SetColorModel() function was used to over-ride any 'default' color model choices and force all Color Data objects to be of the type specified by the current color model.

case 2 - SE_UseDefaultColorModel() was called more recently than SE_SetColorModel(), or SE_SetColorModel() was never called.

In this case, the color model that will be used to return Color Data objects from the given transmittal depends entirely on the transmittal. The color model used to return data will be the color model that was used when producing the transmittal. This is the default case.

Returns

SE_SUCCESS - if valid parameters were passed in. In this case, *color_model_out_ptr is set to the color model currently being used by the API when returning objects from the specified transmittal.

SE_NULL_REQUIRED_PARAMETER - if color_model_out_ptr was NULL. In this case, *color_model_out_ptr is not affected.

SE_INVALID_OR_NULL_TRANSMITTAL - if transmittal isn't a handle to a valid, active (i.e., open and unfreed) transmittal. In this case, *color_model_out_ptr is not affected.

SE_FAILURE - and *color_model_out_ptr is not affected, if

  1. the default color model is in effect but transmittal does not specify a color model,
  2. 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_GetColorModel
(
SE_TRANSMITTAL transmittal, (notes)
SE_COLOR_MODEL_ENUM *color_model_out_ptr (notes)
);

Parameters Notes

transmittal

 the transmittal of which this user is asking the question
    "What color model is currently being used to define <Color Data> objects
    extracted from this transmittal?".

color_model_out_ptr

 a pointer to the variable in the user's memory
    space where the answer will be stored.
Prev: Get Associate. Next: Get Component. Up:Index.