Функция SQLTablePrivileges

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

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

Syntax

  
SQLRETURN SQLTablePrivileges(  
     SQLHSTMT      StatementHandle,  
     SQLCHAR *     CatalogName,  
     SQLSMALLINT   NameLength1,  
     SQLCHAR *     SchemaName,  
     SQLSMALLINT   NameLength2,  
     SQLCHAR *     TableName,  
     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.

TableName
[Ввод] Шаблон поиска по строкам для названий таблиц.

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

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

Returns

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

Diagnostics

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

Comments

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

SQLTablePrivileges возвращает результаты в виде стандартного набора результатов, упорядоченных по TABLE_CAT, TABLE_SCHEM, TABLE_NAME, PRIVILEGE и GRANTEE.

Для определения фактической длины столбцов TABLE_CAT, TABLE_SCHEM и TABLE_NAME приложение может вызвать SQLGetInfo с помощью опций SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN и SQL_MAX_TABLE_NAME_LEN.

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

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

Пример кода

Для примера кода аналогичной функции см. SQLColumns.

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

См. также

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