Función SQLProcedures

  • Artículo

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

Resumen
SQLProcedures devuelve la lista de nombres de procedimiento almacenados en un origen de datos específico. Procedure es un término genérico que se usa para describir un objeto ejecutable o una entidad con nombre que se puede invocar mediante parámetros de entrada y salida. Para obtener más información sobre los procedimientos, vea Procedimientos.

Sintaxis

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

Argumentos

StatementHandle
[Entrada] Identificador de instrucción.

CatalogName
[Entrada] Catálogo de procedimientos. Si un controlador admite catálogos para algunas tablas, pero no para otras, como cuando el controlador recupera datos de diferentes DBMS, una cadena vacía ("") denota esas tablas 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 normal; 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
[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 diferentes DBMS, 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.

Devoluciones

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnóstico

Cuando SQLProcedures 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 identificador de StatementHandle. En la tabla siguiente se enumeran los valores SQLSTATE devueltos normalmente por SQLProcedures 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.

SQLSTATE Error Descripción
01000 Advertencia general Mensaje informativo específico del controlador. (Function devuelve SQL_SUCCESS_WITH_INFO).
08S01 Error de vínculo de comunicación Se produjo un error en el vínculo de comunicación entre el controlador y el origen de datos al que se conectó el controlador antes de que la función completara el procesamiento.
24000 Estado de cursor no válido Se ha abierto un cursor en StatementHandle y se ha llamado a SQLFetch o SQLFetchScroll . El Administrador de controladores devuelve este error si SQLFetch o SQLFetchScroll no ha devuelto SQL_NO_DATA y el controlador devuelve si SQLFetch o SQLFetchScroll ha devuelto SQL_NO_DATA.

Se ha abierto un cursor en StatementHandle, pero no se ha llamado a SQLFetch o SQLFetchScroll .
40001 Error de serialización La transacción se revierte debido a un interbloqueo de recursos con otra transacción.
40003 Finalización de instrucciones desconocida Error en la conexión asociada durante la ejecución de esta función y no se puede determinar el estado de la transacción.
HY000 Error general Se produjo un error para el que no había ningún SQLSTATE específico y para el que no se definió SQLSTATE específico de la implementación. El mensaje de error devuelto por SQLGetDiagRec en el búfer *MessageText describe el error y su causa.
HY001 Error de asignación de memoria El controlador no pudo asignar memoria necesaria para admitir la ejecución o finalización de la función.
HY008 Operación cancelada El procesamiento asincrónico se ha habilitado para StatementHandle. Se llamó a la función y antes de completar la ejecución, se llamó a SQLCancel o SQLCancelHandle en statementHandle. A continuación, se llamó a la función de nuevo en StatementHandle.

Se llamó a la función y antes de completar la ejecución, se llamó a SQLCancel o SQLCancelHandle en statementHandle desde un subproceso diferente en una aplicación multiproceso.
HY009 Uso no válido del puntero nulo El atributo de instrucción SQL_ATTR_METADATA_ID se estableció en SQL_TRUE, el argumento CatalogName era un puntero nulo y el SQL_CATALOG_NAME InfoType devuelve que se admiten nombres de catálogo.

(DM) El atributo de instrucción SQL_ATTR_METADATA_ID se estableció en SQL_TRUE y el argumento SchemaName o ProcName era un puntero nulo.
HY010 Error de secuencia de función (DM) Se llamó a una función de ejecución asincrónica para el identificador de conexión asociado a StatementHandle. Esta función asincrónica todavía se estaba ejecutando cuando se llamó a esta función.

(DM) SE llamó a SQLExecute, SQLExecDirect o SQLMoreResults para la instrucciónHandle y devolvió SQL_PARAM_DATA_AVAILABLE. Se llamó a esta función antes de recuperar los datos para todos los parámetros transmitidos.

(DM) Se llamó a una función de ejecución asincrónica (no esta) para statementHandle y todavía se estaba ejecutando cuando se llamó a esta función.

(DM) SE llamó a SQLExecute, SQLExecDirect, SQLBulkOperations o SQLSetPos para la instrucciónHandle y devolvió SQL_NEED_DATA. Se llamó a esta función antes de enviar datos para todos los parámetros o columnas de datos en ejecución.
HY013 Error de administración de memoria No se pudo procesar la llamada de función porque no se pudo acceder a los objetos de memoria subyacentes, posiblemente debido a condiciones de memoria baja.
HY090 Longitud de búfer o cadena no válida (DM) El valor de uno de los argumentos de longitud de nombre era menor que 0, pero no igual a SQL_NTS.

El valor de uno de los argumentos de longitud de nombre superó el valor de longitud máxima para el nombre correspondiente.
HY117 La conexión se suspende debido a un estado de transacción desconocido. Solo se permiten funciones de desconexión y de solo lectura. (DM) Para obtener más información sobre el estado suspendido, vea Función SQLEndTran.
HYC00 Característica opcional no implementada Se especificó un catálogo de procedimientos y el controlador o el origen de datos no admite catálogos.

Se especificó un esquema de procedimiento y el controlador o el origen de datos no admite esquemas.

Se especificó un patrón de búsqueda de cadenas para el nombre del procedimiento o del procedimiento, y el origen de datos no admite patrones de búsqueda para uno o varios de esos argumentos.

La combinación de la configuración actual de los atributos de instrucción SQL_ATTR_CONCURRENCY y SQL_ATTR_CURSOR_TYPE no era compatible con el controlador o el origen de datos.

El atributo de instrucción SQL_ATTR_USE_BOOKMARKS se estableció en SQL_UB_VARIABLE y el atributo de instrucción SQL_ATTR_CURSOR_TYPE se estableció en un tipo de cursor para el que el controlador no admite marcadores.
HYT00 Tiempo de espera agotado El período de tiempo de espera de la consulta expiró antes de que el origen de datos devolva el conjunto de resultados solicitado. El período de tiempo de espera se establece a través de SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT.
HYT01 Se ha agotado el tiempo de espera de la conexión. El período de tiempo de espera de conexión expiró antes de que el origen de datos responda a la solicitud. El período de tiempo de espera de conexión se establece a través de SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT.
IM001 El controlador no admite esta función (DM) El controlador asociado a StatementHandle no admite esta función.
IM017 El sondeo está deshabilitado en modo de notificación asincrónica Cada vez que se usa el modelo de notificación, el sondeo está deshabilitado.
IM018 No se ha llamado a SQLCompleteAsync para completar la operación asincrónica anterior en este identificador. Si la llamada de función anterior en el identificador devuelve SQL_STILL_EXECUTING y si el modo de notificación está habilitado, se debe llamar a SQLCompleteAsync en el identificador para realizar el posprocesamiento y completar la operación.

Comentarios

SQLProcedures enumera todos los procedimientos del intervalo solicitado. Un usuario puede o no tener permiso para ejecutar cualquiera de estos procedimientos. Para comprobar la accesibilidad, una aplicación puede llamar a SQLGetInfo y comprobar el valor de información SQL_ACCESSIBLE_PROCEDURES. De lo contrario, la aplicación debe ser capaz de controlar una situación en la que el usuario selecciona un procedimiento que no se puede ejecutar. Para obtener información sobre cómo se puede usar esta información, vea Procedimientos.

Nota

Para obtener más información sobre el uso general, los argumentos y los datos devueltos de las funciones de catálogo ODBC, vea Funciones de catálogo.

SQLProcedures devuelve los resultados como un conjunto de resultados estándar, ordenado por PROCEDURE_CAT, PROCEDURE_SCHEMA y PROCEDURE_NAME.

Nota

Es posible que SQLProcedures no devuelva todos los procedimientos. Las aplicaciones pueden usar cualquier procedimiento válido, independientemente de si SQLProcedures lo devuelve.

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

Columna ODBC 2.0 Columna ODBC 3*.x*
PROCEDURE_QUALIFIER PROCEDURE_CAT
_OWNER PROCEDURE PROCEDIMIENTO _SCHEM

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

En la tabla siguiente se enumeran las columnas del conjunto de resultados. El controlador puede definir columnas adicionales más allá de la columna 8 (PROCEDURE_TYPE). 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.

Nombre de la columna Número de columna Tipo de datos Comentarios
PROCEDURE_CAT (ODBC 2.0) 1 Varchar Identificador del catálogo de procedimientos; NULL si no es aplicable al origen de datos. Si un controlador admite catálogos para algunos procedimientos, pero no para otros, como cuando el controlador recupera datos de dbMS diferentes, devuelve una cadena vacía ("") para los procedimientos que no tienen catálogos.
PROCEDURE_SCHEM (ODBC 2.0) 2 Varchar Identificador de esquema de procedimiento; NULL si no es aplicable al origen de datos. Si un controlador admite esquemas para algunos procedimientos, pero no para otros, como cuando el controlador recupera datos de dbMS diferentes, devuelve una cadena vacía ("") para los procedimientos que no tienen esquemas.
PROCEDURE_NAME (ODBC 2.0) 3 Varchar no NULL Identificador de procedimiento.
NUM_INPUT_PARAMS (ODBC 2.0) 4 N/D Reservado para uso futuro. Las aplicaciones no deben depender de los datos devueltos en estas columnas de resultados.
NUM_OUTPUT_PARAMS (ODBC 2.0) 5 N/D Reservado para uso futuro. Las aplicaciones no deben depender de los datos devueltos en estas columnas de resultados.
NUM_RESULT_SETS (ODBC 2.0) 6 N/D Reservado para uso futuro. Las aplicaciones no deben depender de los datos devueltos en estas columnas de resultados.
COMENTARIOS (ODBC 2.0) 7 Varchar Descripción del procedimiento.
PROCEDURE_TYPE (ODBC 2.0) 8 Smallint Define el tipo de procedimiento:

SQL_PT_UNKNOWN: no se puede determinar si el procedimiento devuelve un valor.

SQL_PT_PROCEDURE: el objeto devuelto es un procedimiento; es decir, no tiene un valor devuelto.

SQL_PT_FUNCTION: el objeto devuelto es una función; es decir, tiene un valor devuelto.

Los argumentos SchemaName y ProcName 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.

Ejemplo de código

Consulte Llamadas a procedimiento.

Para información acerca de Vea
Enlace de un búfer a una columna de un conjunto de resultados SQLBindCol (función)
Cancelación del procesamiento de instrucciones Función SQLCancel
Capturar una sola fila o un bloque de datos en una dirección de solo avance Función SQLFetch
Capturar un bloque de datos o desplazarse por un conjunto de resultados Función SQLFetchScroll
Devolver información sobre un controlador o un origen de datos Función SQLGetInfo
Devolver los parámetros y las columnas del conjunto de resultados de un procedimiento Función SQLProcedureColumns
Sintaxis para invocar procedimientos almacenados Ejecutar instrucciones

Consulte también

Referencia de API ODBC
Archivos de encabezado de ODBC