Функция SQLColumnPrivileges

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

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

Syntax

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

Arguments

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

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

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

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

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

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

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

TableName
[Входные данные] Имя таблицы. Этот аргумент не может быть нулевым указателем. TableName не может содержать шаблон поиска по строкам.

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

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

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

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

НазваниеДлина4
[Ввод] Длина в символах *ColumnName.

Returns

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

Diagnostics

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

Comments

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

Длина столбцов VARCHAR не показана в таблице; Фактическая длина зависит от источника данных. Для определения фактической длины столбцов CATALOG_NAME, SCHEMA_NAME, TABLE_NAME и COLUMN_NAME приложение может вызвать SQLGetInfo с помощью опций SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LEN и SQL_MAX_COLUMN_NAME_LEN.

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

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

Пример кода

Пример кода аналогичной функции см. в статье SQLColumns Function.

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

См. также

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