BIS Return Codes

Here are the return codes for the B_ functions. These codes are defined in the bisdef.cpy COPY file provided in the samples/common directory. Note that the severity of an error condition increases with the value of the return code

00-09 Success! For B_ReadRequest, the request data is available in the XML exchange file. For B_WriteResponse, the response was accepted by the Request Handler.
  • 00 - BIS-Success: The data transfer succeeded and the XML file contains the result of the operation.
10-19 A non-fatal event occurred, and recovery is possible. While no such conditions currently exist, these codes are reserved for future use.
20-29 A failure occurred but the program should be able to recover. The states of the service program and request handler have not been affected by this operation.
  • 20 - BIS-Warn-RequestTimeExpired: A timeout parameter was specified on the B_ReadRequest call and the timeout expired. To avoid a potential race condition, the service program should not terminate when this occurs-instead, it can do some work and then reissue the request.
  • 21 -BIS-Warn-RequestOutstanding: A request has already been received by B_ReadRequest and the service program has not responded.

    This code is only returned by BIS/Apache; BIS/IIS recreates the exchange file and returns

    BIS_Success each time that B_ReadRequest is called for the same request.

  • 22 - BIS-Warn-ResponseUnexpected: The service program called B_WriteResponse without a pending request.
  • 23 - BIS-Warn-CallNotImplemented: A function was called that is not implemented in this version of BIS.
30-49 A failure occurred. The service program may attempt to recover, correct the problem and retry the operation. The state of the service program and request handler have not been affected by this operation.
  • 30 -BIS-Fail-FileOpen: BIS could not open the XML Exchange file.
  • 31 - BIS-Fail-FileRead: BIS could not read the XML Exchange file.
  • 32 - BIS-Fail-FileWrite:
  • 33 - BIS-Fail-FileClose: BIS could not close the XML Exchange file.
  • 34 - BIS-Fail-FileSize: The XML Exchange file size is too large to load into memory.
  • 39 - BIS-Fail-FileTraceFileIO: BIS could not open or write the trace file.
  • 49 - BIS-Fail-FileFormat: The XML Exchange file format is invalid.
50-79 A failure or possible planned session/service expiration event occurred and the program cannot continue. The XML exchange file was not updated and the program should terminate as soon as possible or BIS will terminate the program after the service timeout interval expires.
  • 50 - BIS-Fail-SessionAbandoned: The session timed out.
  • 51 - BIS-Fail-SessionComplete: The user logged out or ended the session. Note that this does not necessarily indicate a failure-a SessionComplete tag may have been processed.
  • 52 - BIS-Fail-ServiceComplete: The user logged out or ended the session. Note that this does not necessarily indicate a failure-a StopService tag may have been processed.
80-99 A serious error occurred. The XML exchange file was not updated and the program must terminate as soon as possible or BIS will terminate the program after the service timeout interval expires.
  • 80 - BIS-Fail-ServerUnavailable: The service program is not running in the BIS server environment.
  • 81 - BIS-Fail-ServerUnspecified: An unspecified error occurred while the service program was communicating with the BIS Request Handler.
  • 88 - BIS-Fail-ServerInternalError: An internal error occurred while the service program was communicating with the BIS Request Handler.
  • 89 - BIS-Fail-ServerMemoryManagement: A memory management failure occurred in the BIS service program.
  • 90 - BIS-Fail-ServerBadMessage: An internal error occurred while the service program was communicating with the BIS Request Handler.
  • 91 - BIS-Fail-ServerBadLength: An internal error occurred while the service program was communicating with the BIS Request Handler.
  • 92 - BIS-Fail-ServerBadParameter: An internal error occurred while the service program was communicating with the BIS Request Handler.
  • 93 - BIS-Fail-ServerWrongMsg: An internal error occurred while the service program was communicating with the BIS Request Handler.
  • 99 - BIS-Fail-ServerConnectionLost: The connection between the BIS service program and the BIS Request Handler failed.