Функция SQLProcedures

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

Сводка
SQLProcedures возвращает список имён процедур, хранящихся в конкретном источнике данных. Процедура — это общий термин, используемый для описания исполняемого объекта или именованной сущности, которую можно вызвать с помощью входных и выходных параметров. Для получения дополнительной информации о процедурах см. раздел «Процедуры».

Syntax

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

Arguments

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

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

Если атрибут оператора SQL_ATTR_METADATA_ID установлен в SQL_TRUE, CatalogName рассматривается как идентификатор, и его падеж не является значимым. Если это 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.

Returns

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

Diagnostics

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

Comments

SQLProcedures перечисляет все процедуры в запрошенном диапазоне. Пользователь может иметь или не иметь разрешения на выполнение любой из этих процедур. Для проверки доступности приложение может позвонить в SQLGetInfo и проверить значение SQL_ACCESSIBLE_PROCEDURES информации. В противном случае приложение должно уметь справляться с ситуацией, когда пользователь выбирает процедуру, которую он не может выполнить. Для получения информации о том, как эта информация может использоваться, см. раздел Процедуры.

SQLProcedures возвращает результаты как стандартный набор результатов, упорядоченный по PROCEDURE_CAT, PROCEDURE_SCHEMA и PROCEDURE_NAME.

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

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

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

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

Пример кода

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

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

См. также

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