Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Conformidad
Versión introducida: Cumplimiento de Normas ODBC 1.0: ODBC
Resumen
SQLProcedures devuelve la lista de nombres de procedimientos almacenados en una fuente de datos específica.
Procedimiento es un término genérico utilizado para describir un objeto ejecutable, o una entidad nombrada que puede invocarse usando parámetros de entrada y salida. Para más información sobre procedimientos, consulte los Procedimientos.
Syntax
SQLRETURN SQLProcedures(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3);
Arguments
StatementHandle
[Entrada] Identificador de instrucciones.
CatalogName
[Entrada] Catálogo de procedimientos. Si un controlador soporta catálogos para algunas tablas pero no para otras, como cuando el controlador recupera datos de diferentes SGBD, una cadena vacía ("") denota aquellas tablas que no tienen catálogos.
CatalogName no puede contener un patrón de búsqueda en cadenas.
Si el atributo de la sentencia 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, Nombre de Catálogo es un argumento ordinario; Se trata literalmente, y su caso es significativo. Para obtener más información, consulte Argumentos en funciones de catálogo.
NameLength1
[Entrada] Longitud en caracteres de *NombreDeCatálogo.
SchemaName
[Entrada] Patrón de búsqueda de cadenas para nombres de esquemas de procedimientos. Si un controlador soporta esquemas para algunos procedimientos pero no para otros, como cuando recupera datos de diferentes SGBD, una cadena vacía ("") denota aquellos procedimientos que no tienen esquemas.
Si el atributo de la sentencia 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, Nombre de Esquema es un argumento de valor de patrón; Se trata literalmente, y su caso es significativo.
NameLength2
[Entrada] Longitud en caracteres de *NombreEsquema.
ProcName
[Entrada] Patrón de búsqueda de cadenas para nombres de procedimientos.
Si el atributo de la sentencia SQL_ATTR_METADATA_ID se establece en SQL_TRUE, ProcName se considera 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.
Returns
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.
Diagnostics
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 Handle de StatementHandle. La siguiente tabla enumera los valores de SQLSTATE que comúnmente devuelven SQLProcedures y explica cada uno en el contexto de esta función; la notación "(DM)" precede a las descripciones de los SQLSTATE devueltas por el Driver Manager. El código de retorno asociado a cada valor SQLSTATE es SQL_ERROR, a menos que se indique lo contrario.
| SQLSTATE | Error | Description |
|---|---|---|
| 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 | Había un cursor abierto en el StatementHandle, y se había 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. Había un cursor abierto en el HandleStatement, pero no se había llamado a SQLFetch ni 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 genérico | 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 la sentencia SQL_ATTR_METADATA_ID se estableció en SQL_TRUE, el argumento Nombre del Catálogo era un puntero nulo, y el InfoType SQL_CATALOG_NAME devuelve que los nombres de catálogo están soportados. (DM) El atributo de la sentencia SQL_ATTR_METADATA_ID se estableció en SQL_TRUE, y el argumento Nombre de Esquema o Nombre de Proc era un puntero nulo. |
| HY010 | Error de secuencia de funciones | (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 seguía ejecutándose cuando se llamó a esta función. (DM) SQLExecute, SQLExecDirect o SQLMoreResults se llamó a para statementHandle 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 que ejecuta de forma 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 el statementHandle 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 tener acceso 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 del 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 al estado de transacción desconocido. Solo se permiten las funciones de desconexión y 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 la fuente de datos no soporta catálogos. Se especificó un esquema de procedimiento, y el controlador o fuente de datos no soporta esquemas. Se especificó un patrón de búsqueda en cadena para el esquema o nombre del procedimiento, y la fuente de datos no soporta patrones de búsqueda para uno o más de esos argumentos. La combinación de la configuración actual de la SQL_ATTR_CONCURRENCY y los atributos de instrucción SQL_ATTR_CURSOR_TYPE no se admiten en 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 | Se ha agotado el tiempo de espera | El período de tiempo de espera de la consulta expiró antes de que el origen de datos devolviera el conjunto de resultados solicitado. El período de tiempo de espera se establece mediante 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 respondiera 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 al HandleStatement no soporta 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 procesamiento posterior y completar la operación. |
Comentarios
SQLProcedures lista todos los procedimientos dentro del rango 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 la información SQL_ACCESSIBLE_PROCEDURES. De lo contrario, la aplicación debe ser capaz de manejar una situación en la que el usuario seleccione un procedimiento que no pueda ejecutar. Para información sobre cómo podría utilizarse esta información, consulte Procedimientos.
Note
Para obtener más información sobre el uso general, los argumentos y los datos devueltos de 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.
Note
SQLProcedures puede que no devuelva todos los procedimientos. Las aplicaciones pueden usar cualquier procedimiento válido, independientemente de si SQLProcedures lo devuelve.
Las siguientes columnas han sido renombradas como ODBC 3*.x*. Los cambios en el nombre de las columnas no afectan la compatibilidad hacia atrás porque las aplicaciones se vinculan por número de columna.
| Columna ODBC 2.0 | Columna ODBC 3*.x* |
|---|---|
| PROCEDURE_QUALIFIER | CATEGORÍA_DE_PROCEDIMIENTO |
| PROCEDURE _OWNER | PROCEDURE _SCHEM |
Para determinar la longitud real de las columnas PROCEDURE_CAT, PROCEDURE_SCHEM y PROCEDURE_NAME, una aplicación puede llamar a SQLGetInfo con las opciones 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 acceder a columnas específicas del controlador contando hacia atrás 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 dato | Comentarios |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | Identificador de catálogo de procedimientos; NULL si no es aplicable a la fuente de datos. Si un controlador soporta catálogos para algunos procedimientos pero no para otros, como cuando recupera datos de diferentes SGBD, devuelve una cadena vacía ("") para aquellos procedimientos que no tienen catálogos. |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | Identificador de esquema de procedimiento; NULL si no es aplicable a la fuente de datos. Si un controlador soporta esquemas para algunos procedimientos pero no para otros, como cuando recupera datos de diferentes SGBD, devuelve una cadena vacía ("") para aquellos 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/A | Reservado para uso futuro. Las aplicaciones no deben basarse en los datos devueltos en estas columnas de resultados. |
| NUM_OUTPUT_PARAMS (ODBC 2.0) | 5 | N/A | Reservado para uso futuro. Las aplicaciones no deben basarse en los datos devueltos en estas columnas de resultados. |
| NUM_RESULT_SETS (ODBC 2.0) | 6 | N/A | Reservado para uso futuro. Las aplicaciones no deben basarse en los datos devueltos en estas columnas de resultados. |
| OBSERVACIONES (ODBC 2.0) | 7 | Varchar | Una 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 valor de retorno. SQL_PT_FUNCTION: El objeto devuelto es una función; es decir, tiene un valor de retorno. |
Los argumentos SchemaName y ProcName aceptan patrones de búsqueda. Para más información sobre patrones de búsqueda válidos, véase Argumentos de Valor de Patrón.
Ejemplo de código
Consulta Llamadas de Procedimiento.
Funciones relacionadas
| Para obtener información sobre | Vea |
|---|---|
| Enlazar un búfer a una columna de un conjunto de resultados | Función SQLBindCol |
| Cancelación del procesamiento de instrucciones | Función SQLCancel |
| Obtención de una sola fila o bloque de datos en dirección solo directa | 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 fuente 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 |