Função SQLProcedures
Conformidade
Versão introduzida: Conformidade de padrões do ODBC 1.0: ODBC
Resumo
SQLProcedures retorna a lista de nomes de procedimento armazenados em uma fonte de dados específica. Procedure é um termo genérico usado para descrever um objeto executável ou uma entidade nomeada que pode ser invocada usando parâmetros de entrada e saída. Para obter mais informações sobre procedimentos, consulte Os Procedimentos.
Sintaxe
SQLRETURN SQLProcedures(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3);
Argumentos
StatementHandle
[Entrada] Identificador de instrução.
Catalogname
[Entrada] Catálogo de procedimentos. Se um driver der suporte a catálogos para algumas tabelas, mas não para outras, como quando o driver recupera dados de DBMSs diferentes, uma cadeia de caracteres vazia ("") indica essas tabelas que não têm catálogos. CatalogName não pode conter um padrão de pesquisa de cadeia de caracteres.
Se o atributo de instrução SQL_ATTR_METADATA_ID estiver definido como SQL_TRUE, CatalogName será tratado como um identificador e seu caso não será significativo. Se for SQL_FALSE, CatalogName será um argumento comum; é tratado literalmente, e seu caso é significativo. Para obter mais informações, consulte Argumentos em funções de catálogo.
NameLength1
[Entrada] Comprimento em caracteres de *CatalogName.
Schemaname
[Entrada] Padrão de pesquisa de cadeia de caracteres para nomes de esquema de procedimento. Se um driver der suporte a esquemas para alguns procedimentos, mas não para outros, como quando o driver recupera dados de DBMSs diferentes, uma cadeia de caracteres vazia ("") indica os procedimentos que não têm esquemas.
Se o atributo de instrução SQL_ATTR_METADATA_ID estiver definido como SQL_TRUE, SchemaName será tratado como um identificador e seu caso não será significativo. Se for SQL_FALSE, SchemaName será um argumento de valor padrão; é tratado literalmente, e seu caso é significativo.
NameLength2
[Entrada] Comprimento em caracteres de *SchemaName.
Procname
[Entrada] Padrão de pesquisa de cadeia de caracteres para nomes de procedimento.
Se o atributo de instrução SQL_ATTR_METADATA_ID estiver definido como SQL_TRUE, ProcName será tratado como um identificador e seu caso não será significativo. Se for SQL_FALSE, ProcName será um argumento de valor padrão; é tratado literalmente, e seu caso é significativo.
NameLength3
[Entrada] Comprimento em caracteres de *ProcName.
Retornos
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR ou SQL_INVALID_HANDLE.
Diagnósticos
Quando SQLProcedures retorna SQL_ERROR ou SQL_SUCCESS_WITH_INFO, um valor SQLSTATE associado pode ser obtido chamando SQLGetDiagRec com um HandleType de SQL_HANDLE_STMT e um Identificador de StatementHandle. A tabela a seguir lista os valores SQLSTATE normalmente retornados por SQLProcedures e explica cada um deles no contexto dessa função; a notação "(DM)" precede as descrições de SQLSTATEs retornadas pelo Gerenciador de Driver. O código de retorno associado a cada valor SQLSTATE é SQL_ERROR, a menos que indicado o contrário.
| SQLSTATE | Erro | Descrição |
|---|---|---|
| 01000 | Aviso geral | Mensagem informativa específica do driver. (A função retorna SQL_SUCCESS_WITH_INFO.) |
| 08S01 | Falha no link de comunicação | O link de comunicação entre o driver e a fonte de dados à qual o driver foi conectado falhou antes da função concluir o processamento. |
| 24.000 | Estado de cursor inválido | Um cursor foi aberto no StatementHandle e SQLFetch ou SQLFetchScroll foram chamados. Esse erro será retornado pelo Gerenciador de Driver se SQLFetch ou SQLFetchScroll não tiver retornado SQL_NO_DATA e for retornado pelo driver se SQLFetch ou SQLFetchScroll tiver retornado SQL_NO_DATA. Um cursor foi aberto no StatementHandle, mas SQLFetch ou SQLFetchScroll não foram chamados. |
| 40001 | Falha na serialização | A transação foi revertida devido a um deadlock de recursos com outra transação. |
| 40003 | Conclusão da instrução desconhecida | A conexão associada falhou durante a execução dessa função e o estado da transação não pode ser determinado. |
| HY000 | Erro geral | Ocorreu um erro para o qual não havia nenhum SQLSTATE específico e para o qual nenhum SQLSTATE específico da implementação foi definido. A mensagem de erro retornada por SQLGetDiagRec no buffer *MessageText descreve o erro e sua causa. |
| HY001 | Erro de alocação de memória | O driver não pôde alocar a memória necessária para dar suporte à execução ou à conclusão da função. |
| HY008 | Operação cancelada | O processamento assíncrono foi habilitado para StatementHandle. A função foi chamada e, antes de concluir a execução, SQLCancel ou SQLCancelHandle foi chamado no StatementHandle. Em seguida, a função foi chamada novamente no StatementHandle. A função foi chamada e antes de concluir a execução, SQLCancel ou SQLCancelHandle foi chamado no StatementHandle de um thread diferente em um aplicativo multithread. |
| HY009 | Uso inválido de ponteiro nulo | O atributo de instrução SQL_ATTR_METADATA_ID foi definido como SQL_TRUE, o argumento CatalogName era um ponteiro nulo e o SQL_CATALOG_NAME InfoType retorna que há suporte para nomes de catálogo. (DM) O atributo de instrução SQL_ATTR_METADATA_ID foi definido como SQL_TRUE e o argumento SchemaName ou ProcName era um ponteiro nulo. |
| HY010 | Erro de sequência de funções | (DM) Uma função em execução assíncrona foi chamada para o identificador de conexão associado ao StatementHandle. Essa função assíncrona ainda estava em execução quando essa função foi chamada. (DM) SQLExecute, SQLExecDirect ou SQLMoreResults foi chamado para StatementHandle e retornado SQL_PARAM_DATA_AVAILABLE. Essa função foi chamada antes de os dados serem recuperados para todos os parâmetros transmitidos. (DM) Uma função de execução assíncrona (não esta) foi chamada para StatementHandle e ainda estava em execução quando essa função foi chamada. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations ou SQLSetPos foram chamados para StatementHandle e retornados SQL_NEED_DATA. Essa função foi chamada antes de os dados serem enviados para todos os parâmetros ou colunas de dados em execução. |
| HY013 | Erro de gerenciamento de memória | A chamada de função não pôde ser processada porque os objetos de memória subjacentes não puderam ser acessados, possivelmente devido a condições de memória baixa. |
| HY090 | Comprimento de buffer ou cadeia de caracteres inválido | (DM) O valor de um dos argumentos de comprimento de nome era menor que 0, mas não igual a SQL_NTS. O valor de um dos argumentos de comprimento de nome excedeu o valor de comprimento máximo para o nome correspondente. |
| HY117 | A conexão está suspensa devido ao estado de transação desconhecido. Somente funções desconectar e somente leitura são permitidas. | (DM) Para obter mais informações sobre o estado suspenso, consulte Função SQLEndTran. |
| HYC00 | Recurso opcional não implementado | Um catálogo de procedimentos foi especificado e o driver ou fonte de dados não dá suporte a catálogos. Um esquema de procedimento foi especificado e o driver ou fonte de dados não dá suporte a esquemas. Um padrão de pesquisa de cadeia de caracteres foi especificado para o esquema de procedimento ou o nome do procedimento e a fonte de dados não dá suporte a padrões de pesquisa para um ou mais desses argumentos. A combinação das configurações atuais dos atributos de instrução SQL_ATTR_CONCURRENCY e SQL_ATTR_CURSOR_TYPE não era compatível com o driver ou a fonte de dados. O atributo de instrução SQL_ATTR_USE_BOOKMARKS foi definido como SQL_UB_VARIABLE e o atributo de instrução SQL_ATTR_CURSOR_TYPE foi definido como um tipo de cursor para o qual o driver não dá suporte a indicadores. |
| HYT00 | Tempo limite esgotado | O período de tempo limite da consulta expirou antes da fonte de dados retornar o conjunto de resultados solicitado. O período de tempo limite é definido por meio de SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT. |
| HYT01 | O tempo limite da conexão expirou | O período de tempo limite da conexão expirou antes da fonte de dados responder à solicitação. O período de tempo limite da conexão é definido por meio de SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT. |
| IM001 | O driver não dá suporte a essa função | (DM) O driver associado ao StatementHandle não dá suporte a essa função. |
| IM017 | A sondagem está desabilitada no modo de notificação assíncrona | Sempre que o modelo de notificação é usado, a sondagem é desabilitada. |
| IM018 | SQLCompleteAsync não foi chamado para concluir a operação assíncrona anterior nesse identificador. | Se a chamada de função anterior no identificador retornar SQL_STILL_EXECUTING e se o modo de notificação estiver habilitado, SQLCompleteAsync deverá ser chamado no identificador para fazer o pós-processamento e concluir a operação. |
Comentários
SQLProcedures lista todos os procedimentos no intervalo solicitado. Um usuário pode ou não ter permissão para executar qualquer um desses procedimentos. Para verificar a acessibilidade, um aplicativo pode chamar SQLGetInfo e verificar o valor das informações SQL_ACCESSIBLE_PROCEDURES. Caso contrário, o aplicativo deve ser capaz de lidar com uma situação em que o usuário seleciona um procedimento que não pode ser executado. Para obter informações sobre como essas informações podem ser usadas, consulte Procedimentos.
Observação
Para obter mais informações sobre o uso geral, argumentos e dados retornados de funções de catálogo ODBC, consulte Funções de catálogo.
SQLProcedures retorna os resultados como um conjunto de resultados padrão, ordenado por PROCEDURE_CAT, PROCEDURE_SCHEMA e PROCEDURE_NAME.
Observação
SQLProcedures pode não retornar todos os procedimentos. Os aplicativos podem usar qualquer procedimento válido, independentemente de serem retornados pelo SQLProcedures.
As colunas a seguir foram renomeada para ODBC 3*.x*. As alterações no nome da coluna não afetam a compatibilidade com versões anteriores porque os aplicativos são associados por número de coluna.
| Coluna ODBC 2.0 | Coluna ODBC 3*.x* |
|---|---|
| PROCEDURE_QUALIFIER | PROCEDURE_CAT |
| PROCEDIMENTO _OWNER | _SCHEM DE PROCEDIMENTO |
Para determinar os comprimentos reais das colunas PROCEDURE_CAT, PROCEDURE_SCHEM e PROCEDURE_NAME, um aplicativo pode chamar SQLGetInfo com as opções SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN e SQL_MAX_PROCEDURE_NAME_LEN.
A tabela a seguir lista as colunas no conjunto de resultados. Colunas adicionais além da coluna 8 (PROCEDURE_TYPE) podem ser definidas pelo driver. Um aplicativo deve obter acesso a colunas específicas do driver contando a partir do final do conjunto de resultados em vez de especificar uma posição ordinal explícita. Para obter mais informações, consulte Dados retornados por funções de catálogo.
| Nome da coluna | Número da coluna | Tipo de dados | Comentários |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | Identificador do catálogo de procedimentos; NULL se não for aplicável à fonte de dados. Se um driver der suporte a catálogos para alguns procedimentos, mas não para outros, como quando o driver recupera dados de DBMSs diferentes, ele retorna uma cadeia de caracteres vazia ("") para os procedimentos que não têm catálogos. |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | Identificador de esquema de procedimento; NULL se não for aplicável à fonte de dados. Se um driver der suporte a esquemas para alguns procedimentos, mas não para outros, como quando o driver recupera dados de DBMSs diferentes, ele retorna uma cadeia de caracteres vazia ("") para os procedimentos que não têm esquemas. |
| PROCEDURE_NAME (ODBC 2.0) | 3 | Varchar não NULL | Identificador de procedimento. |
| NUM_INPUT_PARAMS (ODBC 2.0) | 4 | N/D | Reservado para uso futuro. Os aplicativos não devem depender dos dados retornados nessas colunas de resultado. |
| NUM_OUTPUT_PARAMS (ODBC 2.0) | 5 | N/D | Reservado para uso futuro. Os aplicativos não devem depender dos dados retornados nessas colunas de resultado. |
| NUM_RESULT_SETS (ODBC 2.0) | 6 | N/D | Reservado para uso futuro. Os aplicativos não devem depender dos dados retornados nessas colunas de resultado. |
| COMENTÁRIOS (ODBC 2.0) | 7 | Varchar | Uma descrição do procedimento. |
| PROCEDURE_TYPE (ODBC 2.0) | 8 | Smallint | Define o tipo de procedimento: SQL_PT_UNKNOWN: não é possível determinar se o procedimento retorna um valor. SQL_PT_PROCEDURE: o objeto retornado é um procedimento; ou seja, ele não tem um valor retornado. SQL_PT_FUNCTION: o objeto retornado é uma função; ou seja, ele tem um valor retornado. |
Os argumentos SchemaName e ProcName aceitam padrões de pesquisa. Para obter mais informações sobre padrões de pesquisa válidos, consulte Argumentos de valor padrão.
Exemplo de código
Consulte Chamadas de procedimento.
Funções relacionadas
| Para obter informações sobre | Consulte |
|---|---|
| Associar um buffer a uma coluna em um conjunto de resultados | Função SQLBindCol |
| Cancelando o processamento da instrução | Função SQLCancel |
| Buscando uma única linha ou um bloco de dados em uma direção somente de avanço | Função SQLFetch |
| Buscando um bloco de dados ou rolando por um conjunto de resultados | Função SQLFetchScroll |
| Retornando informações sobre um driver ou fonte de dados | Função SQLGetInfo |
| Retornando os parâmetros e as colunas do conjunto de resultados de um procedimento | Função SQLProcedureColumns |
| Sintaxe para invocar procedimentos armazenados | Executando instruções |