SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API
Functions
SE UseDefaultColourModel
extern SE_Return_Code
SE_UseDefaultColourModel
(void);

Definition

This function places the API into the default colour model state, in which <Colour Data> instances are returned based entirely on the colour model specified in the <Transmittal Summary> component of the <Transmittal Root> instance of the transmittal from which the <Colour Data> instances are extracted. The API will remain in this state until SE_SetColourModel() is invoked that takes the API out of the current colour model state and places it into whatever colour model was specified in the SE_SetColourModel() call.

EXAMPLE If the transmittal was defined with RGB colours, then <RGB Colour> instances will be returned as <Colour Data> instances once SE_UseDefaultColourModel() is called.

The SE_GetColourModel() function may be invoked to find out what the default colour model is, either immediately after an invocation of SE_UseDefaultColourModel(), or at any time before an invocation to SE_SetColourModel() is made.

This function changes the internal state of the API, determining the colour model used to define <Colour Data> instances returned by this API.


Returns

SE_RETCOD_SUCCESS 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 upon successful completion.

SE_Status_Code(s) when SE_RETCOD_FAILURE is returned:

SE_STATCODE_INACTIONABLE_FAILURE set upon failure.


Prev: SE_UnpublishObject. Next: SE_UseDefaultSRFContextInfo. Up:Index.

Last updated: July 26, 2006 Copyright © 2006 SEDRIS