Valores y códigos de retorno de la función de programa de utilidad

Por convenio, el parámetro de salida del código de retorno de todas las funciones de programa de utilidad se establece para indicar que una operación se ha ejecutado correctamente, o bien lo contrario. En la tabla siguiente se enumeran todos los códigos de retorno y su significado correspondiente. Estos códigos de retorno se definen en BipCci.h.

Tabla 1. Valores y códigos de retorno de la función de programa de utilidad
Código de retorno Explicación
CCI_BUFFER_TOO_SMALL El almacenamiento intermedio de salida no es lo suficientemente grande para almacenar los datos solicitados.
CCI_EXCEPTION Se ha producido una excepción.
CCI_EXCEPTION_CONFIGURATION Se ha detectado una excepción de configuración al invocar la función. 1
CCI_EXCEPTION_CONVERSION Se ha detectado una excepción de conversión al invocar la función. 1
CCI_EXCEPTION_DATABASE Se ha detectado una excepción de base de datos al invocar la función.
CCI_EXCEPTION_FATAL Se ha detectado una excepción muy grave al invocar la función. 1
CCI_EXCEPTION_PARSER Se ha detectado una excepción de analizador al invocar la función. 1
CCI_EXCEPTION_RECOVERABLE Se ha detectado una excepción recuperable al invocar la función. 1
CCI_EXCEPTION_UNKNOWN Se ha especificado o encontrado una excepción desconocida.
CCI_EXCEPTION_USER Se ha detectado una excepción de usuario al invocar la función. 1
CCI_FAILURE Una función no se ha ejecutado correctamente.
CCI_FAILURE_CONTINUE Valor de retorno cniRun(): restitución del proceso de mensajes y continuación de la ejecución de la hebra.
CCI_FAILURE_RETURN Valor de retorno cniRun(): restitución del proceso de mensajes y devolución de la hebra a la agrupación.
CCI_INV_CODEPAGE Se ha especificado un número de página de códigos no válido.
CCI_INV_CHARACTER Se ha detectado un carácter no válido en el almacenamiento intermedio que debe convertirse.
CCI_INV_DATA_BUFLEN Se ha especificado una longitud de almacenamiento intermedio de datos con el valor cero.
CCI_INV_DATA_POINTER Se ha especificado un puntero nulo para la dirección de un área de datos de salida.
CCI_INV_ELEMENT_OBJECT Se ha especificado un puntero nulo para el objeto de elemento.
CCI_INV_FACTORY_NAME Se ha especificado un nombre de fábrica que no es válido (está en blanco).
CCI_INV_FACTORY_OBJECT Se ha especificado un puntero nulo para el objeto de fábrica.
CCI_INV_IMPL_FUNCTION Se ha especificado una combinación no válida de funciones de implementación condicional.
CCI_INV_LENGTH Se ha especificado una longitud con el valor cero.
CCI_INV_LOG_TYPE El tipo de anotaciones especificado no es válido.
CCI_INV_MESSAGE_CONTEXT Se ha especificado un puntero nulo para el contexto de mensaje.
CCI_INV_MESSAGE_OBJECT Se ha especificado un puntero nulo para el objeto de mensaje.
CCI_INV_NODE_ENV Se ha intentado enviar una hebra desde un nodo que no es de entrada.
CCI_INV_NODE_NAME Se ha especificado un nombre de nodo que no es válido (está en blanco).
CCI_INV_NODE_OBJECT Se ha especificado un puntero nulo para el objeto de nodo.
CCI_INV_OBJECT_NAME Los caracteres especificados en el nombre de objeto no eran válidos.
CCI_INV_PARSER_NAME Se ha especificado un nombre de clase de analizador que no es válido (está en blanco).
CCI_INV_PARSER_OBJECT Se ha especificado un puntero nulo para el objeto de analizador.
CCI_INV_SQL_EXPR_OBJECT Se ha especificado un puntero nulo para un valor de expresión SQL.
CCI_INV_STATEMENT No se ha especificado una sentencia.
CCI_INV_TERMINAL_NAME Se ha especificado un nombre de terminal que no es válido (está en blanco).
CCI_INV_TERMINAL_OBJECT Se ha especificado un puntero nulo para el objeto de terminal.
CCI_INV_TRANSACTION_TYPE Se ha especificado un valor no válido para el tipo de transacción.
CCI_INV_VFTP Se ha especificado un puntero nulo para la dirección de la tabla de punteros de funciones virtuales del plug-in.
CCI_MISSING_IMPL_FUNCTION En la tabla de punteros de funciones, no se ha definido una función de implementación obligatoria.
CCI_NAME_EXISTS Ya existe un analizador con el mismo nombre de clase.
CCI_NO_BUFFER_EXISTS No existe ningún almacenamiento intermedio para el objeto de analizador especificado.
CCI_NO_EXCEPTION_EXISTS No se ha encontrado ninguna excepción anterior para esta hebra.
CCI_NO_THREADS_AVAILABLE No había ninguna hebra disponible para su envío.
CCI_NULL_ADDR Una función que debía devolver una dirección no se ha ejecutado correctamente; en lugar de la dirección, se devuelve cero.
CCI_PARSER_NAME_TOO_LONG El nombre de la clase de analizador es demasiado largo.
CCI_SUCCESS Operación finalizada correctamente.
CCI_SUCCESS_CONTINUE Valor de retorno cniRun(): confirmación del proceso de mensajes y continuación de la ejecución de la hebra.
CCI_SUCCESS_RETURN Valor de retorno cniRun(): confirmación del proceso de mensajes y devolución de la hebra a la agrupación.
CCI_TIMEOUT Valor de retorno cniRun(): se no procesa ningún mensaje, pero continúa la ejecución de la hebra.
Note:

1: Este código de retorno lo devuelve sólo cniGetLastExceptionData para indicar el tipo de la última excepción.

Referencia relacionada
Funciones de programa de utilidad de nodo y analizador