Поделиться через

sp_OAGetProperty (Transact-SQL)

  • Статья

Область применения: SQL Server

Получает значение свойства объекта OLE.

Соглашения о синтаксисе Transact-SQL

Синтаксис

sp_OAGetProperty objecttoken , propertyname
    [ , propertyvalue OUTPUT ]
    [ , index... ]
[ ; ]

Аргументы

objecttoken

Маркер объекта OLE, который ранее был создан с помощью sp_OACreate.

propertyname

Имя свойства возвращаемого объекта OLE.

propertyvalue OUTPUT

Возвращаемое значение свойства. Если значение указано, оно должно быть локальной переменной соответствующего типа данных.

Если свойство возвращает объект OLE, свойство должно быть локальной переменной типа данных int. Маркер объекта хранится в локальной переменной, и этот маркер объекта можно использовать с другими хранимыми процедурами OLE Automation.

Если свойство возвращает одно значение, либо:

  • укажите локальную переменную для propertyvalue, которая возвращает значение свойства в локальной переменной; или
  • Не указывайте значение свойства, которое возвращает значение свойства клиенту в виде одного столбца, результирующий набор с одной строкой.

Если свойство возвращает массив, если задано значение свойства, оно имеет значение NULL.

Если задано значение свойства, но свойство не возвращает значение, возникает ошибка. Если свойство возвращает массив более двух измерений, то возникает ошибка.

index

Параметр индекса. Если задано, индекс должен быть значением соответствующего типа данных.

Некоторые свойства имеют параметры. Эти свойства называются индексированными свойствами, а параметры — индексными параметрами. Свойство может иметь несколько индексных параметров.

Примечание.

Параметры для этой хранимой процедуры задаются по положению, а не по имени.

Значения кода возврата

0 (успешно) или ненулевое число (сбой), которое является целым значением HRESULT, возвращаемым объектом OLE Automation.

Дополнительные сведения о кодах возврата HRESULT см. в разделе "Коды возврата автоматизации OLE" и сведения об ошибках.

Результирующий набор

Если свойство возвращает массив с одним или двумя измерениями, то массив возвращается клиенту как результирующий набор.

  • Одномерный массив возвращается клиенту как результирующий набор, состоящий из одной строки, в которой число столбцов соответствует количеству элементов массива. Иными словами, массив возвращается в виде набора столбцов.

  • Двумерный массив возвращается клиенту в виде результирующего набора с числом столбцов, равным числу элементов первого измерения массива, и числом строк, равным числу элементов второго измерения массива. Иными словами, массив возвращается в виде (столбцы, строки).

Если возвращаемое значение свойства или метода является массивом, процедура sp_OAGetProperty или sp_OAMethod возвращает клиенту результирующий набор. (Выходные параметры метода не могут быть массивами.) Эти процедуры сканируют все значения данных в массиве, чтобы определить соответствующие типы данных и длины данных SQL Server, используемые для каждого столбца в результирующем наборе. Для каждого отдельного столбца эти процедуры используют тип и длину данных, необходимые для представления всех значений данных этого столбца.

Если все значения данных в столбце имеют один и тот же тип данных, этот тип используется для всего столбца. Если значения данных в столбце имеют различные типы данных, тип данных всего столбца определяется по следующей схеме.

INT с плавающей запятой money datetime varchar nvarchar
int int float money varchar varchar nvarchar
float float float money varchar varchar nvarchar
money money money money varchar varchar nvarchar
datetime varchar varchar varchar datetime varchar nvarchar
varchar varchar varchar varchar varchar varchar nvarchar
nvarchar nvarchar nvarchar nvarchar nvarchar nvarchar nvarchar

Замечания

Можно также использовать sp_OAMethod для получения значения свойства.

Разрешения

Требуется членство в предопределенных ролях сервера sysadmin или разрешение на выполнение непосредственно в этой хранимой процедуре. Параметр конфигурации сервера Ole Automation Procedures должен быть включен для использования любой системной процедуры, связанной с OLE Automation.

Примеры

А. Использование локальной переменной

Следующий пример получает HostName свойство (ранее созданного SQLServer объекта) и сохраняет его в локальной переменной.

DECLARE @property VARCHAR(255);

EXEC @hr = sp_OAGetProperty @object,
    'HostName',
    @property OUTPUT;

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END

PRINT @property;

B. Использование результирующих наборов

В следующем примере возвращается HostName свойство (ранее созданного SQLServer объекта) и возвращается клиенту в результирующий набор.

EXEC @hr = sp_OAGetProperty @object,
    'HostName';

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;

Связанный контент