Clave para las descripciones de funciones de CLI de DB2

Cada descripción de función contiene las secciones siguientes:

Finalidad

Esta sección proporciona una breve visión general de lo que realiza la función. También indica si debe invocarse alguna función antes y después de invocar la función que se está describiendo.

Cada función tiene también una tabla que indica qué especificación o norma cumple la función.

Esta tabla indica el soporte de la función. Algunas funciones utilizan un conjunto de opciones que no son aplicables a todas las especificaciones o normas. Las diferencias significativas están indicadas en la sección sobre restricciones de la función.

Sintaxis

Esta sección contiene el prototipo 'C' genérico. El prototipo genérico se utiliza para todos los entornos, incluido Windows.

Todos los argumentos de función que son punteros se definen utilizando la macro FAR; esta macro se inhabilita (se establece en un espacio en blanco) para todas las plataformas excepto Windows. En Windows, FAR se utiliza para definir argumentos como punteros remotos.

Argumentos

Esta sección lista cada argumento de la función, junto con su tipo de datos, una descripción y la indicación de si es un argumento de entrada o de salida.

Algunas funciones contienen argumentos de entrada o salida, que se denominan argumentos diferidos o enlazados.

Estos argumentos son punteros que apuntan a almacenamientos intermedios asignados por la aplicación y están asociados con (o enlazados a) un parámetro de una sentencia de SQL o una columna de un conjunto resultante. CLI de DB2 accede a las áreas de datos que especifica la función en un momento posterior. Estas áreas de datos diferidas deben ser válidas todavía cuando CLI de DB2 acceda a ellas.

Uso

Esta sección proporciona información sobre cómo utilizar la función y cualquier consideración especial aplicable. Las posibles condiciones de error no se describen aquí, sino que se incluyen en la sección sobre diagnósticos.

Códigos de retorno

Esta sección lista todos los posibles códigos de retorno de la función. Cuando se devuelve SQL_ERROR o SQL_SUCCESS_WITH_INFO, se puede obtener información sobre errores invocando SQLError() o SQLGetDiagRec().

Diagnósticos

Esta sección contiene una tabla que lista los SQLSTATE devueltos explícitamente por CLI de DB2 (también pueden obtenerse los SQLSTATE generados por DBMS) e indica la causa del error. Estos valores se obtienen invocando SQLError() o SQLGetDiagRec() después de que la función devuelva un SQL_ERROR o SQL_SUCCESS_WITH_INFO.

Restricciones

Esta sección indica las diferencias o limitaciones existentes entre CLI y ODBC de DB2 Everyplace que podrían afectar a una aplicación.

Consulte el manual IBM DB2 Universal Database Call Level Interface Guide and Reference para obtener más información sobre CLI de DB2, tal como información sobre los códigos de retorno, diagnósticos, ejemplos, configuración del entorno CLI y el acceso a las aplicaciones de ejemplo.

Consulta relacionada

• Conversión de datos por funciones de CLI de DB2
• Resumen de las funciones de CLI de DB2