NAME

cxVecClipGet - gets coercion clipping state used by the Module Data Wrapper

C SPECIFICATION

#include <cx/Coerce.h>

void cxVecClipGet(int *clip_flag, cxErrorCode *clip_severity)

FORTRAN SPECIFICATION

subroutine cxVecClipGet(clip_flag, clip_severity)
integer clip_flag, clip_severity

PARAMETERS

clip_flag
Output Boolean indicating error status of clipping during coercion.
clip_severity
Output enumeration indicating error severity of clipping during coercion.

DESCRIPTION

cxVecClipGet gets internal state values from the data coercion routines (see cxVecCoerce). If clip_flag is set to a non-zero value, the value of clip_severity is used as the error return code from cxVecCoerce in the event an out-of-range value must be clipped to a smaller range. cxVecClipGet is used by the Module Data Wrapper in array coercions, but may also be used in writing modules.

SEE ALSO

cxVecClipSet(3E), cxVecCoerce(3E).
Last modified: May 27 15:45 1999
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1999