sp_OAGetProperty (języka Transact-SQL)
Pobiera wartość właściwość obiektu.
sp_OAGetProperty objecttoken , propertyname
[ , propertyvalue OUTPUT ]
[ , index...]
Argumenty
objecttoken
Jest tokenem obiektu z obiekt 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ślono, musi być zmienna lokalna o odpowiedni typ danych.Jeśli właściwość ta zwraca obiekt OLE propertyvalue musi być zmiennej lokalnej typu danych int. Token obiektu jest przechowywana w zmiennej lokalnej, a token ten obiekt może być używany z innymi automatyzacji OLE przechowywanych procedur.
Jeśli właściwość ta zwraca jedną wartość, albo określić zmienna lokalna dla propertyvalue, z którego zwracana właściwość wartość w zmiennej lokalnej; lub nie zostanie określony propertyvalue, która zwraca wartość właściwości do klient jako zestaw wyników jednokolumnową, pojedynczy wiersz.
Gdy właściwość ta zwraca tablicę, jeśli propertyvalue jest określony, jest on zestaw wartości null.
Jeśli propertyvalue jest określony, ale właściwość nie zwraca wartość, wystąpi błąd. Jeśli właściwość ta zwraca tablicę z więcej niż dwa wymiary, wystąpi błąd.
index
Jest parametrem indeksu.Jeśli określono, indexmusi być wartością typu danych.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.
Uwaga
Parametry dla tej procedura przechowywana są określane przez pozycji nie nazwę.
Wartości kodów powrotnych
0 (sukces) lub liczbę różną od zera (błąd), która jest liczbą całkowitą wartość HRESULT, zwrócone przez obiekt automatyzacji OLE.
Aby uzyskać więcej informacji na temat Kody zwracanych wartości HRESULT zobacz OLE Automation Return Codes and Error Information.
Zestawy wyników
Jeśli właściwość ta zwraca tablicę z jednego lub dwóch wymiarów, tablicy jest zwracany do klient jako zestaw wyników:
Jednowymiarowa tablica jest zwracane do klient, zestaw wyników pojedynczy wiersz z elementów w tablicy są jako istnieje wiele kolumn.Innymi słowy zwracana jest tablica jako kolumny.
Dwuwymiarowej tablicy jest zwracany do klient jako zestaw wyników ze wszystkich kolumn, w pierwszym wymiarze tablicy a o tyle wierszy, drugi wymiar tablicy nie ma elementów nie ma elementów.Innymi słowy tablicy są zwracane jako (kolumn, wierszy).
Gdy wartość zwrócona przez właściwość lub metoda zwraca wartość ma postać tablicy, sp_OAGetProperty or sp_OAMethod zwraca zestaw wyników do klient.(Parametry wyjściowe metoda nie może być tablicami.) Procedury te skanowanie wszystkich wartości danych w tablicy w celu określenia odpowiednich SQL Server Ustaw typy danych i długość danych dla każdej kolumna, w wyniku. Dla określonej kolumna te procedury za pomocą typu danych i długość wymaganego do reprezentowania wszystkich wartości danych w tej kolumnie.
W przypadku wszystkich wartości danych kolumna mają ten sam typ danych, do całą kolumna używany jest ten typ danych.Gdy wartości danych kolumna są różnych typów danych, typ danych kolumna, cały wybierany jest oparte na poniższym wykresie.
|
int |
zmiennoprzecinkowe |
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 |
Remarks
Można również użyć sp_OAMethod , aby uzyskać wartość właściwość.
Uprawnienia
Członkostwo w grupie wymaga 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 obiektu) 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.Korzystanie z zestaw wyników
Poniższy przykład pobiera HostName Właściwość (z utworzonego wcześniej SQLServer obiektu) i zwraca ją do klient w rezultacie ustawiony.
EXEC @hr = sp_OAGetProperty @object, 'HostName'
IF @hr <> 0
BEGIN
EXEC sp_OAGetErrorInfo @object
RETURN
END
See Also