Функция SQLProcedures

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

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

Синтаксис

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

Аргументы

Оператор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.

Возвраты

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

Диагностика

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

SQLSTATE	Error	Description
01000	Общее предупреждение	Информационное сообщение для конкретного драйвера. (Функция возвращает SQL_SUCCESS_WITH_INFO.)
08S01	Сбой связи	Связь между драйвером и источником данных, к которому был подключен драйвер, произошел сбой до завершения обработки функции.
24000	Недопустимое состояние курсора	Курсор был открыт на операторе StatementHandle, и был вызван SQLFetch или SQLFetchScroll . Эта ошибка возвращается диспетчером драйверов, если SQLFetch или SQLFetchScroll не вернул SQL_NO_DATA и возвращается драйвером, если SQLFetch или SQLFetchScroll вернул SQL_NO_DATA. Курсор был открыт на операторе StatementHandle, но не был вызван SQLFetch или SQLFetchScroll .
40001	Сбой сериализации	Транзакция была откатена из-за взаимоблокировки ресурсов с другой транзакцией.
40003	Неизвестное завершение инструкции	Связанное соединение завершилось сбоем во время выполнения этой функции, и состояние транзакции невозможно определить.
HY000	Общая ошибка	Произошла ошибка, для которой не было определенного SQLSTATE и для которого не было определено значение SQLSTATE для конкретной реализации. Сообщение об ошибке, возвращаемое SQLGetDiagRec в буфере *MessageText , описывает ошибку и ее причину.
HY001	Ошибка выделения памяти	Драйверу не удалось выделить память, необходимую для поддержки выполнения или завершения функции.
HY008	Операция отменена	Асинхронная обработка была включена для ОператораHandle. Функция была вызвана и до завершения выполнения, SQLCancel или SQLCancelHandle была вызвана на ОператорHandle. Затем функция снова была вызвана на ОператорHandle. Функция была вызвана и до завершения выполнения SQLCancel или SQLCancelHandle была вызвана оператором StatementHandle из другого потока в многопотоковом приложении.
HY009	Недопустимое использование указателя NULL	Для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, аргумент CatalogName был пустым указателем, а SQL_CATALOG_NAME InfoType возвращает поддерживаемые имена каталогов. (DM) Атрибут инструкции SQL_ATTR_METADATA_ID был задан как SQL_TRUE, а аргумент SchemaName или ProcName был пустым указателем.
HY010	Ошибка последовательности функций	(DM) Асинхронно выполняющаяся функция была вызвана для дескриптора соединения, связанного с ОператоромHandle. Эта асинхронная функция по-прежнему выполнялась при вызове этой функции. (DM) SQLExecute, SQLExecDirect или SQLMoreResults был вызван для ОператораHandle и возвращен SQL_PARAM_DATA_AVAILABLE. Эта функция была вызвана до получения данных для всех потоковых параметров. (DM) асинхронно выполняющаяся функция (не эта) была вызвана для StatementHandle и по-прежнему выполнялась при вызове этой функции. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations или SQLSetPos были вызваны для ОператораHandle и возвращены SQL_NEED_DATA. Эта функция была вызвана до отправки данных для всех параметров выполнения или столбцов.
HY013	Ошибка управления памятью	Не удалось обработать вызов функции, так как к базовым объектам памяти не удалось получить доступ, возможно, из-за низкой памяти.
HY090	Недопустимая длина строки или буфера	(DM) Значение одного из аргументов длины имени было меньше 0, но не равно SQL_NTS. Значение одного из аргументов длины имени превысило максимальное значение длины соответствующего имени.
HY117	Подключение приостановлено из-за неизвестного состояния транзакции. Разрешены только функции отключения и только для чтения.	(DM) Дополнительные сведения о приостановленном состоянии см. в статье SQLEndTran Function.
HYC00	Необязательный компонент не реализован	Был указан каталог процедур, а драйвер или источник данных не поддерживает каталоги. Указана схема процедуры, а драйвер или источник данных не поддерживает схемы. Шаблон поиска строк был указан для схемы процедуры или имени процедуры, и источник данных не поддерживает шаблоны поиска для одного или нескольких этих аргументов. Сочетание текущих параметров SQL_ATTR_CONCURRENCY и атрибутов инструкции SQL_ATTR_CURSOR_TYPE не поддерживается драйвером или источником данных. Для атрибута инструкции SQL_ATTR_USE_BOOKMARKS задано значение SQL_UB_VARIABLE, а для атрибута инструкции SQL_ATTR_CURSOR_TYPE задан тип курсора, для которого драйвер не поддерживает закладки.
HYT00	Время ожидания истекло.	Срок ожидания запроса истек до того, как источник данных вернул запрошенный результирующий набор. Период времени ожидания задается через SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT.
HYT01	Время ожидания для подключения истекло	Срок ожидания подключения истек до того, как источник данных ответил на запрос. Период времени ожидания подключения задается через SQLSetConnectAttr SQL_ATTR_CONNECTION_TIMEOUT.
IM001	Драйвер не поддерживает эту функцию	(DM) Драйвер, связанный с ОператорHandle , не поддерживает эту функцию.
IM017	Опрос отключен в асинхронном режиме уведомлений	При использовании модели уведомлений опрос отключается.
IM018	SQLCompleteAsync не был вызван для выполнения предыдущей асинхронной операции с этим дескриптором.	Если предыдущий вызов функции дескриптора возвращает SQL_STILL_EXECUTING и если включен режим уведомлений, sqlCompleteAsync должен вызываться на дескрипторе для выполнения последующей обработки и завершения операции.

