通过

sp_OAMethod (Transact-SQL)

  • 项目

适用范围：SQL Server

调用一个 OLE 对象的方法。

Transact-SQL 语法约定

语法

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

参数

objecttoken

以前使用 sp_OACreate 创建的 OLE 对象的对象标记。

methodname

要调用的 OLE 对象的方法名称。

returnvalue OUTPUT

OLE 对象的方法的返回值。 如果指定此参数，则必须是相应数据类型的局部变量。

如果方法返回单个值，则为以下任一值：

  • 指定 returnvalue 的局部变量，该值返回局部变量中的方法返回值;或
  • 不要指定 returnvalue，它将方法返回值作为单列单行结果集返回给客户端。

如果方法返回值为 OLE 对象，则 returnvalue 必须是数据类型 int 的局部变量。对象令牌存储在本地变量中，此对象令牌可用于其他 OLE 自动化存储过程。

当方法返回值是数组时，如果 指定了 returnvalue ，则将其设置为 NULL。

如果出现下列任意一种情况，则产生错误：

  • 指定 returnvalue ，但该方法不返回值。
  • 方法返回二维以上的数组。
  • 方法返回一个数组作为输出参数。

[ @parametername = ] 参数 [ OUTPUT ]

方法参数。 如果指定， 参数 必须是相应数据类型的值。

若要获取输出参数的返回值， 参数 必须是相应数据类型的局部变量，并且 OUTPUT 必须指定。 如果指定了常量参数，或者 OUTPUT 如果未指定，则忽略输出参数中的任何返回值。

如果指定， 参数名 必须是 Microsoft Visual Basic 命名参数的名称。 @parametername不是 Transact-SQL 局部变量。 删除 at sign （@） 并将 parametername 作为参数名称传递给 OLE 对象。 指定了所有位置参数后，才能指定命名参数。

n

一个占位符，指示可以指定多个参数。

注意

@parametername可以是命名参数，因为它是指定方法的一部分，并传递给对象。 此存储过程的其他参数是按位置（而不是名称）指定的。

返回代码值

0 （success） 或非零数 （failure） 是 OLE 自动化对象返回的 HRESULT 的整数值。

有关 HRESULT 返回代码、 OLE 自动化返回代码和错误信息的详细信息。

结果集

如果方法返回值是一维或二维数组，那么该数组将作为结果集返回给客户端：

  • 一维数组作为单行结果集返回给客户端，其中的列数与数组中的元素数相等。 换言之，该数组以（列）的形式返回。

  • 二维数组作为结果集返回给客户端，其中的列数与数组第一维中的元素数相同，行数与数组第二维中的元素数相同。 换言之，该数组以（列、行）的形式返回。

当属性返回值或方法返回值是数组时，sp_OAGetProperty 或 sp_OAMethod 将向客户端返回结果集。 （方法输出参数不能是数组。这些过程扫描数组中的所有数据值，以确定要用于结果集中每个列的相应 SQL Server 数据类型和数据长度。 对于某个特定的列，这些过程将使用显示该列中的所有数据值所需要的数据类型和长度。

如果一列中的所有数据值具有相同的数据类型，此数据类型将用于整个列。 当列中的数据值为其他数据类型时，将基于下表选择整个列的数据类型。

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

注解

还可以用于 sp_OAMethod 获取属性值。

权限

需要 sysadmin 固定服务器角色的成员身份或直接在此存储过程上执行权限。 必须启用 Ole Automation Procedures 服务器配置选项，才能使用与 OLE 自动化相关的任何系统过程。

示例

A. 调用方法

以下示例调用 Connect 以前创建的 SQLServer 对象的方法。

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

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;

B. 获取属性

以下示例获取 HostName 属性（以前创建 SQLServer 的对象），并将其存储在局部变量中。

DECLARE @property VARCHAR(255);

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

IF @hr <> 0
BEGIN
    EXEC sp_OAGetErrorInfo @object

    RETURN
END;

PRINT @property;

相关内容