SE UseDefaultSRFInfo

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

extern SE_Return_Code
SE_UseDefaultSRFInfo
(void);

Definition

Places the API into the 'default' SRF state, in which <Location> objects are returned based entirely on the SRF in which they were originally encoded in the transmittal. The API will remain in this state until the user calls SE_SetSRFInfo(), which takes the API out of the current SRF state and forces the use of whatever SRF was specified by SE_SetSRFInfo().

For example, if a transmittal subtree was defined using UTM SRF locations, then <TM Augmented 3D Location> objects will be returned as the type of <Location 3D> objects from that transmittal subtree once SE_UseDefaultSRFInfo() is called.

To find out what the current retrieval SRF parameters are, call SE_GetSRFInfo(), either immediately after this call to SE_UseDefaultSRFInfo(), or at any time before a call to SE_SetSRFInfo() is made.

See the SE_SetSRFInfo() and SE_GetSRFInfo() functions for details.

Returns

SE_RET_CODE_SUCCESS all operations succeeded.

SE_RET_CODE_FAILURE and the status code is set appropriately if the call failed.

Status Codes

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.

SE_RET_CODE_SUCCESS	all operations succeeded.
SE_RET_CODE_FAILURE	and the status code is set appropriately if the call failed.