Función SQLProcedureColumns

de conformidad de
Versión introducida: Cumplimiento de estándares ODBC 1.0: ODBC

resumen
SQLProcedureColumns devuelve la lista de parámetros de entrada y salida, así como las columnas que componen el conjunto de resultados para los procedimientos especificados. El controlador devuelve la información como un conjunto de resultados en la instrucción especificada.

Sintaxis

  
SQLRETURN SQLProcedureColumns(  
     SQLHSTMT      StatementHandle,  
     SQLCHAR *     CatalogName,  
     SQLSMALLINT   NameLength1,  
     SQLCHAR *     SchemaName,  
     SQLSMALLINT   NameLength2,  
     SQLCHAR *     ProcName,  
     SQLSMALLINT   NameLength3,  
     SQLCHAR *     ColumnName,  
     SQLSMALLINT   NameLength4);  

Argumentos

StatementHandle
[Entrada] Identificador de instrucciones.

CatalogName de
[Entrada] Nombre del catálogo de procedimientos. Si un controlador admite catálogos para algunos procedimientos, pero no para otros, como cuando el controlador recupera datos de dbMS diferentes, una cadena vacía ("") denota esos procedimientos que no tienen catálogos. CatalogName no puede contener un patrón de búsqueda de cadenas.

Si el atributo de instrucción SQL_ATTR_METADATA_ID se establece en SQL_TRUE, CatalogName se trata como un identificador y su caso no es significativo. Si es SQL_FALSE, CatalogName es un argumento ordinario; se trata literalmente y su caso es significativo. Para obtener más información, vea Argumentos en funciones de catálogo.

NameLength1
[Entrada] Longitud en caracteres de *CatalogName.

schemaName de
[Entrada] Patrón de búsqueda de cadenas para los nombres de esquema de procedimiento. Si un controlador admite esquemas para algunos procedimientos, pero no para otros, como cuando el controlador recupera datos de dbMS diferentes, una cadena vacía ("") denota esos procedimientos que no tienen esquemas.

Si el atributo de instrucción SQL_ATTR_METADATA_ID se establece en SQL_TRUE, SchemaName se trata como un identificador y su caso no es significativo. Si es SQL_FALSE, schemaName es un argumento de valor de patrón; se trata literalmente y su caso es significativo.

NameLength2
[Entrada] Longitud en caracteres de *SchemaName.

procName
[Entrada] Patrón de búsqueda de cadenas para los nombres de procedimiento.

Si el atributo de instrucción SQL_ATTR_METADATA_ID se establece en SQL_TRUE, procName se trata como un identificador y su caso no es significativo. Si es SQL_FALSE, procName es un argumento de valor de patrón; se trata literalmente y su caso es significativo.

NameLength3
[Entrada] Longitud en caracteres de *ProcName.

columnName
[Entrada] Patrón de búsqueda de cadenas para nombres de columna.

Si el atributo de instrucción SQL_ATTR_METADATA_ID se establece en SQL_TRUE, columnName se trata como un identificador y su caso no es significativo. Si es SQL_FALSE, columnName es un argumento de valor de patrón; se trata literalmente y su caso es significativo.

NameLength4
[Entrada] Longitud en caracteres de *ColumnName.

Devuelve

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnósticos

Cuando sqlProcedureColumns devuelve SQL_ERROR o SQL_SUCCESS_WITH_INFO, se puede obtener un valor SQLSTATE asociado llamando a SQLGetDiagRec con un HandleType de SQL_HANDLE_STMT y un Handle de StatementHandle. En la tabla siguiente se enumeran los valores SQLSTATE devueltos normalmente por SQLProcedureColumns y se explica cada uno en el contexto de esta función; la notación "(DM)" precede a las descripciones de SQLSTATEs devueltas por el Administrador de controladores. El código de retorno asociado a cada valor SQLSTATE es SQL_ERROR, a menos que se indique lo contrario.

Comentarios

Esta función se usa normalmente antes de la ejecución de instrucciones para recuperar información sobre los parámetros del procedimiento y las columnas que componen el conjunto de resultados o conjuntos devueltos por el procedimiento, si los hubiera. Para obtener más información, vea procedimientos de .

Los argumentosSchemaName , ProcNamey ColumnName aceptan patrones de búsqueda. Para obtener más información sobre los patrones de búsqueda válidos, vea Argumentos de valor de patrón.

sqlProcedureColumns devuelve los resultados como un conjunto de resultados estándar, ordenado por PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME y COLUMN_TYPE. Los nombres de columna se devuelven para cada procedimiento en el orden siguiente: el nombre del valor devuelto, los nombres de cada parámetro de la invocación de procedimiento (en orden de llamada) y, a continuación, los nombres de cada columna del conjunto de resultados devuelto por el procedimiento (en orden de columna).

Las aplicaciones deben enlazar columnas específicas del controlador en relación con el final del conjunto de resultados. Para obtener más información, vea datos devueltos por funciones de catálogo.

Para determinar las longitudes reales de las columnas PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME y COLUMN_NAME, una aplicación puede llamar a SQLGetInfo con las opciones SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_PROCEDURE_NAME_LEN y SQL_MAX_COLUMN_NAME_LEN.

Se ha cambiado el nombre de las columnas siguientes para ODBC 3.x. Los cambios de nombre de columna no afectan a la compatibilidad con versiones anteriores porque las aplicaciones enlazan por número de columna.

Las columnas siguientes se han agregado al conjunto de resultados devuelto por SQLProcedureColumns para ODBC 3.x:

• COLUMN_DEF

• DATETIME_CODE

• CHAR_OCTET_LENGTH

• ORDINAL_POSITION

• IS_NULLABLE

En la tabla siguiente se enumeran las columnas del conjunto de resultados. El controlador puede definir columnas adicionales más allá de la columna 19 (IS_NULLABLE). Una aplicación debe obtener acceso a columnas específicas del controlador contando hacia abajo desde el final del conjunto de resultados en lugar de especificar una posición ordinal explícita. Para obtener más información, vea datos devueltos por funciones de catálogo.

Ejemplo de código

Consulte llamadas a procedimiento.

Funciones relacionadas

Consulte también

referencia de LA API ODBC
archivos de encabezado ODBC