SRM GetCorresponding3DSRF

SRM Reference Manual Functions SRM GetCorresponding3DSRF

extern SRM_Status_Code
SRM_GetCorresponding3DSRF
(
SRM_SRF_2D		srf_2D,	(notes)
SRM_SRF_3D	*	srf_3D_ptr	(notes)
);

Definition

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

Returns

SRM_STAT_CODE_SUCCESS and *srf_3D_ptr is set to the appropriate result, if valid parameters were passed in and srf_2D has a 3D equivalent.

SRM_STAT_CODE_FAILURE and *srf_3D_ptr is left unchanged, if srf_3D_ptr is NULL, srf_2D was invalid, or srf_2D does not have a 3D equivalent.

Parameters Notes

srf_2D

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

srf_3D_ptr

 pointer to a variable, provided by the user, into which
     the corresponding 3D SRF's enumerant is copied, if there is one.

SRM_STAT_CODE_SUCCESS	and *srf_3D_ptr is set to the appropriate result, if valid parameters were passed in and srf_2D has a 3D equivalent.
SRM_STAT_CODE_FAILURE	and *srf_3D_ptr is left unchanged, if srf_3D_ptr is NULL, srf_2D was invalid, or srf_2D does not have a 3D equivalent.