Function Name: Get Transmittal Version Information

Definition

Gets the version of the SEDRIS Data Representation Model (SDRM) and Environmental Data Coding Standard (EDCS) used to define the given transmittal.

Returns

SE_SUCCESS - and the output parameters are set appropriately, if valid parameters were passed in and all operations succeeded.

SE_NULL_REQUIRED_PARAMETER - and none of the output parameters are affected, if major_version_out_ptr, minor_version_out_ptr, interim_version_out_ptr, major_EDCS_version_out_ptr, minor_EDCS_version_out_ptr, or interim_EDCS_version_out_ptr were NULL.

SE_INVALID_OR_NULL_TRANSMITTAL - and none of the output parameters are affected, if transmittal is not a handle to a valid, active (not previously closed) transmittal.

SE_FAILURE - and none of the output parameters are affected, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype


extern SE_STATUS_CODE_ENUM
SE_GetTransmittalVersionInformation
(
SE_TRANSMITTAL transmittal, (notes)
SE_PINT16 *major_DRM_version_out_ptr, (notes)
SE_UINT8 *minor_DRM_version_out_ptr, (notes)
char *interim_DRM_version_out_ptr, (notes)
SE_PINT16 *major_EDCS_version_out_ptr, (notes)
SE_UINT8 *minor_EDCS_version_out_ptr, (notes)
char *interim_EDCS_version_out_ptr (notes)
);

Parameters Notes

transmittal

 the transmittal whose version information is being obtained

major_DRM_version_out_ptr

 a pointer to a SE_PINT16 in the user's memory
    space that will be set to an integer value greater than or equal to 1

minor_DRM_version_out_ptr

 a pointer to a SE_UINT8 in the user's memory
    space that will be set to an integer value between 0 and 99, inclusive

interim_DRM_version_out_ptr

 a pointer to a char in the user's memory
    space that will be set to a value between 'a' and 'z' inclusive.
    If it was not an interim version of the SDRM, then the value will
    be set to a blank (' ').

major_EDCS_version_out_ptr

 a pointer to a SE_PINT16 in the user's memory
    space that will be set to an integer value greater than or equal to 1

minor_EDCS_version_out_ptr

 a pointer to a SE_UINT8 in the user's memory
    space that will be set to an integer value between 0 and 99, inclusive

interim_EDCS_version_out_ptr

 a pointer to a char in the user's memory
    space that will be set to a value between 'a' and 'z' inclusive.
    If it was not an interim version of the EDCS, then the value will
    be set to a blank (' ').

Prev: Get Transmittal Name. Next: Get User Data. Up:Index.