Функция SQLProcedureColumns

Соответствия
Представлена версия: соответствие стандартам ODBC 1.0: ODBC

Сводка
SQLProcedureColumns возвращает список входных и выходных параметров, а также столбцы, составляющие результирующий набор для указанных процедур. Драйвер возвращает сведения в виде результирующих наборов для указанной инструкции.

Синтаксис

  
SQLRETURN SQLProcedureColumns(  
     SQLHSTMT      StatementHandle,  
     SQLCHAR *     CatalogName,  
     SQLSMALLINT   NameLength1,  
     SQLCHAR *     SchemaName,  
     SQLSMALLINT   NameLength2,  
     SQLCHAR *     ProcName,  
     SQLSMALLINT   NameLength3,  
     SQLCHAR *     ColumnName,  
     SQLSMALLINT   NameLength4);  

Аргументы

ОператорHandle
[Входные данные] Дескриптор инструкции.

Имя каталога
[Входные данные] Имя каталога процедур. Если драйвер поддерживает каталоги для некоторых процедур, но не для других, например, когда драйвер извлекает данные из разных СУБД, пустая строка ("") обозначает те процедуры, которые не имеют каталогов. CatalogName не может содержать шаблон поиска строк.

Если для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, Имя каталога рассматривается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, CatalogName является обычным аргументом; он обрабатывается буквально, и его дело является значительным. Дополнительные сведения см. в разделе "Аргументы" в функциях каталога.

NameLength1
[Входные данные] Длина символов *CatalogName.

Schemaname
[Входные данные] Шаблон поиска строк для имен схем процедуры. Если драйвер поддерживает схемы для некоторых процедур, но не для других, например, когда драйвер извлекает данные из разных СУБД, пустая строка ("") обозначает эти процедуры, которые не имеют схем.

Если для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, schemaName обрабатывается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, SchemaName является аргументом значения шаблона; он обрабатывается буквально, и его случай является значительным.

NameLength2
[Входные данные] Длина символов *SchemaName.

ProcName
[Входные данные] Шаблон поиска строк для имен процедур.

Если для атрибута оператора SQL_ATTR_METADATA_ID задано значение SQL_TRUE, ProcName обрабатывается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, ProcName является аргументом значения шаблона; он обрабатывается буквально, и его дело является значительным.

NameLength3
[Входные данные] Длина символов *ProcName.

ColumnName
[Входные данные] Шаблон поиска строк для имен столбцов.

Если для атрибута оператора SQL_ATTR_METADATA_ID задано значение SQL_TRUE, ColumnName обрабатывается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, ColumnName является аргументом значения шаблона; он обрабатывается буквально, и его случай является значительным.

NameLength4
[Входные данные] Длина символов *ColumnName.

Возвраты

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR или SQL_INVALID_HANDLE.

Диагностика

Когда SQLProcedureColumns возвращает SQL_ERROR или SQL_SUCCESS_WITH_INFO, связанное значение SQLSTATE можно получить путем вызова SQLGetDiagRec с помощью HandleType SQL_HANDLE_STMT и handle of StatementHandle. В следующей таблице перечислены значения SQLSTATE, которые обычно возвращаются SQLProcedureColumns и объясняются каждый из них в контексте этой функции. Нотация "(DM)" предшествует описаниям SQLSTATEs, возвращаемым диспетчером драйверов. Возвращаемый код, связанный с каждым значением SQLSTATE, SQL_ERROR, если не указано иное.

Комментарии

Эта функция обычно используется перед выполнением инструкции для получения сведений о параметрах процедуры и столбцах, составляющих результирующий набор или наборы, возвращаемые процедурой, если таковые есть. Дополнительные сведения см. в разделе Procedures in Visual Basic (Процедуры в Visual Basic).

Аргументы SchemaName, ProcName и ColumnNameпринимают шаблоны поиска. Дополнительные сведения о допустимых шаблонах поиска см. в разделе "Аргументы значения шаблона".

SQLProcedureColumns возвращает результаты в виде стандартного результирующий набор, упорядоченный по PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME и COLUMN_TYPE. Имена столбцов возвращаются для каждой процедуры в следующем порядке: имя возвращаемого значения, имена каждого параметра в вызове процедуры (в порядке вызова), а затем имена каждого столбца в результирующем наборе, возвращаемом процедурой (в порядке столбца).

Приложения должны привязывать столбцы, относящиеся к драйверу, относительно конца результирующего набора. Дополнительные сведения см. в разделе "Данные, возвращаемые функциями каталога".

Чтобы определить фактическую длину столбцов PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME и COLUMN_NAME, приложение может вызывать SQLGetInfo с параметрами SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_PROCEDURE_NAME_LEN и SQL_MAX_COLUMN_NAME_LEN.

Следующие столбцы были переименованы для ODBC 3.x. Изменения имени столбца не влияют на обратную совместимость, так как приложения привязываются по номеру столбца.

Следующие столбцы были добавлены в набор результатов, возвращенный SQLProcedureColumns для ODBC 3.x:

• COLUMN_DEF

• DATETIME_CODE

• CHAR_OCTET_LENGTH

• ORDINAL_POSITION

• IS_NULLABLE

В следующей таблице перечислены столбцы в результирующем наборе. Дополнительные столбцы за пределами столбца 19 (IS_NULLABLE) можно определить драйвером. Приложение должно получить доступ к столбцам для конкретного драйвера, отсчитывая от конца результирующего набора, а не указывая явное порядковое положение. Дополнительные сведения см. в разделе "Данные, возвращаемые функциями каталога".

Пример кода

См . вызовы процедур.

Связанные функции

См. также

Справочник по API ODBC
Файлы заголовков ODBC