Resumo de funções do ODBC
A tabela a seguir lista as funções ODBC, agrupadas por tipo de tarefa, e inclui a designação de conformidade e uma breve descrição da finalidade de cada função. Para obter mais informações sobre designações de conformidade, consulte ODBC e a CLI. Para obter mais informações sobre a sintaxe e a semântica de cada função, consulte Referência da API ODBC.
Um aplicativo pode chamar a função SQLGetInfo para obter informações de conformidade sobre um driver. Para obter informações sobre o suporte para uma função específica em um driver, um aplicativo pode chamar SQLGetFunctions.
| Tarefa | Nome da função | Compatibilidade | Finalidade |
|---|---|---|---|
| Conectando a uma fonte de dados | SQLAllocHandle | ISO 92 | Obtém um identificador de ambiente, conexão, instrução ou descritor. |
| SQLConnect | ISO 92 | Conecta-se a um driver específico por nome de fonte de dados, ID de usuário e senha. | |
| SQLDriverConnect | ODBC | Conecta-se a um driver específico por cadeia de conexão ou solicita que o Gerenciador de Driver e o driver exibam caixas de diálogo de conexão para o usuário. | |
| SQLBrowseConnect | ODBC | Retorna níveis sucessivos de atributos de conexão e valores de atributo válidos. Quando um valor tiver sido especificado para cada atributo de conexão, conecta-se à fonte de dados. | |
| Obtendo informações sobre um driver e uma fonte de dados | SQLDataSources SQLDrivers |
ISO 92 ODBC |
Retorna a lista de fontes de dados disponíveis. Retorna a lista de drivers instalados e seus atributos. |
| SQLGetInfo | ISO 92 | Retorna informações sobre um driver e uma fonte de dados específicos. | |
| SQLGetFunctions | ISO 92 | Retorna funções de driver com suporte. | |
| SQLGetTypeInfo | ISO 92 | Retorna informações sobre os tipos de dados compatíveis. | |
| Configurando e recuperando atributos de driver | SQLSetConnectAttr SQLGetConnectAttr |
ISO 92 ISO 92 |
Define um atributo de conexão. Retorna o valor de um atributo de conexão. |
| SQLSetEnvAttr | ISO 92 | Define um atributo de ambiente. | |
| SQLGetEnvAttr | ISO 92 | Retorna o valor de um atributo de ambiente. | |
| SQLSetStmtAttr | ISO 92 | Define um atributo de instrução. | |
| SQLGetStmtAttr | ISO 92 | Retorna o valor de um atributo de instrução. | |
| Configurando e recuperando campos de descritor | SQLGetDescField SQLGetDescRec |
ISO 92 ISO 92 |
Retorna o valor de um único campo de descritor. Retorna os valores de vários campos de descritor. |
| SQLSetDescField | ISO 92 | Define um único campo de descritor. | |
| SQLSetDescRec | ISO 92 | Define vários campos de descritor. | |
| SQLCopyDesc | ISO 92 | Copia informações do descritor de um identificador de descritor para outro. | |
| Preparando solicitações SQL | SQLPrepare | ISO 92 | Prepara uma instrução SQL para execução posterior. |
| SQLBindParameter | ODBC | Atribui armazenamento para um parâmetro em uma instrução SQL. | |
| SQLGetCursorName | ISO 92 | Retorna o nome do cursor associado a um identificador de instrução. | |
| SQLSetCursorName | ISO 92 | Especifica um nome de cursor. | |
| SQLSetScrollOptions | ODBC | Define opções que controlam o comportamento do cursor. | |
| Enviando solicitações | SQLExecute SQLExecDirect |
ISO 92 ISO 92 |
Executa uma instrução preparada. Executa uma instrução. |
| SQLNativeSql | ODBC | Retorna o texto de uma instrução SQL conforme convertido pelo driver. | |
| SQLDescribeParam | ODBC | Retorna a descrição de um parâmetro específico em uma instrução. | |
| SQLNumParams | ISO 92 | Retorna o número de parâmetros em uma instrução. | |
| SQLParamData | ISO 92 | Usado em conjunto com SQLPutData para fornecer dados de parâmetro em tempo de execução. (Útil para valores de dados longos.) | |
| SQLPutData | ISO 92 | Envia parte ou todo o valor de dados para um parâmetro. (Útil para valores de dados longos.) | |
| Recuperando resultados e informações sobre resultados | SQLRowCount SQLNumResultCols |
ISO 92 ISO 92 |
Retorna o número de linhas afetadas por uma solicitação de inserção, atualização ou exclusão. Retorna o número de colunas no conjunto de resultados. |
| SQLDescribeCol | ISO 92 | Descreve uma coluna no conjunto de resultados. | |
| SQLColAttribute | ISO 92 | Descreve os atributos de uma coluna no conjunto de resultados. | |
| SQLBindCol | ISO 92 | Atribui armazenamento para uma coluna de resultado e especifica o tipo de dados. | |
| SQLFetch | ISO 92 | Retorna várias linhas de resultados. | |
| SQLFetchScroll | ISO 92 | Retorna linhas de resultado roláveis. | |
| SQLGetData | ISO 92 | Retorna parte ou toda de uma coluna de uma linha de um conjunto de resultados. (Útil para valores de dados longos.) | |
| SQLSetPos | ODBC | Posiciona um cursor dentro de um bloco de dados buscado e permite que um aplicativo atualize dados no conjunto de linhas ou atualize ou exclua dados no conjunto de resultados. | |
| SQLBulkOperations | ODBC | Executa inserções em massa e operações de indicadores em massa, incluindo atualização, exclusão e busca por indicador. | |
| SQLMoreResults | ODBC | Determina se há mais conjuntos de resultados disponíveis e, em caso afirmativo, inicializa o processamento para o próximo conjunto de resultados. | |
| SQLGetDiagField | ISO 92 | Retorna informações de diagnóstico adicionais (um único campo da estrutura de dados de diagnóstico). | |
| SQLGetDiagRec | ISO 92 | Retorna informações de diagnóstico adicionais (vários campos da estrutura de dados de diagnóstico). | |
| Obtendo informações sobre as tabelas do sistema da fonte de dados (funções de catálogo) | SQLColumnPrivileges SQLColumns |
ODBC Open Group |
Retorna uma lista de colunas e privilégios associados para uma ou mais tabelas. Retorna a lista de nomes de coluna em tabelas especificadas. |
| SQLForeignKeys | ODBC | Retorna uma lista de nomes de coluna que compõem chaves estrangeiras, se existirem para uma tabela especificada. | |
| SQLPrimaryKeys | ODBC | Retorna a lista de nomes de coluna que compõem a chave primária de uma tabela. | |
| SQLProcedureColumns | ODBC | Retorna a lista de parâmetros de entrada e saída, bem como as colunas que compõem o conjunto de resultados para os procedimentos especificados. | |
| SQLProcedures | ODBC | Retorna a lista de nomes de procedimentos armazenados em uma fonte de dados específica. | |
| SQLSpecialColumns | Open Group | Retorna informações sobre o conjunto ideal de colunas que identifica exclusivamente uma linha em uma tabela especificada ou as colunas que são atualizadas automaticamente quando qualquer valor na linha é atualizado por uma transação. | |
| SQLStatistics | ISO 92 | Retorna estatísticas sobre uma única tabela e a lista de índices associados à tabela. | |
| SQLTablePrivileges | ODBC | Retorna uma lista de tabelas e os privilégios associados a cada tabela. | |
| SQLTables | Open Group | Retorna a lista de nomes de tabela armazenados em uma fonte de dados específica. | |
| Encerrando uma instrução | SQLFreeStmt | ISO 92 | Encerra o processamento da instrução, descarta os resultados pendentes e, opcionalmente, libera todos os recursos associados ao identificador da instrução. |
| SQLCloseCursor | ISO 92 | Fecha um cursor que foi aberto em um identificador de instrução. | |
| SQLCancel | ISO 92 | Cancela o processamento em um demonstrativo. | |
| SQLCancelHandle | ODBC | Cancela o processamento em um demonstrativo ou conexão. | |
| SQLEndTran | ISO 92 | Confirma ou reverte uma transação. | |
| Encerrando uma conexão | SQLDisconnect SQLFreeHandle |
ISO 92 ISO 92 |
Encerra a conexão. Libera um ambiente, conexão, instrução ou identificador de descritor. |