Function Name: Use Default SRF Parameters

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_SetSRFParameters(), which takes the API out of the current SRF state and forces the use of whatever SRF was specified by SE_SetSRFParameters().

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

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

See the SE_SetSRFParameters() and SE_GetSRFParameters() functions for details.

Returns

Instead of returning a value, this function changes the internal state of the API, determining the spatial reference frame used to define Location objects returned by this API.

Prototype


extern void
SE_UseDefaultSRFParameters
(void);

Prev: Use Default Color Model. Next: Valid Access Mode. Up:Index.