The following table contains runtime status codes that may occur during program execution. These failures do not arise from ASN.1-specific features (such as an invalid PER encoding, for example), but buffer overflows, invalid socket options, or closed streams.
Error Code | Error Name | Description |
---|---|---|
0 | RT_OK | Normal completion status. |
2 | RT_OK_FRAG | Message fragment return status. This is returned when a part of a message is successfully decoded. The application should continue to invoke the decode function until a zero status is returned. |
-1 | RTERR_BUFOVFLW | Encode buffer overflow. This status code is returned when encoding into a static buffer and there is no space left for the item currently being encoded. |
-2 | RTERR_ENDOFBUF | Unexpected end-of-buffer. This status code is returned when decoding and the decoder expects more data to be available but instead runs into the end of the decode buffer. |
-3 | RTERR_IDNOTFOU | Expected identifier not found. This status is returned when the decoder is expecting a certain element to be present at the current position and instead something different is encountered. An example is decoding a sequence container type in which the declared elements are expected to be in the given order. If an element is encountered that is not the one expected, this error is raised. |
-4 | RTERR_INVENUM | Invalid enumerated identifier. This status is returned when an enumerated value is being encoded or decoded and the given value is not in the set of values defined in the enumeration facet. |
-5 | RTERR_SETDUPL | Duplicate element in set. This status code is returned when decoding an ASN.1 SET or XSD xsd:all construct. It is raised if a given element defined in the content model group occurs multiple times in the instance being decoded. |
-6 | RTERR_SETMISRQ | Missing required element in set. This status code is returned when decoding an ASN.1 SET or XSD xsd:all construct and all required elements in the content model group are not found to be present in the instance being decoded. |
-7 | RTERR_NOTINSET | Element not in set. This status code is returned when encoding or decoding an ASN.1 SET or XSD xsd:all construct. When encoding, it occurs when a value in the generated _order member variable is outside the range of indexes of items in the content model group. It occurs on the decode side when an element is received that is not defined in the content model group. |
-8 | RTERR_SEQOVFLW | Sequence overflow. This status code is returned when decoding a repeating element (ASN.1 SEQUENCE OF or XSD element with minmaxOccurs > 1) and more instances of the element are received the content model group. |
-9 | RTERR_INVOPT | Invalid option in choice. This status code is returned when encoding or decoding an ASN.1 CHOICE or XSD xsd:choice construct. When encoding, it occurs when a value in the generated 't' member variable is outside the range of indexes of items in the content model group. It occurs on the decode side when an element is received that is not defined in the content model group. |
-10 | RTERR_NOMEM | No dynamic memory available. This status code is returned when a dynamic memory allocation request is made and an insufficient amount of memory is available to satisfy the request. |
-11 | RTERR_INVHEXS | Invalid hexadecimal string. This status code is returned when decoding a hexadecimal string value and a character is encountered in the string that is not in the valid hexadecimal character set ([0-9A-Fa-f] or whitespace). |
-12 | RTERR_INVREAL | Invalid real number value. This status code is returned when decoding a numeric floating-point value and an invalid character is received (i.e. not numeric, decimal point, plus or minus sign, or exponent character). |
-13 | RTERR_STROVFLW | String overflow. This status code is returned when a fixed-sized field is being decoded as specified by a size constraint and the item contains more characters or bytes then this amount. It can occur when a run-time function is called with a fixed-sixed static buffer and whatever operation is being done causes the bounds of this buffer to be exceeded. |
-14 | RTERR_BADVALUE | Bad value. This status code is returned anywhere where an API is expecting a value to be within a certain range and it not within this range. An example is the encoding or decoding date values when the month or day value is not within the legal range (1-12 for month and 1 to whatever the max days is for a given month). |
-15 | RTERR_TOODEEP | Nesting level too deep. This status code is returned when a preconfigured maximum nesting level for elements within a content model group is exceeded. |
-16 | RTERR_CONSVIO | Constraint violation. This status code is returned when constraints defined the schema are violated. These include XSD facets such as minmaxOccurs, minmaxLength, patterns, etc.. Also ASN.1 value range, size, and permitted alphabet constraints. |
-17 | RTERR_ENDOFFILE | Unexpected end-of-file error. This status code is returned when an unexpected end-of-file condition is detected on decode. It is similar to the ENDOFBUF error code described above except that in this case, decoding is being done from a file stream instead of from a memory buffer. |
-18 | RTERR_INVUTF8 | Invalid UTF-8 character encoding. This status code is returned by the decoder when an invalid sequence of bytes is detected in a UTF-8 character string. |
-19 | RTERR_OUTOFBND | Array index out-of-bounds. This status code is returned when an attempt is made to add something to an array and the given index is outside the defined bounds of the array. |
-20 | RTERR_INVPARAM | Invalid parameter passed to a function of method. This status code is returned by a function or method when it does an initial check on the values of parameters passed in. If a parameter is found to not have a value in the expected range, this error code is returned. |
-21 | RTERR_INVFORMAT | Invalid value format. This status code is returned when a value is received or passed into a function that is not in the expected format. For example, the time string parsing function expects a string in the form "nn:nn:nn" where n's are numbers. If not in this format, this error code is returned. |
-22 | RTERR_NOTINIT | Context not initialized. This status code is returned when the run-time context structure (OSCTXT) is attempted to be used without having been initialized. This can occur if rtxInitContext is not invoked to initialize a context variable before use in any other API call. It can also occur is there is a license violation (for example, evaluation license expired). |
-23 | RTERR_TOOBIG | Value will not fit in target variable. This status is returned by the decoder when a target variable is not large enough to hold a a decoded value. A typical case is an integer value that is too large to fit in the standard C integer type (typically a 32-bit value) on a given platform. If this occurs, it is usually necessary to use a configuration file setting to force the compiler to use a different data type for the item. For example, for integer, the <isBigInteger> setting can be used to force use of a big integer type. |
-24 | RTERR_INVCHAR | Invalid character. This status code is returned when a character is encountered that is not valid for a given data type. For example, if an integer value is being decoded and a non-numeric character is encountered, this error will be raised. |
-25 | RTERR_XMLSTATE | XML state error. This status code is returned when the XML parser |
-26 | RTERR_XMLPARSE | XML parser error. This status code in returned when the underlying XML parser application (by default, this is Expat) returns an error code. The parser error code or text is returned as a parameter in is not in the correct state to do a certain operation. |
-27 | RTERR_SEQORDER | Sequence order error. This status code is returned when decoding an ASN.1 SEQUENCE or XSD xsd:sequence construct. It is raised if the elements were received in an order different than that specified the errInfo structure within the context structure. |
-28 | RTERR_FILNOTFOU | File not found. This status code is returned if an attempt is made to open a file input stream for decoding and the given file does not exist. |
-29 | RTERR_READERR | Read error. This status code if returned if a read IO error is encountered when reading from an input stream associated with a physical device such as a file or socket. |
-30 | RTERR_WRITEERR | Write error. This status code if returned if a write IO error is encountered when attempting to output data to an output stream associated with a physical device such as a file or socket. |
-31 | RTERR_INVBASE64 | Invalid Base64 encoding. This status code is returned when an error is detected in decoding base64 data. |
-32 | RTERR_INVSOCKET | Invalid socket. This status code is returned when an attempt is made to read or write from a scoket and the given socket handle is invalid. This may be the result of not having established a proper connection before trying to use the socket handle variable. |
-33 | RTERR_INVATTR | Invalid attribute. This status code is returned by the decoder when an attribute is encountered in an XML instance that was not defined in the XML schema. |
-34 | RTERR_REGEXP | Invalid regular expression. This status code is returned when a syntax error is detected in a regular expression value. Details of the syntax error can be obtained by invoking rtxErrPrint to print the details of the error contained within the context variable. |
-35 | RTERR_PATMATCH | Pattern match error. This status code is returned by the decoder when a value in an XML instance does not match the pattern facet defined in the XML schema. It can also be returned by numeric encode functions that cannot format a numeric value to match the pattern specified for that value. |
-36 | RTERR_ATTRMISRQ | Missing required attribute. This status code is returned by the decoder when an XML instance is missing a required attribute value as defined in the XML schema. |
-37 | RTERR_HOSTNOTFOU | Host name could not be resolved. This status code is returned from run-time socket functions when they are unable to connect to a given host computer. |
-38 | RTERR_HTTPERR | HTTP protocol error. This status code is returned by functions doing HTTP protocol operations such as SOAP functions. It is returned when a protocol error is detected. Details on the specific error can be obtained by calling rtxErrPrint. |
-39 | RTERR_SOAPERR | SOAP error. This status code when an error is detected when tryingto execute a SOAP operation. |
-40 | RTERR_EXPIRED | Evaluation license expired. This error is returned from evaluation versions of the run-time library when the hard-coded evaluation period is expired. |
-41 | RTERR_UNEXPELEM | Unexpected element encountered. This status code is returned when an element is encountered in a position where something else (for example, an attribute) was expected. |
-42 | RTERR_INVOCCUR | Invalid number of occurrences. This status code is returned by the decoder when an XML instance contains a number of occurrences of a repeating element that is outside the bounds (minOccursmaxOccurs) defined for the element in the XML schema. |
-43 | RTERR_INVMSGBUF | Invalid message buffer has been passed to decode or validate method. This status code is returned by decode or validate method when the used message buffer instance has type different from OSMessageBufferIF::XMLDecode. |
-44 | RTERR_DECELEMFAIL | Element decode failed. This status code and parameters are added to the failure status by the decoder to allow the specific element on which a decode error was detected to be identified. |
-45 | RTERR_DECATTRFAIL | Attribute decode failed. This status code and parameters are added to the failure status by the decoder to allow the specific attribute on which a decode error was detected to be identified. |
-46 | RTERR_STRMINUSE | Stream in-use. This status code is returned by stream functions when an attempt is made to initialize a stream or create a reader or writer when an existing stream is open in the context. The existing stream must first be closed before initializaing a stream for a new operation. |
-47 | RTERR_NULLPTR | Null pointer. This status code is returned when a null pointer is encountered in a place where it is expected that the pointer value is to be set. |
-48 | RTERR_FAILED | General failure. Low level call returned error. |
-49 | RTERR_ATTRFIXEDVAL | Attribute fixed value mismatch. The attribute contained a value that was different than the fixed value defined in the schema for the attribute. |
-50 | RTERR_MULTIPLE | Multiple errors occurred during an encode or decode operation. See the error list within the context structure for a full list of all errors. |
-51 | RTERR_NOTYPEINFO | This error is returned when decoding a derived type definition and no information exists as to what type of data is in the element content. When decoding XML, this normally means that an xsi:type attribute was not found identifying the type of content. |
-52 | RTERR_ADDRINUSE | Address already in use. This status code is returned when an attempt is made to bind a socket to an address that is already in use. |
-53 | RTERR_CONNRESET | Remote connection was reset. This status code is returned when the connection is reset by the remote host (via explicit command or a crash). |
-54 | RTERR_UNREACHABLE | Network failure. This status code is returned when the network or host is down or otherwise unreachable. |
-55 | RTERR_NOCONN | Not connected. This status code is returned when an operation is issued on an unconnected socket. |
-56 | RTERR_CONNREFUSED | Connection refused. This status code is returned when an attempt to communicate on an open socket is refused by the host. |
-57 | RTERR_INVSOCKOPT | Invalid option. This status code is returned when an invalid option is passed to socket. |
-58 | RTERR_SOAPFAULT | This error is returned when the decoded SOAP envelope is a fault message. |
-59 | RTERR_MARKNOTSUP | This error is returned when an attempt is made to mark a stream position on a stream type that does not support it. |
-60 | RTERR_NOTSUPP | Feature is not supported. This status code is returned when a feature that is currently not supported is encountered. |
-61 | RTERR_CODESETCONVFAIL | This status code is returned when transcoding from one character set to another one (for example, from UTF-8 to UTF-16) and a conversion error occurs. |