SE UseDefaultSRFContextInfo

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

extern SE_Return_Code
SE_UseDefaultSRFContextInfo
(void);

Definition

This function places the API into the default SRF state, in which <Location> instances 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_SetSRFContextInfo(), which takes the API out of the current SRF state and forces the use of whatever SRF was specified by SE_SetSRFContextInfo().

EXAMPLE If positions in a transmittal are represented with Augmented Transverse Mercator SRF locations, <TM Augmented 3D Location> instances will be returned as the type of <Location 3D> instances from that transmittal once SE_UseDefaultSRFContextInfo() is called.

SE_GetSRFContextInfo() can be used to find out what the current SRF is, either immediately after a call to SE_UseDefaultSRFContextInfo(), or at any time before a call to SE_SetSRFContextInfo() is made.

Instead of returning a valid, this function changes the internal state of the API, determining the SRF used to define <Location> instances returned by the 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.