The SEDRIS Data Representation Model
APPENDIX D - Functions
SE GeneralithFieldInType
extern SE_DRM_Status_Code
SE_GeneralithFieldInType
(
SE_Short_Integer_Positive major_drm_version, (notes)
SE_Byte_Unsigned minor_drm_version, (notes)
SE_Short_Integer_Positive drm_type, (notes)
SE_Short_Integer_Unsigned i, (notes)
constSE_DRM_Field_Structure **result_out_ptr (notes)
);

Definition

If drm_type represents a valid 'struct' type available to the DRM, retrieves structural information for the ith field of that type. Field information is indexed from 0.


Returns

SE_DRM_STAT_CODE_SUCCESS and *result_out_ptr is set appropriately, if valid parameters were passed in.
SE_DRM_STAT_CODE_NULL_REQUIRED_PARAMETER and *result_out_ptr is left unchanged, if result_out_ptr is NULL.
SE_DRM_STAT_CODE_INVALID_VERSION and *result_out_ptr is set to NULL, if the specified version of the DRM is not supported.
SE_DRM_STAT_CODE_INVALID_TYPE and *result_out_ptr is set to NULL, if drm_type does not correspond to a valid type, available to the DRM.
SE_DRM_STAT_CODE_INVALID_TYPE_CLASSIFICATION and *result_out_ptr is set to NULL, if drm_type does not correspond to a struct type.
SE_DRM_STAT_CODE_INVALID_TYPE_FIELD and *result_out_ptr is set to NULL, if i is out of range for drm_type.


Parameters Notes


major_drm_version

 major DRM version number of the DRM version for
 which this function is being called

minor_drm_version

 minor DRM version number of the DRM version for
 which this function is being called

drm_type

 represents a SEDRIS type, available for use by the DRM.

i

 index of desired field within type.

result_out_ptr

 pointer to a variable in the user's memory space where the
 answer (a pointer) will be stored.


Prev: SE_GeneralithFieldInClass. Next: SE_GetSRFInfoFromCoordinate. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS