|
SEDRIS Reference Manual
APPENDIX A - Transmittal Access Level 0 API Functions SE UseDefaultColourModel |
|---|
| extern SE_Return_Code | |||
| SE_UseDefaultColourModel | |||
| (void); | |||
Places the API into the 'default' colour model state, in which <Colour Data> objects are returned based entirely on the colour model used to produce the transmittal from which the <Colour Data> objects are extracted. The API will remain in this state until the user calls SE_SetColourModel(), which takes the API out of the current colour model state and places it into whatever colour model was specified in the SE_SetColourModel() call.
For example, if the transmittal was defined with RGB colours, then <RGB Colour> objects will be returned as <Colour Data> objects once SE_UseDefaultColourModel() is called.
To find out what that colour model is, call SE_GetColourModel(), either immediately after this call to SE_UseDefaultColourModel(), or at any time before a call to SE_SetColourModel() is made.
See the SE_SetColourModel() and SE_GetColourModel() functions for details.
| SE_RET_CODE_SUCCESS | all operations succeeded. |
| SE_RET_CODE_FAILURE | and the status code is set appropriately if the call failed. |
SE_Status_Code(s) when SE_RET_CODE_SUCCESS is returned:
| SE_STAT_CODE_SUCCESS | set upon successful completion. |
SE_Status_Code(s) when SE_RET_CODE_FAILURE is returned:
| SE_STAT_CODE_INACTIONABLE_FAILURE | set upon failure. |
Prev: SE_UnpublishObject.
Next: SE_UseDefaultSRFInfo.
Up:Index.
|