sp_OAGetProperty (języka Transact-SQL)

Pobiera wartość właściwość obiektu OLE.

Języka Transact-SQL składni konwencje

Składnia

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

Argumenty

• objecttoken
  Jest tokenem obiektu obiektu OLE, który został wcześniej utworzony przy użyciu sp_OACreate.

• propertyname
  Jest nazwą właściwość obiektu OLE, aby powrócić.

• propertyvalueDANE WYJŚCIOWE
  Jest to wartość zwrócona właściwość .Jeśli określony, musi być zmienną lokalną odpowiedni typ danych.

  Jeśli właściwość zwraca obiekt OLE propertyvalue musi być lokalną zmienną typu danych int.Token obiektu jest przechowywana w zmiennej lokalnej, a token ten obiekt może być używana z innymi procedurami automatyzacji OLE przechowywane.

  Jeśli właściwość zwraca jedną wartość, albo określić zmiennej lokalnej propertyvalue, która zwraca wartość właściwość w zmiennej lokalnej; lub nie określaj propertyvalue, która zwraca wartość właściwość do klient jako jedno -kolumna, pojedynczego wiersza, zestaw wyników.

  Gdy właściwość zwraca tablicę, jeśli propertyvalue jest określony, jest zestaw na NULL.

  Jeśli propertyvalue jest określony, ale właściwość nie zwraca wartości, wystąpi błąd.właściwość zwraca tablicę z więcej niż dwóch wymiarach, wystąpi błąd.

• index
  Jest parametrem index.Jeśli określony, indexmusi być wartością typu odpowiednie dane.

  Niektóre właściwości mają parametrów.Właściwości te są nazywane właściwości indeksowanych i parametry są określane jako parametry indeksu.właściwość może mieć wiele parametrów indeksu.

  Ostrzeżenie

  Parametry dla tej procedura składowana są określane przez położenie nie nazwę.

Wartości kodów powrotnych

0 (sukces) lub liczbę różną od zera (błąd), która jest wartością całkowitą wartość HRESULT zwrócone przez obiekt automatyzacji OLE.

Aby uzyskać więcej informacji na temat kody powrotne HRESULT zobacz OLE automatyzacji kody zwrotne i informacje o błędzie.

Zestawy wyników

Jeśli właściwość zwraca tablicę z jednego lub dwóch wymiarów, tablica jest zwracana do klient jako zestaw wyników:

• Jednowymiarowa tablica jest zwracana do klient jako pojedynczy wiersz zestaw wyników tyle kolumn w tablicy nie ma elementów.Innymi słowy tablica jest zwracana jako kolumny.

• Dwuwymiarowa tablica jest zwracana do klient jako zestaw wyników tam wiele kolumn są elementy w pierwszym wymiar tablicy i o tyle wierszy, jak elementy drugi wymiar tablicy.Innymi słowy tablicy są zwracane jako (kolumny, wiersze).

Gdy wartość zwrócona przez właściwość lub metoda zwraca wartość jest tablicą, sp_OAGetProperty lub sp_OAMethod zwraca zestaw wyników do klient.(Parametry wyjściowe metody nie może być tablicami). Procedury te skanowanie wszystkich wartości danych w celu określenia odpowiednich SQL Server typów danych i długości danych należy użyć dla każdej kolumna w zestaw wyników.Dla określonej kolumnatych procedur należy użyć typu danych i długość zobowiązany do reprezentowania wszystkich wartości danych w tej kolumna.

Podczas wszystkich wartości danych w kolumna mają ten sam typ danych, ten typ danych jest używany dla całej kolumna.Gdy wartości danych w kolumna są różnych typów danych, typ danych w całej kolumna wybierany jest oparte na poniższym wykresie.

	int	Pływak	pieniądze	data_i_godzina	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

Uwagi

Można również użyć sp_OAMethod uzyskać wartość właściwość .

Uprawnienia

Wymaga członkostwa w sysadmin stała rola serwera.

Przykłady

A.Za pomocą zmiennej lokalnej

Poniższy przykład pobiera HostName właściwość (z utworzonego wcześniej SQLServer object) i zapisuje ją w zmiennej lokalnej.

DECLARE @property varchar(255)
EXEC @hr = sp_OAGetProperty @object, 'HostName', @property OUT
IF @hr <> 0
BEGIN
   EXEC sp_OAGetErrorInfo @object
    RETURN
END
PRINT @property

B.Za pomocą zestaw wyników

Poniższy przykład pobiera HostName właściwość (z utworzonego wcześniej SQLServer object) i zwraca do klient jako zestaw wyników.

EXEC @hr = sp_OAGetProperty @object, 'HostName'
IF @hr <> 0
BEGIN
   EXEC sp_OAGetErrorInfo @object
    RETURN
END

Zobacz także

Odwołanie

OLE automatyzacji procedur przechowywanych języka Transact-SQL)

Przykładowy skrypt automatyzacji OLE