Function Name: Get Corresponding 2D SRF

Definition

Given a 3D spatial reference frame (SRF), retrieves the corresponding 2D SRF, if there is one.

Returns

SE_COORD_SUCCESS - if a valid parameter was passed in and it has a 2D equivalent.

SE_COORD_FAILURE - otherwise.

Prototype


extern SE_COORD_STATUS_CODE_ENUM
SRM_GetCorresponding2DSRF
(
SRM_SRF_3D_ENUM srf_3D, (notes)
SRM_SRF_2D_ENUM *srf_2D_ptr (notes)
);

Parameters Notes

srf_3D

 3D SRF for which we want the corresponding 2D SRF

srf_2D_ptr

 pointer to a variable, provided by the user, into which
 the corresponding 2D SRF's enumerator is copied, if there is one.
Prev: Free Coord Conversion Constants. Next: Get Corresponding 3D SRF. Up:Index.