SQLProcedureColumns
SQLProcedureColumns retorna uma linha relatando os atributos de valor de retorno de todos os procedimentos armazenados do SQL Server.
SQLProcedureColumns retorna SQL_SUCCESS se existem ou não valores para CatalogName, SchemaName, ProcNameou parâmetros de ColumnName. SQLFetch retorna SQL_NO_DATA quando valores inválidos são usados 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 teclas) 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 manipular 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 para assembly do UDT. |
| SS_XML_SCHEMACOLLECTION_CATALOG_NAME | Retorna o nome do catálogo onde um nome de coleção de esquema XML é definido. Se o nome do catálogo não puder ser encontrado, essa variável conterá uma cadeia de caracteres vazia. |
| SS_XML_SCHEMACOLLECTION_SCHEMA_NAME | Retorna o nome do esquema onde um nome de coleção de esquema XML é definido. Se o nome do esquema não puder ser encontrado, essa variável conterá uma cadeia de caracteres vazia. |
| SS_XML_SCHEMACOLLECTION_NAME | Retorna o nome de uma coleção de esquema XML. Se o nome não puder ser encontrado, essa variável conterá uma cadeia de caracteres vazia. |
SQLProcedureColumns e parâmetros Table-Valued
SQLProcedureColumns manipula parâmetros com valor de tabela de maneira semelhante aos tipos CLR definidos pelo usuário. Nas 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 |
| NULADO | SQL_NULLABLE |
| COMENTÁRIOS | NULO |
| COLUMN_DEF | NULO. Os tipos de tabela podem não ter valores padrão. |
| SQL_DATA_TYPE | SQL_SS_TABLE |
| SQL_DATETIME_SUB | NULO |
| CHAR_OCTET_LENGTH | NULO |
| IS_NULLABLE | "SIM" |
| 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 tipo definidos pelo usuário CLR. (As colunas de esquema e catálogo existentes para parâmetros de tipo definidos pelo usuário CLR 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 Parâmetros Table-Valued (ODBC).
Suporte SQLProcedureColumns para recursos avançados 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 SQLProcedureColumns para UDTs CLR grandes
SQLProcedureColumns suporta grandes tipos CLR definidos pelo usuário (UDTs). Para obter mais informações, consulte Large CLR User-Defined Types (ODBC).
Ver também
da função SQLProcedureColumns
Detalhes da implementação da API ODBC