Compartilhar via


SQLProcedureColumns

Aplica-se a: SQL Server Banco de Dados SQL do Azure Instância Gerenciada de SQL do Azure PDW (Sistema de Plataforma de Análise) do Azure Synapse Analytics

SQLProcedureColumns retorna uma linha relatando os atributos de valor retornado de todos os procedimentos armazenados do SQL Server.

SQLProcedureColumns retorna SQL_SUCCESS independentemente da existência de valores para os parâmetros CatalogName, SchemaName, ProcNameou ColumnName . SQLFetch retorna SQL_NO_DATA quando são usados valores inválidos nesses parâmetros.

SQLProcedureColumns pode ser executado em um cursor de servidor estático. Uma tentativa de executar SQLProcedureColumns em um cursor atualizável (dinâmico ou conjunto de chaves) retornará SQL_SUCCESS_WITH_INFO, indicando que o tipo de cursor foi alterado.

A tabela a seguir lista as colunas retornadas pelo conjunto de resultados e como elas foram estendidas para lidar com os tipos de dados udt e xml por meio do driver ODBC do SQL Server Native Client:

Nome da coluna Descrição
SS_UDT_CATALOG_NAME Retorna o nome do catálogo que contém o UDT (tipo definido pelo usuário).
SS_UDT_SCHEMA_NAME Retorna o nome do esquema que contém o UDT.
SS_UDT_ASSEMBLY_TYPE_NAME Retorna o nome qualificado do assembly do UDT.
SS_XML_SCHEMACOLLECTION_CATALOG_NAME Retorna o nome do catálogo no qual é definido o nome de uma coleção de esquemas XML. Se não for possível localizar o nome do catálogo, essa variável conterá uma cadeia de caracteres vazia.
SS_XML_SCHEMACOLLECTION_SCHEMA_NAME Retorna o nome do esquema no qual é definido o nome de uma coleção de esquemas XML. Se não for possível localizar o nome do esquema, essa variável conterá uma cadeia de caracteres vazia.
SS_XML_SCHEMACOLLECTION_NAME Retorna o nome de uma coleção de esquemas XML. Se não for possível localizar o nome, essa variável conterá uma cadeia de caracteres vazia.

SQLProcedureColumns e parâmetros com valor de tabela

SQLProcedureColumns manipula parâmetros com valor de tabela de maneira semelhante aos tipos CLR definidos pelo usuário. Em linhas retornadas para parâmetros com valor de tabela, as colunas têm os seguintes valores:

Nome da coluna Descrição/valor
DATA_TYPE SQL_SS_TABLE
TYPE_NAME O nome do tipo de tabela para o parâmetro com valor de tabela.
COLUMN_SIZE NULO
BUFFER_LENGTH 0
DECIMAL_DIGITS O número de colunas no parâmetro com valor de tabela.
NUM_PREC_RADIX NULO
NULLABLE SQL_NULLABLE
COMENTÁRIOS NULO
COLUMN_DEF NULL. Os tipos de tabela não podem ter valores padrão.
SQL_DATA_TYPE SQL_SS_TABLE
SQL_DATETIME_SUB NULO
CHAR_OCTET_LENGTH NULO
IS_NULLABLE "YES"
SS_TYPE_CATALOG_NAME Retorna o nome do catálogo que contém a tabela ou o tipo CLR definido pelo usuário.
SS_TYPE_SCHEMA_NAME Retorna o nome do esquema que contém a tabela ou o tipo CLR definido pelo usuário.

As colunas SS_TYPE_CATALOG_NAME e SS_TYPE_SCHEMA_NAME estão disponíveis no SQL Server 2008 (10.0.x) e versões posteriores para retornar o catálogo e o esquema, respectivamente, para parâmetros com valor de tabela. Essas colunas são preenchidas para parâmetros com valor de tabela e também para parâmetros de tipos CLR definidos pelo usuário. (As colunas de esquema e catálogo existentes para parâmetros de tipo CLR definidos pelo usuário não são afetadas por essa funcionalidade adicional. Eles também são preenchidos para manter a compatibilidade com versões anteriores).

Em conformidade com a especificação ODBC, SS_TYPE_CATALOG_NAME e SS_TYPE_SCHEMA_NAME aparecem antes de todas as colunas específicas do driver adicionadas em versões anteriores do SQL Server e depois de todas as colunas exigidas pelo próprio ODBC.

Para obter mais informações sobre parâmetros com valor de tabela, consulte ODBC (Parâmetros com valor de tabela).

Suporte de SQLProcedureColumns a recursos aprimorados de data e hora

Para obter os valores retornados para tipos de data/hora, consulte Catalog Metadata.

Para obter mais informações gerais, consulte Melhorias de data e hora (ODBC).

Suporte de SQLProcedureColumns a UDTs CLR grandes

SQLProcedureColumns dá suporte a tipos CLR definidos pelo usuário grandes. Para obter mais informações, consulte ODBC (Tipos Definidos pelo Usuário) CLR Grandes.

Confira também

Função SQLProcedureColumns
Detalhes da implementação da API do ODBC