SQLCOLUMNS( ) (Función)

Almacena una lista de nombres de columnas e información acerca de cada columna para la tabla de origen de datos especificada en un cursor de Visual FoxPro.

SQLCOLUMNS(nConnectionHandle, TableName
    [, "FOXPRO" | "NATIVE"] [, CursorName])

Valores devueltos

Numeric

Parámetros

  • nConnectionHandle
    Identificador de conexión activo.

  • TableName
    Especifica el nombre de la tabla desde la que se devuelven los nombres de las columnas. TableName puede contener los caracteres comodín ? y *. El signo de interrogación (?) representa a cualquier carácter individual y el asterisco (*) representa un número cualquiera de caracteres.

  • FOXPRO | NATIVE
    Especifica el formato de la información de las columnas del conjunto de resultados. No olvide escribir FOXPRO o NATIVE entre comillas. La opción de formato NATIVE almacena información de columnas con el mismo formato que el origen de datos. La opción de formato FOXPRO almacena la información de columnas con el mismo formato utilizado para la tabla o el cursor de Visual FoxPro que se crearía si se importara la tabla de origen de datos a Visual FoxPro. Si omite FOXPRO o NATIVE, la opción de formato predeterminada será FOXPRO.

    La tabla siguiente muestra las columnas del conjunto de resultados para el formato FOXPRO.

    Nombre de columna Descripción
    Field_name Nombre de columna
    Field_type Tipo de datos de la columna
    Field_len Longitud de la columna
    Field_dec Número de cifras decimales

    La tabla siguiente muestra las columnas en el conjunto de resultados para el formato NATIVE. Según el origen de datos, en el formato NATIVE se pueden incluir columnas adicionales que no aparecen en la tabla siguiente en el conjunto de resultados.

    Nombre de columna Descripción
    Table_qualifier Identificador del calificador de la tabla
    Table_owner Identificador del propietario de la tabla
    Table_name Identificador de la tabla
    Column_name Identificador de la columna
    Data_type Tipo de datos de la columna
    Type_name Nombre del tipo de datos de la columna
    Precision Precisión de la columna
    Length Tamaño de la transferencia de datos
    Scale Escala de la columna
    Radix Base para el tipo numérico
    Nullable Admite valores NULL
    Observaciones Descripción de la columna

    Si no existe la tabla especificada en TableName, y el formato se establece como NATIVE, SQLCOLUMNS( ) devuelve verdadero (.T.) y crea una tabla o un cursor vacío. Si no existe la tabla especificada en TableName y el formato se establece como FOXPRO, SQLCOLUMNS( ) devuelve falso (.F.).

  • CursorName
    Especifica el nombre del cursor de Visual FoxPro para el conjunto de resultados. Si no incluye un nombre de cursor, Visual FoxPro utilizará el nombre predeterminado SQLRESULT.

Observaciones

SQLCOLUMNS( ) devuelve 1 si el cursor se crea correctamente, 0 si SQLCOLUMNS( ) aún está ejecutándose, – 1 si se produce un error de nivel de conexión y – 2 si se produce un error de nivel de entorno.

SQLCOLUMNS( ) es una de las cuatro funciones que pueden ejecutarse en modo síncrono o asíncrono. La configuración Asíncrona de SQLSETPROP( ) determina si estas funciones se ejecutan en modo síncrono o asíncrono. En modo asíncrono, deberá llamar a SQLCOLUMNS( ) repetidamente hasta que se devuelva un valor distinto de falso (.F.) (sigue ejecutándose).

Ejemplo

En el ejemplo siguiente se supone que SQLCONNECT( ) se ejecuta correctamente y su valor devuelto se almacena en una variable de memoria llamada gnConnHandle. SQLCOLUMNS( ) se usa para crear un cursor llamado MyCursor que contiene información acerca de las columnas de la tabla authors.

= SQLCOLUMNS(gnConnHandle, 'authors', 'FOXPRO', 'MyCursor')

Vea también

AERROR( ) | SQLGETPROP( ) | SQLSETPROP( ) | SQLTABLES( )