SE GetColourModel

SEDRIS Reference Manual APPENDIX A - Transmittal Access Level 0 API Functions SE GetColourModel

extern SE_Return_Code
SE_GetColourModel
(
SE_Transmittal		transmittal,	¹
SE_Colour_Model	*	colour_model	²
);

Definition

Gives the user the colour model currently being used when returning <Colour Data> instances 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. 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> instances 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> instances 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_RETCOD_SUCCESS	and the requested colour model is returned, if valid parameters were passed in and all operations succeeded.
SE_RETCOD_FAILURE	and the status code is set appropriately if the call failed.

Status Codes

SE_Status_Code(s) when SE_RETCOD_SUCCESS is returned:

SE_STATCODE_SUCCESS

set if valid parameters were passed in.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE

set if

the default colour model is in effect but transmittal does not specify a colour model,
the call fails for any other reason.

Parameters Notes

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

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