Reference: IVEErrorToString

Overview

Fills a string with the message describing a given error code.

Prototype (C)

#include "ive_error.h"
void IVEErrorToString(int code, int max_length, char* str, int* p_full_length)

Prototype (Fortran)

subroutine IVEErrorToString(code, str, full_length)
integer code, full_length
character*(*) str

Parameters

code

code is the error code of interest.

max_length

max_length is the maximum number of characters (not including the terminating null character) which may be written to str.

str

str will be overwritten with the message corresponding to code. If called from a Fortran and str is longer than needed for the message, str is padded with spaces. In C, str will be terminated with a null character when IVEErrorToString returns unless str is 0 or max_length is less than zero.

p_full_length, full_length

When called from a C and p_full_length is not 0, IVEErrorToString will set *p_full_length to the untruncated length (not including the terminating null character) of the message. When called from Fortran, full_length is set to the untruncated length of the message.

Cross references

IVE error codes

| categories | alphabetical |

modified July 1, 2001