sp_OAMethod (Transact-SQL)

  • Artikel

Gilt für: SQL Server

Ruft eine Methode eines OLE-Objekts auf.

Transact-SQL-Syntaxkonventionen

Syntax

sp_OAMethod objecttoken , methodname
    [ , returnvalue OUTPUT ]
    [ , [ @parametername = ] parameter [ OUTPUT ] [ ...n ] ]
[ ; ]

Argumente

objecttoken

Das Objekttoken eines OLE-Objekts, das zuvor mithilfe sp_OACreatevon .

methodname

Der Methodenname des ole-Objekts, das aufgerufen werden soll.

Returnvalue OUTPUT

Der Rückgabewert der Methode des OLE-Objekts. Wenn angegeben, muss es sich um eine lokale Variable vom entsprechenden Datentyp handeln.

Wenn die Methode einen einzelnen Wert zurückgibt, führen Sie eine der folgenden Aktionen aus:

  • geben Sie eine lokale Variable für den Rückgabewert an, die den Rückgabewert der Methode in der lokalen Variablen zurückgibt; oder
  • geben Sie keinen Rückgabewert an, der den Rückgabewert der Methode als einspaltiges Resultset zurückgibt.

Wenn der Rückgabewert der Methode ein OLE-Objekt ist, muss der Rückgabewert eine lokale Variable des Datentyps "int" sein. Ein Objekttoken wird in der lokalen Variablen gespeichert, und dieses Objekttoken kann mit anderen gespeicherten OLE-Automatisierungsprozeduren verwendet werden.

Wenn der Rückgabewert der Methode ein Array ist, wenn der Rückgabewert angegeben wird, wird er auf NULL.

Unter folgenden Bedingungen wird ein Fehler ausgegeben:

  • "returnvalue" wird angegeben, aber die Methode gibt keinen Wert zurück.
  • Die Methode gibt ein Array mit mehr als zwei Dimensionen zurück.
  • Die Methode gibt ein Array als Ausgabeparameter zurück.

[ = ] Parameter [ @parametername OUTPUT ]

Ein Methodenparameter. Wenn angegeben, muss der Parameter ein Wert des entsprechenden Datentyps sein.

Um den Rückgabewert eines Ausgabeparameters abzurufen, muss der Parameter eine lokale Variable des entsprechenden Datentyps sein und OUTPUT muss angegeben werden. Wenn ein Konstantenparameter angegeben oder nicht angegeben OUTPUT wird, wird ein Rückgabewert eines Ausgabeparameters ignoriert.

Wenn angegeben, muss der Parametername der Name des benannten Parameters von Microsoft Visual Basic sein. @parametername keine lokale Transact-SQL-Variable ist. Das At-Zeichen (@) wird entfernt, und der Parametername wird als Parametername an das OLE-Objekt übergeben. Alle benannten Parameter müssen nach den Positionsparametern angegeben werden.

n

Ein Platzhalter, der angibt, dass mehrere Parameter angegeben werden können.

Hinweis

@parametername kann ein benannter Parameter sein, da er Teil der angegebenen Methode ist und an das Objekt übergeben wird. Die anderen Parameter für diese gespeicherte Prozedur werden nicht nach dem Namen, sondern nach der Position angegeben.

Rückgabecodewerte

0 (Erfolg) oder eine Nichtzeronummer (Fehler), die den ganzzahligen Wert des vom OLE-Automatisierungsobjekt zurückgegebenen HRESULT-Werts darstellt.

Weitere Informationen zu HRESULT-Rückgabecodes, OLE-Automatisierungsrücklaufcodes und Fehlerinformationen.

Resultset

Wenn die Methode ein Array mit ein oder zwei Dimensionen zurückgibt, wird das Array dem Client folgendermaßen als Resultset zurückgegeben:

  • Ein eindimensionales Array wird dem Client als einzeiliges Resultset zurückgegeben, das so viele Spalten wie Elemente im Array enthält. Das Array wird also als (Spalten) zurückgegeben.

  • Ein zweidimensionales Array wird dem Client als Resultset zurückgegeben, dessen Anzahl an Spalten der Anzahl der Elemente in der ersten Dimension des Arrays entspricht und dessen Anzahl an Zeilen der Anzahl der Elemente in der zweiten Dimension des Arrays entspricht. Das Array wird also als (Spalten, Zeilen) zurückgegeben.

Wenn der Rückgabewert für eine Eigenschaft oder eine Methode ein Array ist, gibt sp_OAGetProperty oder sp_OAMethod ein Resultset an den Client zurück. (Methodenausgabeparameter können keine Arrays sein.) Diese Verfahren scannen alle Datenwerte im Array, um die entsprechenden SQL Server-Datentypen und Datenlängen zu bestimmen, die für jede Spalte im Resultset verwendet werden sollen. Für eine bestimmte Spalte verwenden diese Prozeduren den Datentyp und die -länge, die erforderlich sind, um alle Datenwerte in dieser Spalte darzustellen.

Wenn alle Datenwerte einer Spalte denselben Datentyp aufweisen, wird dieser Datentyp für die gesamte Spalte verwendet. Wenn Datenwerte in einer Spalte unterschiedliche Datentypen verwenden, wird der Datentyp für die gesamte Spalte entsprechend der folgenden Tabelle ausgewählt.

INT float 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

Hinweise

Sie können auch einen sp_OAMethod Eigenschaftswert abrufen.

Berechtigungen

Erfordert die Mitgliedschaft in der festen Serverrolle "sysadmin ", oder führen Sie die Berechtigung direkt für diese gespeicherte Prozedur aus. Die Serverkonfigurationsoption "Ole Automation Procedures " muss aktiviert sein, um alle Systemprozeduren im Zusammenhang mit der OLE-Automatisierung zu verwenden.

Beispiele

A. Aufrufen einer Methode

Im folgenden Beispiel wird die Connect Methode des zuvor erstellten SQLServer-Objekts aufgerufen.

EXEC @hr = sp_OAMethod @object,
    'Connect',
    NULL,
    'my_server',
    'my_login',
    'my_password';

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;

B. Abrufen einer Eigenschaft

Im folgenden Beispiel wird die HostName Eigenschaft (des zuvor erstellten Objekts) und SQLServer in einer lokalen Variablen gespeichert.

DECLARE @property VARCHAR(255);

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

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;

PRINT @property;

Zugehöriger Inhalt