Комментарии

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

Заметка

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

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

Заметка

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

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

Столбец ODBC 2.0	Столбец ODBC 3*.x*
PROCEDURE_QUALIFIER	PROCEDURE_CAT
ПРОЦЕДУРА _OWNER	ПРОЦЕДУРА _SCHEM

Чтобы определить фактическую длину столбцов 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) можно определить драйвером. Приложение должно получить доступ к столбцам для конкретного драйвера, отсчитывая от конца результирующего набора, а не указывая явное порядковое положение. Дополнительные сведения см. в разделе "Данные, возвращаемые функциями каталога".

Столбец	Номер столбца	Тип данных	Комментарии
PROCEDURE_CAT (ODBC 2.0)	1	Varchar	Идентификатор каталога процедур; ЗНАЧЕНИЕ NULL, если применимо к источнику данных. Если драйвер поддерживает каталоги для некоторых процедур, но не для других, например, когда драйвер извлекает данные из разных СУБД, он возвращает пустую строку ("") для тех процедур, которые не имеют каталогов.
PROCEDURE_SCHEM (ODBC 2.0)	2	Varchar	Идентификатор схемы процедуры; ЗНАЧЕНИЕ NULL, если применимо к источнику данных. Если драйвер поддерживает схемы для некоторых процедур, но не для других, например, когда драйвер извлекает данные из разных СУБД, он возвращает пустую строку ("") для тех процедур, которые не имеют схем.
PROCEDURE_NAME (ODBC 2.0)	3	Varchar не NULL	Идентификатор процедуры.
NUM_INPUT_PARAMS (ODBC 2.0)	4	Неприменимо	Зарезервировано для последующего использования. Приложения не должны полагаться на данные, возвращаемые в этих столбцах результатов.
NUM_OUTPUT_PARAMS (ODBC 2.0)	5	Неприменимо	Зарезервировано для последующего использования. Приложения не должны полагаться на данные, возвращаемые в этих столбцах результатов.
NUM_RESULT_SETS (ODBC 2.0)	6	Неприменимо	Зарезервировано для последующего использования. Приложения не должны полагаться на данные, возвращаемые в этих столбцах результатов.
ПРИМЕЧАНИЯ (ODBC 2.0)	7	Varchar	Описание процедуры.
PROCEDURE_TYPE (ODBC 2.0)	8	Smallint	Определяет тип процедуры: SQL_PT_UNKNOWN: невозможно определить, возвращает ли процедура значение. SQL_PT_PROCEDURE: возвращенный объект является процедурой; то есть у него нет возвращаемого значения. SQL_PT_FUNCTION: возвращенный объект является функцией; то есть имеет возвращаемое значение.

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

Пример кода

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

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

Сведения	Раздел
Привязка буфера к столбцу в результирующем наборе	Функция SQLBindCol
Отмена обработки инструкций	Функция SQLCancel
Получение одной строки или блока данных в направлении только для пересылки	Функция SQLFetch
Получение блока данных или прокрутка результирующий набор	Функция SQLFetchScroll
Возврат сведений о драйвере или источнике данных	Функция SQLGetInfo
Возврат параметров и столбцов результирующего набора процедуры	Функция SQLProcedureColumns
Синтаксис для вызова хранимых процедур	Выполнение инструкций

См. также

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