NAME

cxTypeMismatchPtrMsg - return a suitably formatted string describing erroneous pointer data

C SPECIFICATION

#include <cx/TypeMismatchMsg.h>


char *cxTypeMismatchPtrMsg( cxPortDir direction, char *portName, char *portType, char *englishName, char *memberName, char *data, char *portLo, char *portHi )

FORTRAN SPECIFICATION

character*(*) function cxTypeMismatchPtrMsg( direction, portName, portType, englishName, memberName, data, portLo, portHi )
integer direction
character*(*) portName
character*(*) portType
character*(*) englishName
character*(*) memberName
character*(*) data
character*(*) portLo
character*(*) portHi

PARAMETERS

direction
Input enumerated value indicating input (0) or output (1) port type.
portName
Input character string giving the port's name.
portType
Input character string giving the port's expected data type.
englishName
Input character string giving the label of the erroneous member.
memberName
Input character string giving the structure reference of the erroneous member.
data
Input character string giving the erroneous data value.
portLo
Input character string giving the lower limit of the acceptable data range, either zero or one.
portHi
Input character string giving the upper limit of the acceptable data range, either zero or the null-terminated empty string.

FUNCTION RETURN VALUE

cxTypeMismatchPtrMsg returns a static character string indicating that the named member on port portName expected pointer data in the range of portLo to portHi, but received data of value data outside the range.

DESCRIPTION

cxTypeMismatchPtrMsg returns a static character string indicating that the named member on port portName expected pointer data in the range of portLo to portHi, but received data of value data outside the range. Should be called only with portLo equal to the string 1, indicating a non-zero pointer was desired, or with portLo and portHi both equal to the string 0, indicating a zero pointer was desired. cxTypeMismatchPtrMsg is used by the input and output data type checking routines cxPortCheckIn and cxPortCheckOut, which are automatically generated for every module in the <module>.cx.c file. cxTypeMismatchPtrMsg is provided so that users can create error messages similar to those created by the automatically generated code.

SEE ALSO

cxTypeMismatchMsg(3E), cxTypeMismatchConnectMsg(3E), cxTypeMismatchPortMsg(3E)
Last modified: Mon Nov 18 13:53:45 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996