SE GetColourModel

SEDRIS Reference Manual APPENDIX A - LEVEL 0 READ and WRITE API Functions SE GetColourModel

extern SE_Status_Code
SE_GetColourModel
(
SE_Transmittal		transmittal,	(notes)
SE_Colour_Model	*	colour_model_out_ptr	(notes)
);

Definition

Gives the user the colour model currently being used when returning <Colour Data> objects from the specified transmittal.

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

case 1 - SE_SetColourModel() was called more recently than SE_UseDefaultColourModel()

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

case 2 - SE_UseDefaultColourModel() was called more recently than SE_SetColourModel(), or SE_SetColourModel() was never called.

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

Returns

SE_STAT_CODE_SUCCESS and *colour_model_out_ptr is set to the colour model currently being used by the API when returning <Colour Data> instances from the specified transmittal, if valid parameters were passed in.

SE_STAT_CODE_NULL_REQUIRED_PARAMETER and *colour_model_out_ptr is not affected, if colour_model_out_ptr was NULL.

SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL and *colour_model_out_ptr is not affected, if transmittal isn't a handle to a valid, active (i.e., open and unfreed) transmittal.

SE_STAT_CODE_FAILURE and *colour_model_out_ptr is not affected, if

the default colour model is in effect but transmittal does not specify a colour model,

the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Parameters Notes

transmittal

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

colour_model_out_ptr

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

SE_STAT_CODE_SUCCESS	and *colour_model_out_ptr is set to the colour model currently being used by the API when returning <Colour Data> instances from the specified transmittal, if valid parameters were passed in.
SE_STAT_CODE_NULL_REQUIRED_PARAMETER	and *colour_model_out_ptr is not affected, if colour_model_out_ptr was NULL.
SE_STAT_CODE_INVALID_OR_NULL_TRANSMITTAL	and *colour_model_out_ptr is not affected, if transmittal isn't a handle to a valid, active (i.e., open and unfreed) transmittal.
SE_STAT_CODE_FAILURE	and *colour_model_out_ptr is not affected, if the default colour model is in effect but transmittal does not specify a colour model, the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.